public interface SourceDocDescription extends SourceDocElement
SourceDocDescription
represents the main description
of a SourceDocComment
or the description of a SourceDocTag
.CHILDREN_ALL, CHILDREN_BLANKLINES, CHILDREN_COMMENTS, CHILDREN_default, CHILDREN_none, CHILDREN_REGULAR, EMPTY_ARRAY, PRINT_ALL, REFORMAT_ALL, REFORMAT_INDENT
Modifier and Type | Method and Description |
---|---|
java.util.Collection<SourceDocInlineTag> |
findReferenceTags()
Finds the @link, @linkplain, and three-element @value tags in
this description.
|
java.util.Collection<SourceDocInlineTag> |
findReferenceTags(java.lang.String referenceName)
Finds the
@link , @linkplain ,
@see , and three-element @value tags in
this description with a specified canonical reference name. |
java.util.Collection<SourceDocInlineTag> |
findTags(java.lang.String name)
Finds the in-line tags in this description with a specified tag name.
|
java.util.List<SourceElement> |
getChildren()
Gets the children of this description.
|
getDocText, getInlineTags, getOwningDocComment, getOwningMember, getReferences, isBlank
addSelf, addSelf, addSelfAfter, addSelfBefore, adjustTextIndentation, clearBinding, cloneSelf, compile, createContext, getBinding, getChildren, getCompiledObject, getContainedElements, getContext, getEndOffset, getFirstToken, getJdkVersion, getLastToken, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingAfter, getSiblingBefore, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, getTokens, getTokens, hasErrors, print, print, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf
java.util.List<SourceElement> getChildren()
getChildren
in interface SourceElement
SourceDocTextFragment
s and
SourceDocInlineTag
s containing the children of this
description, in document order.java.util.Collection<SourceDocInlineTag> findTags(java.lang.String name)
name
- the name of a tag to find. The tag name must include the
leading "@" character.SourceDocInlineTag
s
containing the tags in this description with the specified name.java.util.Collection<SourceDocInlineTag> findReferenceTags()
SourceDocInlineTag
s
containing the @link
, @linkplain
,
or three-element @value
tags in this description.java.util.Collection<SourceDocInlineTag> findReferenceTags(java.lang.String referenceName)
@link
, @linkplain
,
@see
, and three-element @value
tags in
this description with a specified canonical reference name.referenceName
- The canonical reference name to match.SourceDocInlineTag
s
containing the @link
, @linkplain
,
or three-element @value
tags in this description with
a canonical reference name equal to referenceName
.