Class JavadocCommentsTokenTypes
java.lang.Object
com.puppycrawl.tools.checkstyle.api.JavadocCommentsTokenTypes
Contains the constants for all the tokens contained in the Abstract
Syntax Tree for the javadoc grammar.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
At-sign@
that starts a block tag.static final int
Value assigned to an attribute.static final int
@author
block tag.static final int
{@code}
inline tag.static final int
Colon symbol:
.static final int
Comma symbol,
.static final int
Custom or unrecognized block tag.static final int
Custom or unrecognized inline tag.static final int
@deprecated
block tag.static final int
Description part of a Javadoc tag.static final int
Equals sign=
.static final int
@exception
block tag.static final int
Keywordextends
in type parameters.static final int
Field type reference.static final int
Format specifier inside Javadoc content.static final int
Greater-than symbol>
.static final int
Hash symbol#
used in references.static final int
@hidden
block tag.static final int
Single HTML attribute.static final int
List of HTML attributes.static final int
Full HTML comment.static final int
Content inside an HTML comment.static final int
Closing part of an HTML comment.static final int
Opening part of an HTML comment.static final int
Content inside an HTML element.static final int
General HTML element.static final int
End of an HTML tag.static final int
Start of an HTML tag.static final int
Identifier token.static final int
{@index}
inline tag.static final int
Term used in{@index}
tag.static final int
{@inheritDoc}
inline tag.static final int
General block tag (e.g.static final int
Root node of any Javadoc comment.static final int
General inline tag (e.g.static final int
End of an inline tag}
.static final int
Start of an inline tag{
.static final int
Leading asterisk used to format Javadoc lines.static final int
{@link}
inline tag.static final int
{@linkplain}
inline tag.static final int
{@literal}
inline tag.static final int
Left parenthesis(
.static final int
Less-than symbol<
.static final int
Member reference (e.g. method or field).static final int
Newline character in a Javadoc comment.static final int
@param
Javadoc block tag.static final int
Parameter name reference.static final int
Parameter type reference.static final int
List of parameter types in a reference.static final int
@provides
block tag.static final int
Question mark symbol?
.static final int
General reference within Javadoc.static final int
@return
block tag.static final int
{@return}
inline tag.static final int
Right parenthesis)
.static final int
@see
block tag.static final int
@serial
block tag.static final int
@serialData
block tag.static final int
@serialField
block tag.static final int
@since
block tag.static final int
Slash symbol/
.static final int
Attribute name in a@snippet
.static final int
Single snippet attribute.static final int
Collection of snippet attributes.static final int
Body content of a@snippet
.static final int
@snippet
inline tag.static final int
String literal inside Javadoc.static final int
{@summary}
inline tag.static final int
Keywordsuper
in type parameters.static final int
{@systemProperty}
inline tag.static final int
Attribute name inside an HTML tag.static final int
Closing tag delimiter>
.static final int
HTML tag name.static final int
Opening tag delimiter<
.static final int
Slash symbol inside a closing tag.static final int
Self-closing tag delimiter/>
.static final int
Plain text content within a Javadoc comment.static final int
@throws
block tag.static final int
Single type argument in generics.static final int
Type arguments in generics.static final int
Type name reference.static final int
@uses
block tag.static final int
{@value}
inline tag.static final int
@version
block tag.static final int
Void HTML element (self-closing). -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Empty private constructor of the current class. -
Method Summary
-
Field Details
-
JAVADOC_CONTENT
Root node of any Javadoc comment.Tree for example:
JAVADOC_CONTENT -> JAVADOC_CONTENT |--LEADING_ASTERISK -> * |--NEWLINE -> \n |--LEADING_ASTERISK -> * |--NEWLINE -> \n |--LEADING_ASTERISK -> * `--NEWLINE -> \n
- See Also:
-
LEADING_ASTERISK
Leading asterisk used to format Javadoc lines.- See Also:
-
NEWLINE
Newline character in a Javadoc comment.- See Also:
-
TEXT
Plain text content within a Javadoc comment.- See Also:
-
JAVADOC_BLOCK_TAG
General block tag (e.g.@param
,@return
).- See Also:
-
AT_SIGN
At-sign@
that starts a block tag.- See Also:
-
AUTHOR_BLOCK_TAG
@author
block tag.- See Also:
-
DEPRECATED_BLOCK_TAG
@deprecated
block tag.- See Also:
-
PARAM_BLOCK_TAG
@param
Javadoc block tag.Such Javadoc tag can have two children:
Example:
Tree:* @param value The parameter of method.
JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--PARAM_BLOCK_TAG -> PARAM_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> param |--TEXT -> |--PARAMETER_NAME -> value `--DESCRIPTION -> DESCRIPTION `--TEXT -> The parameter of method.
- See Also:
-
RETURN_BLOCK_TAG
@return
block tag.- See Also:
-
THROWS_BLOCK_TAG
@throws
block tag.- See Also:
-
EXCEPTION_BLOCK_TAG
@exception
block tag.- See Also:
-
SINCE_BLOCK_TAG
@since
block tag.- See Also:
-
VERSION_BLOCK_TAG
@version
block tag.- See Also:
-
SEE_BLOCK_TAG
@see
block tag.- See Also:
-
HIDDEN_BLOCK_TAG
@hidden
block tag.- See Also:
-
USES_BLOCK_TAG
@uses
block tag.- See Also:
-
PROVIDES_BLOCK_TAG
@provides
block tag.- See Also:
-
SERIAL_BLOCK_TAG
@serial
block tag.- See Also:
-
SERIAL_DATA_BLOCK_TAG
@serialData
block tag.- See Also:
-
SERIAL_FIELD_BLOCK_TAG
@serialField
block tag.- See Also:
-
CUSTOM_BLOCK_TAG
Custom or unrecognized block tag.- See Also:
-
JAVADOC_INLINE_TAG
General inline tag (e.g.@link
).- See Also:
-
JAVADOC_INLINE_TAG_START
Start of an inline tag{
.- See Also:
-
JAVADOC_INLINE_TAG_END
End of an inline tag}
.- See Also:
-
CODE_INLINE_TAG
{@code}
inline tag.- See Also:
-
LINK_INLINE_TAG
{@link}
inline tag.- See Also:
-
LINKPLAIN_INLINE_TAG
{@linkplain}
inline tag.- See Also:
-
VALUE_INLINE_TAG
{@value}
inline tag.- See Also:
-
SUMMARY_INLINE_TAG
{@summary}
inline tag.- See Also:
-
INHERIT_DOC_INLINE_TAG
{@inheritDoc}
inline tag.- See Also:
-
SYSTEM_PROPERTY_INLINE_TAG
{@systemProperty}
inline tag.- See Also:
-
LITERAL_INLINE_TAG
{@literal}
inline tag.- See Also:
-
RETURN_INLINE_TAG
{@return}
inline tag.- See Also:
-
INDEX_INLINE_TAG
{@index}
inline tag.- See Also:
-
SNIPPET_INLINE_TAG
@snippet
inline tag.- See Also:
-
CUSTOM_INLINE_TAG
Custom or unrecognized inline tag.- See Also:
-
IDENTIFIER
Identifier token.- See Also:
-
HASH
Hash symbol#
used in references.- See Also:
-
LPAREN
Left parenthesis(
.- See Also:
-
RPAREN
Right parenthesis)
.- See Also:
-
COMMA
Comma symbol,
.- See Also:
-
SLASH
Slash symbol/
.- See Also:
-
QUESTION
Question mark symbol?
.- See Also:
-
LT
Less-than symbol<
.- See Also:
-
GT
Greater-than symbol>
.- See Also:
-
EXTENDS
Keywordextends
in type parameters.- See Also:
-
SUPER
Keywordsuper
in type parameters.- See Also:
-
PARAMETER_TYPE
Parameter type reference.- See Also:
-
REFERENCE
General reference within Javadoc.- See Also:
-
TYPE_NAME
Type name reference.- See Also:
-
MEMBER_REFERENCE
Member reference (e.g. method or field).- See Also:
-
PARAMETER_TYPE_LIST
List of parameter types in a reference.- See Also:
-
TYPE_ARGUMENTS
Type arguments in generics.- See Also:
-
TYPE_ARGUMENT
Single type argument in generics.- See Also:
-
DESCRIPTION
Description part of a Javadoc tag.- See Also:
-
FORMAT_SPECIFIER
Format specifier inside Javadoc content.- See Also:
-
SNIPPET_ATTR_NAME
Attribute name in a@snippet
.- See Also:
-
EQUALS
Equals sign=
.- See Also:
-
ATTRIBUTE_VALUE
Value assigned to an attribute.- See Also:
-
COLON
Colon symbol:
.- See Also:
-
INDEX_TERM
Term used in{@index}
tag.- See Also:
-
SNIPPET_ATTRIBUTE
Single snippet attribute.- See Also:
-
SNIPPET_ATTRIBUTES
Collection of snippet attributes.- See Also:
-
SNIPPET_BODY
Body content of a@snippet
.- See Also:
-
FIELD_TYPE
Field type reference.- See Also:
-
PARAMETER_NAME
Parameter name reference.- See Also:
-
STRING_LITERAL
String literal inside Javadoc.- See Also:
-
HTML_ELEMENT
General HTML element.- See Also:
-
VOID_ELEMENT
Void HTML element (self-closing).- See Also:
-
HTML_CONTENT
Content inside an HTML element.- See Also:
-
HTML_ATTRIBUTE
Single HTML attribute.- See Also:
-
HTML_ATTRIBUTES
List of HTML attributes.- See Also:
-
HTML_TAG_START
Start of an HTML tag.- See Also:
-
HTML_TAG_END
End of an HTML tag.- See Also:
-
TAG_OPEN
Opening tag delimiter<
.- See Also:
-
TAG_NAME
HTML tag name.- See Also:
-
TAG_CLOSE
Closing tag delimiter>
.- See Also:
-
TAG_SLASH_CLOSE
Self-closing tag delimiter/>
.- See Also:
-
TAG_SLASH
Slash symbol inside a closing tag.- See Also:
-
TAG_ATTR_NAME
Attribute name inside an HTML tag.- See Also:
-
HTML_COMMENT
Full HTML comment.- See Also:
-
HTML_COMMENT_START
Opening part of an HTML comment.- See Also:
-
HTML_COMMENT_END
Closing part of an HTML comment.- See Also:
-
HTML_COMMENT_CONTENT
Content inside an HTML comment.- See Also:
-
-
Constructor Details
-
JavadocCommentsTokenTypes
private JavadocCommentsTokenTypes()Empty private constructor of the current class.
-