Class Comment
java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.Comment
Deprecated.
Comment contains all information in comment part.
It allows users to get first sentence of this comment, get
comment for different tags...
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final DocEnv
Deprecated.Doc environmentprivate static final Pattern
Deprecated.regex for case-insensitive match for <pre> and </pre> .private final com.sun.tools.javac.util.ListBuffer<Tag>
Deprecated.sorted comments with different tags.private String
Deprecated.text minus any tags. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) String
Deprecated.Return the text of the comment.private static int
findInlineTagDelim
(String inlineText, int searchStart) Deprecated.Recursively find the index of the closing '}' character for an inline tag and return it.(package private) static Tag[]
firstSentenceTags
(DocImpl holder, String text) Deprecated.Return array of tags for the locale specific first sentence in the text.(package private) static Tag[]
getInlineTags
(DocImpl holder, String inlinetext) Deprecated.Return array of tags with text and inline See Tags for a Doc comment.private static int
inlineTagFound
(DocImpl holder, String inlinetext, int start) Deprecated.Recursively search for the characters '{', '@', followed by name of inline tag and white space, if found return the index of the text following the white space.(package private) ParamTag[]
Deprecated.Return param tags (excluding type param tags) in this comment.private ParamTag[]
paramTags
(boolean typeParams) Deprecated.Return param tags in this comment.private static boolean
scanForPre
(String inlinetext, int start, int end, boolean inPre) Deprecated.(package private) SeeTag[]
seeTags()
Deprecated.Return see also tags in this comment.(package private) SerialFieldTag[]
Deprecated.Return serialField tags in this comment.(package private) Tag[]
tags()
Deprecated.Return all tags in this comment.(package private) Tag[]
Deprecated.Return tags of the specified kind in this comment.(package private) ThrowsTag[]
Deprecated.Return throws tags in this comment.toString()
Deprecated.Return text for this Doc comment.(package private) ParamTag[]
Deprecated.Return type param tags in this comment.
-
Field Details
-
tagList
Deprecated.sorted comments with different tags. -
text
Deprecated.text minus any tags. -
docenv
Deprecated.Doc environment -
prePat
Deprecated.regex for case-insensitive match for <pre> and </pre> .
-
-
Constructor Details
-
Comment
Deprecated.constructor of Comment.
-
-
Method Details
-
commentText
String commentText()Deprecated.Return the text of the comment. -
tags
Tag[] tags()Deprecated.Return all tags in this comment. -
tags
Deprecated.Return tags of the specified kind in this comment. -
throwsTags
ThrowsTag[] throwsTags()Deprecated.Return throws tags in this comment. -
paramTags
ParamTag[] paramTags()Deprecated.Return param tags (excluding type param tags) in this comment. -
typeParamTags
ParamTag[] typeParamTags()Deprecated.Return type param tags in this comment. -
paramTags
Deprecated.Return param tags in this comment. If typeParams is true include only type param tags, otherwise include only ordinary param tags. -
seeTags
SeeTag[] seeTags()Deprecated.Return see also tags in this comment. -
serialFieldTags
SerialFieldTag[] serialFieldTags()Deprecated.Return serialField tags in this comment. -
getInlineTags
Deprecated.Return array of tags with text and inline See Tags for a Doc comment. -
scanForPre
Deprecated. -
findInlineTagDelim
Deprecated.Recursively find the index of the closing '}' character for an inline tag and return it. If it can't be found, return -1.- Parameters:
inlineText
- the text to search in.searchStart
- the index of the place to start searching at.- Returns:
- the index of the closing '}' character for an inline tag. If it can't be found, return -1.
-
inlineTagFound
Deprecated.Recursively search for the characters '{', '@', followed by name of inline tag and white space, if found return the index of the text following the white space. else return -1. -
firstSentenceTags
Deprecated.Return array of tags for the locale specific first sentence in the text. -
toString
Deprecated.Return text for this Doc comment.
-