|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SourceDocComment
A SourceDocComment
represents a documentation comment ("doc comment") associated with a class, interface, constructor, method, or field. Doc comments are also known informally as "Javadoc comments" (but this term violates its trademark usage). A doc comment has a main description, which is the text preceding the first block tag, and zero or more block tags. Both the main description and the descriptions contained by most block tags may contain inline tags.
The children of a doc comment are the following:
SourceDocDescription
for the main description, if any;SourceDocBlockTag
.SourceDocDescription
, SourceDocTag
, SourceDocBlockTag
, SourceDocInlineTag
Field Summary |
---|
Fields inherited from interface oracle.javatools.parser.java.v2.model.SourceElement |
---|
CHILDREN_ALL, CHILDREN_BLANKLINES, CHILDREN_COMMENTS, CHILDREN_default, CHILDREN_none, CHILDREN_REGULAR, EMPTY_ARRAY, PRINT_ALL, REFORMAT_ALL, REFORMAT_INDENT |
Method Summary | |
---|---|
SourceDocBlockTag |
findExceptionTag(java.lang.String exceptionName) Finds the first @exception or @throws tag in this doc comment with a specified fully-qualified name. |
java.util.Collection |
findExceptionTags() Finds the @exception or @throws tags in this doc comment. |
SourceDocBlockTag |
findParameterTag(java.lang.String parameterName) Finds the first @param tag in this doc comment with a specified name. |
java.util.Collection |
findReferenceTags() Finds the @link , @linkplain , @see , and three-element @value tags in this doc comment. |
java.util.Collection |
findReferenceTags(java.lang.String referenceText) Finds the @link , @linkplain , @see , and three-element @value tags in this doc comment with a specified normalized reference text . |
java.util.Collection |
findTags(java.lang.String name) Finds the tags in this doc comment with a specified name, or an empty list if none. |
java.util.List |
getBlockTags() Gets the block tags from this doc comment. |
SourceDocDescription |
getDescription() Gets the main description, the text before the first block tag, from this doc comment. |
Methods inherited from interface oracle.javatools.parser.java.v2.model.doc.SourceDocHasDescription |
---|
setDescription |
Methods inherited from interface oracle.javatools.parser.java.v2.model.doc.SourceDocElement |
---|
getDocText, getInlineTags, getOwningDocComment, getOwningMember, getReferences, isBlank |
Methods inherited from interface oracle.javatools.parser.java.v2.model.SourceElement |
---|
addSelf, addSelf, addSelfAfter, addSelfBefore, clearBinding, cloneSelf, compile, getBinding, getChildren, getChildren, getCompiledObject, getContainedElements, getEndOffset, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf |
Method Detail |
---|
SourceDocDescription getDescription()
getDescription
in interface SourceDocHasDescription
java.util.List getBlockTags()
SourceDocBlockTag
s, one for each block tag in this doc comment, in document order.java.util.Collection findTags(java.lang.String name)
name
- the name of a tag to find. The tag name must include the leading "@" character.SourceDocTag
s containing the tags in this doc comment with the specified name.java.util.Collection findExceptionTags()
@exception
or @throws
tags in this doc comment.SourceDocBlockTag
s containing the @exception
or @throws
tags in this doc comment.SourceDocBlockTag findExceptionTag(java.lang.String exceptionName)
@exception
or @throws
tag in this doc comment with a specified fully-qualified name.@exception
or @throws
tag in this doc comment with a fully-qualified name of exceptionName
, or null if none.SourceDocBlockTag findParameterTag(java.lang.String parameterName)
@param
tag in this doc comment with a specified name.@param
tag in this doc comment with a name of parameterName
, or null if none.java.util.Collection findReferenceTags()
@link
, @linkplain
, @see
, and three-element @value
tags in this doc comment.SourceDocTag
s containing the @link, @linkplain, @see, and three-element @value tags in this doc comment.java.util.Collection findReferenceTags(java.lang.String referenceText)
@link
, @linkplain
, @see
, and three-element @value
tags in this doc comment with a specified normalized reference text
.referenceText
- The normalized reference text to match.SourceDocTag
s containing the @link
, @linkplain
, @see
, or three-element @value
tags in this doc comment with a normalized reference text equal to referenceText
.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |