Package gw.gosudoc.tags
Class TextTag
java.lang.Object
gw.gosudoc.tags.TextTag
- All Implemented Interfaces:
Tag
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionTag[]
Return the first sentence of the comment as an array of tags.holder()
Return the containingDoc
of this Tag element.Tag[]
For a documentation comment with embedded{@link}
tags, return an array ofTag
objects.kind()
Return the kind of this tag.name()
Return the name of this tag.position()
Return the source position of this tag.text()
Return the text of this tag, that is, the portion beyond tag name.toString()
Convert this object to a string.
-
Field Details
-
text
-
name
- See Also:
-
holder
-
-
Constructor Details
-
TextTag
Constructor
-
-
Method Details
-
name
Return the name of this tag. The name is the string starting with "@" that is used in a doc comment, such as@return
. For inline tags, such as{@link}
, the curly brackets are not part of the name, so in this example the name would be simply@link
. -
holder
Return the containingDoc
of this Tag element. -
kind
Return the kind of this tag. For most tags,kind() == name()
; the following table lists those cases where there is more than one tag of a given kind:Related Tags kind()
name()
@throws
@throws
@throws
@exception
@see
@see
@see
@link
@see
@linkplain
@serial
@serial
@serial
@serialData
-
text
Return the text of this tag, that is, the portion beyond tag name. -
toString
Convert this object to a string. -
inlineTags
For a documentation comment with embedded{@link}
tags, return an array ofTag
objects. The entire doc comment is broken down into strings separated by{@link}
tags, where each successive element of the array represents either a string or{@link}
tag, in order, from start to end. Each string is represented by aTag
object of name "Text", whereTag.text()
returns the string. Each{@link}
tag is represented by aSeeTag
of name "@link" and kind "@see". For example, given the following comment tag:This is a {@link Doc commentlabel} example.
return an array of Tag objects:
- Specified by:
inlineTags
in interfaceTag
- Returns:
- Tag[] array of tags
- See Also:
-
firstSentenceTags
Return the first sentence of the comment as an array of tags. Includes inline tags (i.e. {@link reference} tags) but not block tags. Each section of plain text is represented as aTag
of kind "Text". Inline tags are represented as aSeeTag
of kind "@link". If the locale is English language, the first sentence is determined by the rules described in the Java Language Specification (first version): "This sentence ends at the first period that is followed by a blank, tab, or line terminator or at the first tagline.", in addition a line will be terminated by paragraph and section terminating HTML tags: <p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre> or </pre>. If the locale is not English, the sentence end will be determined byBreakIterator.getSentenceInstance(Locale)
.- Specified by:
firstSentenceTags
in interfaceTag
- Returns:
- an array of
Tag
objects representing the first sentence of the comment
-
position
Return the source position of this tag.
-