| java.lang.Object com.sun.tools.javadoc.TagImpl
All known Subclasses: com.sun.tools.javadoc.SeeTagImpl, com.sun.tools.javadoc.ThrowsTagImpl, com.sun.tools.javadoc.SerialFieldTagImpl, com.sun.tools.javadoc.ParamTagImpl,
TagImpl | class TagImpl implements Tag(Code) | | Represents a documentation tag, e.g. @since, @author, @version.
Given a tag (e.g. "@since 1.2"), holds tag name (e.g. "@since")
and tag text (e.g. "1.2"). TagImpls with structure or which require
special processing are handled by subclasses (ParamTagImpl, SeeTagImpl,
and ThrowsTagImpl
author: Robert Field author: Atul M Dambalkar author: Neal M Gafter See Also: SeeTagImpl See Also: ParamTagImpl See Also: ThrowsTagImpl See Also: Doc.tags |
Method Summary | |
String[] | divideAtWhite() for use by subclasses which have two part tag text. | DocEnv | docenv() | public Tag[] | firstSentenceTags() Return array of tags for the first sentence in the doc comment text. | public Doc | holder() Return the containing
Doc of this Tag element. | public Tag[] | inlineTags() For documentation comment with embedded @link tags, return the array of
TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s). | public String | kind() Return the kind of this tag. | public String | name() Return the name of this tag. | public SourcePosition | position() Return the doc item to which this tag is attached. | public String | text() Return the text of this tag, that is, portion beyond tag name. | public String | toString() convert this object to a string. |
divideAtWhite | String[] divideAtWhite()(Code) | | for use by subclasses which have two part tag text.
|
firstSentenceTags | public Tag[] firstSentenceTags()(Code) | | Return array of tags for the first sentence in the doc comment text.
|
holder | public Doc holder()(Code) | | Return the containing
Doc of this Tag element.
|
inlineTags | public Tag[] inlineTags()(Code) | | For documentation comment with embedded @link tags, return the array of
TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
Within a comment string "This is an example of inline tags for a
documentation comment
Doc
Doc commentlabel }",
where inside the inner braces, the first "Doc" carries exctly the same
syntax as a SeeTagImpl and the second "commentlabel" is label for the Html
Link, will return an array of TagImpl(s) with first element as TagImpl with
comment text "This is an example of inline tags for a documentation
comment" and second element as SeeTagImpl with referenced class as "Doc"
and the label for the Html Link as "commentlabel".
TagImpl[] Array of tags with inline SeeTagImpls. See Also: ParamTagImpl See Also: ThrowsTagImpl |
position | public SourcePosition position()(Code) | | Return the doc item to which this tag is attached.
the doc item to which this tag is attached. |
text | public String text()(Code) | | Return the text of this tag, that is, portion beyond tag name.
|
toString | public String toString()(Code) | | convert this object to a string.
|
|
|