|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.ui.JavadocContentAccess
Helper needed get the content of a Javadoc comment.
This class is not intended to be subclassed or instantiated by clients.
Method Summary | |
---|---|
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)
Gets a reader for an IMember's Javadoc comment content from the source attachment. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
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 available
JavaModelException
- is thrown when the elements javadoc can not be accessedpublic static Reader getHTMLContentReader(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 available
JavaModelException
- is thrown when the elements javadoc can not be accessed
|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |