public class JSdocContentAccess
extends java.lang.Object
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.Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
ATTR_DOCUMENTATIONPROVIDER_CLASS |
static java.lang.String |
EXTENSION_POINT |
protected static java.lang.String |
TAG_DOCUMENTATIONPROVIDER |
Modifier and Type | Method and Description |
---|---|
static java.io.Reader |
getContentReader(IJavaScriptElement element,
boolean allowInherited)
Gets the content reader for either an
IMember or ILocalVariable . |
static java.io.Reader |
getContentReader(ILocalVariable declaration,
boolean allowInherited)
Gets a reader for an ILocalDeclaration's doc comment content from the
source attachment.
|
static java.io.Reader |
getContentReader(IMember member,
boolean allowInherited)
Gets a reader for an IMember's Javadoc comment content from the source attachment.
|
static java.io.Reader |
getHTMLContentReader(IJavaScriptElement element,
boolean allowInherited,
boolean useAttachedJavadoc)
Gets the HTML content reader for either an
IMember or ILocalVariable . |
static java.io.Reader |
getHTMLContentReader(ILocalVariable variable,
boolean allowInherited,
boolean useAttachedDoc)
Gets a reader for an ILocalDeclaration documentation comment content.
|
static java.io.Reader |
getHTMLContentReader(IMember member,
boolean allowInherited,
boolean useAttachedJavadoc)
Gets a reader for an IMember's Javadoc comment content from the source attachment.
|
public static final java.lang.String EXTENSION_POINT
protected static final java.lang.String TAG_DOCUMENTATIONPROVIDER
protected static final java.lang.String ATTR_DOCUMENTATIONPROVIDER_CLASS
public static java.io.Reader getContentReader(IJavaScriptElement element, boolean allowInherited) throws JavaScriptModelException
Gets the content reader for either an IMember
or ILocalVariable
.
element
- IJavaScriptElement
to get the content reader forallowInherited
- For methods with no (Javadoc) comment, the comment of the overridden class
is returned if allowInherited
is true
.null
if the element
does not contain a Javadoc comment or if no source is availableJavaScriptModelException
- is thrown when the elements javadoc can not be accessedgetContentReader(ILocalVariable, boolean)
,
getContentReader(IMember, boolean)
public static java.io.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 availableJavaScriptModelException
- is thrown when the elements javadoc can not be accessedpublic static java.io.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 availableJavaScriptModelException
- is thrown when the declaration's doc can not be accessedpublic static java.io.Reader getHTMLContentReader(IJavaScriptElement element, boolean allowInherited, boolean useAttachedJavadoc) throws JavaScriptModelException
Gets the HTML content reader for either an IMember
or ILocalVariable
.
element
- IJavaScriptElement
to get the Javadoc ofallowInherited
- 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 element
does not contain a Javadoc comment or if no source is availableJavaScriptModelException
- is thrown when the elements Javadoc can not be accessedgetHTMLContentReader(ILocalVariable, boolean, boolean)
,
getHTMLContentReader(IMember, boolean, boolean)
public static java.io.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 sourcenull
if the member
does not contain a Javadoc comment or if no source is availableJavaScriptModelException
- is thrown when the elements Javadoc can not be accessedpublic static java.io.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 sourcenull
if the member
does not contain a JSDoc comment or if no source is availableJavaScriptModelException
- is thrown when the elements JSDoc can not be accessedCopyright (c) IBM Corp. and others 2000, 2010. All Rights Reserved.