Class TagImpl
java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.TagImpl
- All Implemented Interfaces:
Tag
- Direct Known Subclasses:
ParamTagImpl
,SeeTagImpl
,SerialFieldTagImpl
,ThrowsTagImpl
Deprecated.
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
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) String[]
Deprecated.for use by subclasses which have two part tag text.(package private) DocEnv
docenv()
Deprecated.Tag[]
Deprecated.Return array of tags for the first sentence in the doc comment text.holder()
Deprecated.Return the containingDoc
of this Tag element.Tag[]
Deprecated.For documentation comment with embedded @link tags, return the array of TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).kind()
Deprecated.Return the kind of this tag.name()
Deprecated.Return the name of this tag.position()
Deprecated.Return the doc item to which this tag is attached.text()
Deprecated.Return the text of this tag, that is, portion beyond tag name.toString()
Deprecated.convert this object to a string.
-
Field Details
-
text
Deprecated. -
name
Deprecated. -
holder
Deprecated. -
firstSentence
Deprecated.Cached first sentence. -
inlineTags
Deprecated.Cached inline tags.
-
-
Constructor Details
-
TagImpl
Deprecated.Constructor
-
-
Method Details
-
name
Deprecated.Return the name of this tag. -
holder
Deprecated.Return the containingDoc
of this Tag element. -
kind
Deprecated.Return the kind of this tag. -
text
Deprecated.Return the text of this tag, that is, portion beyond tag name. -
docenv
DocEnv docenv()Deprecated. -
divideAtWhite
String[] divideAtWhite()Deprecated.for use by subclasses which have two part tag text. -
toString
Deprecated.convert this object to a string. -
inlineTags
Deprecated.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 commentcommentlabel
", 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".- Specified by:
inlineTags
in interfaceTag
- Returns:
- TagImpl[] Array of tags with inline SeeTagImpls.
- See Also:
-
firstSentenceTags
Deprecated.Return array of tags for the first sentence in the doc comment text.- Specified by:
firstSentenceTags
in interfaceTag
- Returns:
- an array of
Tag
objects representing the first sentence of the comment
-
position
Deprecated.Return the doc item to which this tag is attached.
-