|
JavaScript Development Tools Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.wst.jsdt.ui.JSdocContentAccess
public class JSdocContentAccess
Helper needed to get the content of a Javadoc comment.
This class is not intended to be subclassed or instantiated by clients.
Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
Field Summary | |
---|---|
protected static String |
ATTR_DOCUMENTATIONPROVIDER_CLASS
|
static String |
EXTENSION_POINT
|
protected static String |
TAG_DOCUMENTATIONPROVIDER
|
Method Summary | |
---|---|
static Reader |
getContentReader(ILocalVariable declaration,
boolean allowInherited)
Gets a reader for an ILocalDeclaration's doc comment content from the source attachment. |
static Reader |
getContentReader(IMember member,
boolean allowInherited)
Gets a reader for an IMember's Javadoc comment content from the source attachment. |
static Reader |
getHTMLContentReader(ILocalVariable variable,
boolean allowInherited,
boolean useAttachedDoc)
Gets a reader for an ILocalDeclaration documentation comment content. |
static Reader |
getHTMLContentReader(IMember member,
boolean allowInherited,
boolean useAttachedJavadoc)
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 |
Field Detail |
---|
public static final String EXTENSION_POINT
protected static final String TAG_DOCUMENTATIONPROVIDER
protected static final String ATTR_DOCUMENTATIONPROVIDER_CLASS
Method Detail |
---|
public static Reader getContentReader(IMember member, boolean allowInherited) throws JavaScriptModelException
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
JavaScriptModelException
- is thrown when the elements javadoc can not be accessedpublic static Reader getHTMLContentReader(IMember member, boolean allowInherited, boolean useAttachedJavadoc) throws JavaScriptModelException
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 source
null
if the member
does not contain a Javadoc comment or if no source is available
JavaScriptModelException
- is thrown when the elements Javadoc can not be accessedpublic static Reader getHTMLContentReader(ILocalVariable variable, boolean allowInherited, boolean useAttachedDoc) throws JavaScriptModelException
null
if the declaration does not contain a doc comment or if no source is available.
variable
- the variable declaration to get the doc of.allowInherited
- for methods with no (JSDoc) comment, the comment of the overridden
class is returned if allowInherited
is true
useAttachedDoc
- if true
JSDoc will be extracted from attached JSDoc
if there's no source
null
if the member
does not contain a JSDoc comment or if no source is available
JavaScriptModelException
- is thrown when the elements JSDoc can not be accessedpublic static Reader getContentReader(ILocalVariable declaration, boolean allowInherited) throws JavaScriptModelException
null
if the declaration does
not have a doc comment or if no source is available.
declaration
- The declaration to get the doc of.allowInherited
- For methods with no doc comment, the comment of the
overridden class is returned if allowInherited
is true
and this is an argument.
null
if the declaration does not contain a doc
comment or if no source is available
JavaScriptModelException
- is thrown when the declaration's doc can not be accessed
|
JavaScript Development Tools Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |