public class JavadocContentAccess extends Object
This class is not intended to be subclassed or instantiated by clients.
Modifier and Type | Method and Description |
---|---|
static Reader |
getContentReader(IMember member,
boolean allowInherited)
Gets a reader for an IMember's Javadoc comment content from the source attachment.
|
static Reader |
getHTMLContentReader(IMember member,
boolean allowInherited)
Deprecated.
As of 3.2, replaced by
getHTMLContentReader(IMember, boolean, boolean) |
static Reader |
getHTMLContentReader(IMember member,
boolean allowInherited,
boolean useAttachedJavadoc)
Gets a reader for an IMember's Javadoc comment content from the source attachment.
|
public static Reader getContentReader(IMember member, boolean allowInherited) throws JavaModelException
null
if the member does not contain a Javadoc comment or if no source is available.member
- The member to get the Javadoc of.allowInherited
- For methods with no (Javadoc) comment, the comment of the overridden class
is returned if allowInherited
is true
.null
if the member
does not contain a Javadoc comment or if no source is availableJavaModelException
- is thrown when the elements javadoc can not be accessedpublic static Reader getHTMLContentReader(IMember member, boolean allowInherited, boolean useAttachedJavadoc) throws JavaModelException
null
if the member does not contain a Javadoc comment or if no source is available.member
- the member to get the Javadoc of.allowInherited
- for methods with no (Javadoc) comment, the comment of the overridden
class is returned if allowInherited
is true
useAttachedJavadoc
- if true
Javadoc will be extracted from attached Javadoc
if there's no sourcenull
if the member
does not contain a Javadoc comment or if no source is availableJavaModelException
- is thrown when the elements Javadoc can not be accessedpublic static Reader getHTMLContentReader(IMember member, boolean allowInherited) throws JavaModelException
getHTMLContentReader(IMember, boolean, boolean)
null
if the member does not contain a Javadoc comment or if no source is available.member
- The member to get the Javadoc of.allowInherited
- For methods with no (Javadoc) comment, the comment of the overridden class
is returned if allowInherited
is true
.null
if the member
does not contain a Javadoc comment or if no source is availableJavaModelException
- is thrown when the elements javadoc can not be accessed
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.