Package com.puppycrawl.tools.checkstyle.api

Class JavadocCommentsTokenTypes

java.lang.Object

com.puppycrawl.tools.checkstyle.api.JavadocCommentsTokenTypes

public final class JavadocCommentsTokenTypes
extends Object

Contains the constants for all the tokens contained in the Abstract Syntax Tree for the javadoc grammar.

See Also:

• javadoc - The Java API Documentation Generator

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AT_SIGN	At-sign @ that starts a block tag.
static final int	ATTRIBUTE_VALUE	Value assigned to an attribute.
static final int	AUTHOR_BLOCK_TAG	@author Javadoc block tag.
static final int	CODE_INLINE_TAG	{@code} Javadoc inline tag.
static final int	COLON	Colon symbol : .
static final int	COMMA	Comma symbol , .
static final int	CUSTOM_BLOCK_TAG	@customBlock Javadoc block tag.
static final int	CUSTOM_INLINE_TAG	Custom or unrecognized inline tag.
static final int	DEPRECATED_BLOCK_TAG	@deprecated block tag.
static final int	DESCRIPTION	Description part of a Javadoc tag.
static final int	EQUALS	Equals sign = .
static final int	EXCEPTION_BLOCK_TAG	@exception Javadoc block tag.
static final int	EXTENDS	extends keyword inside type arguments of a Javadoc inline tag.
static final int	FIELD_TYPE	Field type reference.
static final int	FORMAT_SPECIFIER	Format specifier inside Javadoc content.
static final int	GT	Greater-than symbol > .
static final int	HASH	Hash symbol # used in references.
static final int	HIDDEN_BLOCK_TAG	@hidden Javadoc block tag.
static final int	HTML_ATTRIBUTE	Single HTML attribute.
static final int	HTML_ATTRIBUTES	List of HTML attributes.
static final int	HTML_COMMENT	Start of an HTML comment node.
static final int	HTML_COMMENT_CONTENT	Content inside an HTML comment.
static final int	HTML_COMMENT_END	Closing part of an HTML comment.
static final int	HTML_COMMENT_START	Opening part of an HTML comment.
static final int	HTML_CONTENT	Content inside an HTML element.
static final int	HTML_ELEMENT	General HTML element.
static final int	HTML_TAG_END	End of an HTML tag (the closing tag node).
static final int	HTML_TAG_START	Start of an HTML tag (the opening tag node).
static final int	IDENTIFIER	Identifier token.
static final int	INDEX_INLINE_TAG	{@index} inline tag.
static final int	INDEX_TERM	Term used in {@index} tag.
static final int	INHERIT_DOC_INLINE_TAG	{@inheritDoc} inline tag.
static final int	JAVADOC_BLOCK_TAG	General block tag (e.g.
static final int	JAVADOC_CONTENT	Root node of any Javadoc comment.
static final int	JAVADOC_INLINE_TAG	General inline tag (e.g.
static final int	JAVADOC_INLINE_TAG_END	End of an inline tag }.
static final int	JAVADOC_INLINE_TAG_START	Start of an inline tag {.
static final int	LEADING_ASTERISK	Leading asterisk used to format Javadoc lines.
static final int	LINK_INLINE_TAG	{@link} Javadoc inline tag.
static final int	LINKPLAIN_INLINE_TAG	{@linkplain} Javadoc inline tag.
static final int	LITERAL_INLINE_TAG	{@literal} inline tag.
static final int	LPAREN	Left parenthesis ( .
static final int	LT	Less-than symbol < .
static final int	MEMBER_REFERENCE	Member reference (e.g. method or field).
static final int	NEWLINE	Newline character in a Javadoc comment.
static final int	PARAM_BLOCK_TAG	@param Javadoc block tag.
static final int	PARAMETER_NAME	Parameter name reference.
static final int	PARAMETER_TYPE	Parameter type reference.
static final int	PARAMETER_TYPE_LIST	List of parameter types in a reference.
static final int	PROVIDES_BLOCK_TAG	@provides block tag.
static final int	QUESTION	Question mark symbol ? .
static final int	REFERENCE	General reference within Javadoc.
static final int	RETURN_BLOCK_TAG	@return Javadoc block tag.
static final int	RETURN_INLINE_TAG	Inline return tag inside Javadoc.
static final int	RPAREN	Right parenthesis ) .
static final int	SEE_BLOCK_TAG	@see Javadoc block tag.
static final int	SERIAL_BLOCK_TAG	@serial block tag.
static final int	SERIAL_DATA_BLOCK_TAG	@serialData block tag.
static final int	SERIAL_FIELD_BLOCK_TAG	@serialField Javadoc block tag.
static final int	SINCE_BLOCK_TAG	@since Javadoc block tag.
static final int	SLASH	Slash symbol / .
static final int	SNIPPET_ATTR_NAME	Attribute name in a @snippet.
static final int	SNIPPET_ATTRIBUTE	Single snippet attribute.
static final int	SNIPPET_ATTRIBUTES	Collection of snippet attributes.
static final int	SNIPPET_BODY	Body content of a @snippet.
static final int	SNIPPET_INLINE_TAG	@snippet inline tag.
static final int	STRING_LITERAL	String literal inside Javadoc.
static final int	SUMMARY_INLINE_TAG	Inline {@summary ...} tag inside Javadoc.
static final int	SUPER	Keyword super in type parameters.
static final int	SYSTEM_PROPERTY_INLINE_TAG	{@systemProperty} inline tag.
static final int	TAG_ATTR_NAME	Attribute name inside an HTML tag.
static final int	TAG_CLOSE	Closing tag delimiter > .
static final int	TAG_NAME	HTML tag name.
static final int	TAG_OPEN	Opening tag delimiter < .
static final int	TAG_SLASH	Slash symbol inside a closing tag.
static final int	TAG_SLASH_CLOSE	/> Self-closing tag delimiter.
static final int	TEXT	Plain text content within a Javadoc comment.
static final int	THROWS_BLOCK_TAG	@throws Javadoc block tag.
static final int	TYPE_ARGUMENT	Single type argument in generics.
static final int	TYPE_ARGUMENTS	Type arguments in generics.
static final int	TYPE_NAME	Type name reference.
static final int	USES_BLOCK_TAG	@uses Javadoc block tag.
static final int	VALUE_INLINE_TAG	{@value} Javadoc inline tag.
static final int	VERSION_BLOCK_TAG	@version Javadoc block tag.
static final int	VOID_ELEMENT	Void HTML element (self-closing).

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JavadocCommentsTokenTypes()	Empty private constructor of the current class.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JAVADOC_CONTENT

public static final int 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:

• Constant Field Values

LEADING_ASTERISK

public static final int LEADING_ASTERISK

Leading asterisk used to format Javadoc lines.

See Also:

• Constant Field Values

NEWLINE

public static final int NEWLINE

Newline character in a Javadoc comment.

See Also:

• Constant Field Values

TEXT

public static final int TEXT

Plain text content within a Javadoc comment.

See Also:

• Constant Field Values

JAVADOC_BLOCK_TAG

public static final int JAVADOC_BLOCK_TAG

General block tag (e.g. @param, @return).

See Also:

• Constant Field Values

AT_SIGN

public static final int AT_SIGN

At-sign @ that starts a block tag.

See Also:

• Constant Field Values

AUTHOR_BLOCK_TAG

public static final int AUTHOR_BLOCK_TAG

@author Javadoc block tag.

Such Javadoc tag can have one child:

1. DESCRIPTION

Example:

* @author name.

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--AUTHOR_BLOCK_TAG -> AUTHOR_BLOCK_TAG
    |--AT_SIGN -> @
    |--TAG_NAME -> author
    `--DESCRIPTION -> DESCRIPTION
        `--TEXT ->  name.
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

DEPRECATED_BLOCK_TAG

public static final int DEPRECATED_BLOCK_TAG

@deprecated block tag.

Such Javadoc tag can have one child:

1. DESCRIPTION

Example:

* @deprecated deprecated text.

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--DEPRECATED_BLOCK_TAG -> DEPRECATED_BLOCK_TAG
     |--AT_SIGN -> @
     |--TAG_NAME -> deprecated
     `--DESCRIPTION -> DESCRIPTION
         `--TEXT ->  deprecated text.
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

PARAM_BLOCK_TAG

public static final int PARAM_BLOCK_TAG

@param Javadoc block tag.

Such Javadoc tag can have two children:

1. PARAMETER_NAME
2. DESCRIPTION

Example:

* @param value The parameter of method.

Tree:

 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:

• JAVADOC_BLOCK_TAG
• Constant Field Values

RETURN_BLOCK_TAG

public static final int RETURN_BLOCK_TAG

@return Javadoc block tag.

Such Javadoc tag can have one child:

1. DESCRIPTION

Example:

* @return The return of method.

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--RETURN_BLOCK_TAG -> RETURN_BLOCK_TAG
    |--AT_SIGN -> @
    |--TAG_NAME -> return
    `--DESCRIPTION -> DESCRIPTION
        `--TEXT ->  The return of method.
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

THROWS_BLOCK_TAG

public static final int THROWS_BLOCK_TAG

@throws Javadoc block tag.

Such Javadoc tag can have two children:

1. IDENTIFIER - the exception class
2. DESCRIPTION - description

Example:

* @throws IOException if an I/O error occurs

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--THROWS_BLOCK_TAG -> THROWS_BLOCK_TAG
     |--AT_SIGN -> @
     |--TAG_NAME -> throws
     |--TEXT ->
     |--IDENTIFIER -> IOException
     `--DESCRIPTION -> DESCRIPTION
         `--TEXT ->  if an I/O error occurs
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

EXCEPTION_BLOCK_TAG

public static final int EXCEPTION_BLOCK_TAG

@exception Javadoc block tag.

Such Javadoc tag can have two children:

1. IDENTIFIER
2. DESCRIPTION

Example:

* @exception FileNotFoundException when file is not found.

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--EXCEPTION_BLOCK_TAG -> EXCEPTION_BLOCK_TAG
    |--AT_SIGN -> @
    |--TAG_NAME -> exception
    |--TEXT ->
    |--IDENTIFIER -> FileNotFoundException
    `--DESCRIPTION -> DESCRIPTION
        `--TEXT -> when file is not found.
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

SINCE_BLOCK_TAG

public static final int SINCE_BLOCK_TAG

@since Javadoc block tag.

Such Javadoc tag can have one child:

1. DESCRIPTION

Example:

* @since 1.0

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--SINCE_BLOCK_TAG -> SINCE_BLOCK_TAG
    |--AT_SIGN -> @
    |--TAG_NAME -> since
    `--DESCRIPTION -> DESCRIPTION
        `--TEXT ->  1.0
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

VERSION_BLOCK_TAG

public static final int VERSION_BLOCK_TAG

@version Javadoc block tag.

This tag has only one argument — TEXT:

Example:

* @version value

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--VERSION_BLOCK_TAG -> VERSION_BLOCK_TAG
    |--AT_SIGN -> @
    |--TAG_NAME -> version
    `--DESCRIPTION -> DESCRIPTION
        `--TEXT ->  value
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

SEE_BLOCK_TAG

public static final int SEE_BLOCK_TAG

@see Javadoc block tag.

Such Javadoc tag can have three children:

1. REFERENCE
2. DESCRIPTION
3. HTML_ELEMENT

Example:

* @see SomeClass#Field

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--SEE_BLOCK_TAG -> SEE_BLOCK_TAG
     |--AT_SIGN -> @
     |--TAG_NAME -> see
     |--TEXT ->
     `--REFERENCE -> REFERENCE
         |--IDENTIFIER -> SomeClass
         |--HASH -> #
         `--MEMBER_REFERENCE -> MEMBER_REFERENCE
             `--IDENTIFIER -> Field
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

HIDDEN_BLOCK_TAG

public static final int HIDDEN_BLOCK_TAG

@hidden Javadoc block tag.

Such Javadoc tag can have one child:

1. DESCRIPTION – optional description text

Example:

* @hidden value

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--HIDDEN_BLOCK_TAG -> HIDDEN_BLOCK_TAG
     |--AT_SIGN -> @
     |--TAG_NAME -> hidden
     `--DESCRIPTION -> DESCRIPTION
         `--TEXT ->  value
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

USES_BLOCK_TAG

public static final int USES_BLOCK_TAG

@uses Javadoc block tag.

Such Javadoc tag can have one child:

1. IDENTIFIER – the referenced service type

Example:

* @uses com.example.app.MyService

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--USES_BLOCK_TAG -> USES_BLOCK_TAG
    |--AT_SIGN -> @
    |--TAG_NAME -> uses
    |--TEXT ->
    `--IDENTIFIER -> com.example.app.MyService
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

PROVIDES_BLOCK_TAG

public static final int PROVIDES_BLOCK_TAG

@provides block tag.

Such Javadoc tag can have two children:

1. IDENTIFIER
2. DESCRIPTION

Example:

* @provides com.example.MyService with com.example.MyServiceImpl

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--PROVIDES_BLOCK_TAG -> PROVIDES_BLOCK_TAG
    |--AT_SIGN -> @
    |--TAG_NAME -> provides
    |--TEXT ->
    |--IDENTIFIER -> com.example.MyService
    `--DESCRIPTION -> DESCRIPTION
        `--TEXT ->  with com.example.MyServiceImpl
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

SERIAL_BLOCK_TAG

public static final int SERIAL_BLOCK_TAG

@serial block tag.

Such Javadoc tag can have one child:

1. DESCRIPTION – optional description text

Example:

* @serial include

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--SERIAL_BLOCK_TAG -> SERIAL_BLOCK_TAG
   |--AT_SIGN -> @
   |--TAG_NAME -> serial
   `--DESCRIPTION -> DESCRIPTION
       `--TEXT ->  include
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

SERIAL_DATA_BLOCK_TAG

public static final int SERIAL_DATA_BLOCK_TAG

@serialData block tag.

Such Javadoc tag can have one child:

1. DESCRIPTION – optional description text

Example:

* @serialData data description value

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--SERIAL_DATA_BLOCK_TAG -> SERIAL_DATA_BLOCK_TAG
    |--AT_SIGN -> @
    |--TAG_NAME -> serialData
    `--DESCRIPTION -> DESCRIPTION
        `--TEXT ->  data description value
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

SERIAL_FIELD_BLOCK_TAG

public static final int SERIAL_FIELD_BLOCK_TAG

@serialField Javadoc block tag.

Such Javadoc tag can have three children:

1. IDENTIFIER – field name
2. FIELD_TYPE – field type
3. DESCRIPTION – field description

Example:

* @serialField name String The person's full name.

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--SERIAL_FIELD_BLOCK_TAG -> SERIAL_FIELD_BLOCK_TAG
     |--AT_SIGN -> @
     |--TAG_NAME -> serialField
     |--TEXT ->
     |--IDENTIFIER -> name
     |--TEXT ->
     |--FIELD_TYPE -> String
     `--DESCRIPTION -> DESCRIPTION
         `--TEXT ->  The person's full name.
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

CUSTOM_BLOCK_TAG

public static final int CUSTOM_BLOCK_TAG

@customBlock Javadoc block tag.

This type represents any block tag that is not explicitly recognized by Checkstyle, such as a project-specific or malformed tag.

Example:

* @mycustomtag This is a custom block tag.

Tree:

 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--CUSTOM_BLOCK_TAG -> CUSTOM_BLOCK_TAG
     |--AT_SIGN -> @
     |--TAG_NAME -> customBlock
     |--TEXT ->
     `--DESCRIPTION -> DESCRIPTION
         `--TEXT ->  This is a custom block tag.
 

See Also:

• JAVADOC_BLOCK_TAG
• Constant Field Values

JAVADOC_INLINE_TAG

public static final int JAVADOC_INLINE_TAG

General inline tag (e.g. @link).

See Also:

• Constant Field Values

JAVADOC_INLINE_TAG_START

public static final int JAVADOC_INLINE_TAG_START

Start of an inline tag {.

See Also:

• Constant Field Values

JAVADOC_INLINE_TAG_END

public static final int JAVADOC_INLINE_TAG_END

End of an inline tag }.

See Also:

• Constant Field Values

CODE_INLINE_TAG

public static final int CODE_INLINE_TAG

{@code} Javadoc inline tag.

Such Javadoc tag can have no children:

Example:

* {@code println("Hello");}

Tree:

 `--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     |--CODE_INLINE_TAG -> CODE_INLINE_TAG
     |--JAVADOC_INLINE_TAG_START -> { @
     |--TAG_NAME -> code
     |--TEXT ->  println("Hello");
     `--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• JAVADOC_INLINE_TAG
• Constant Field Values

LINK_INLINE_TAG

public static final int LINK_INLINE_TAG

{@link} Javadoc inline tag.

Such Javadoc tag can have two children:

1. REFERENCE
2. DESCRIPTION

Example:

* {@link Math#max(int, int) label}

Tree:

 --JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 `--LINK_INLINE_TAG -> LINK_INLINE_TAG
     |--JAVADOC_INLINE_TAG_START -> { @
     |--TAG_NAME -> link
     |--TEXT ->
     |--REFERENCE -> REFERENCE
     |   |--IDENTIFIER -> Math
     |   |--HASH -> #
     |   `--MEMBER_REFERENCE -> MEMBER_REFERENCE
     |       |--IDENTIFIER -> max
     |       |--LPAREN -> (
     |       |--PARAMETER_TYPE_LIST -> PARAMETER_TYPE_LIST
     |       |   |--PARAMETER_TYPE -> int
     |       |   |--COMMA -> ,
     |       |   |--TEXT ->
     |       |   `--PARAMETER_TYPE -> int
     |       `--RPAREN -> )
     |--DESCRIPTION -> DESCRIPTION
     |   `--TEXT -> label
     `--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• JAVADOC_INLINE_TAG
• Constant Field Values

LINKPLAIN_INLINE_TAG

public static final int LINKPLAIN_INLINE_TAG

{@linkplain} Javadoc inline tag.

Such Javadoc tag can have two children:

1. REFERENCE
2. DESCRIPTION

Example:

* {@linkplain String#indexOf(int, int) label}

Tree:

 --JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 `--LINKPLAIN_INLINE_TAG -> LINKPLAIN_INLINE_TAG
     |--JAVADOC_INLINE_TAG_START -> { @
     |--TAG_NAME -> linkplain
     |--TEXT ->
     |--REFERENCE -> REFERENCE
     |   |--IDENTIFIER -> String
     |   |--HASH -> #
     |   `--MEMBER_REFERENCE -> MEMBER_REFERENCE
     |       |--IDENTIFIER -> indexOf
     |       |--LPAREN -> (
     |       |--PARAMETER_TYPE_LIST -> PARAMETER_TYPE_LIST
     |       |   |--PARAMETER_TYPE -> int
     |       |   |--COMMA -> ,
     |       |   |--TEXT ->
     |       |   `--PARAMETER_TYPE -> int
     |       `--RPAREN -> )
     |--DESCRIPTION -> DESCRIPTION
     |   `--TEXT ->  label
     `--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• JAVADOC_INLINE_TAG
• Constant Field Values

VALUE_INLINE_TAG

public static final int VALUE_INLINE_TAG

{@value} Javadoc inline tag.

Such Javadoc tag can have one child:

1. REFERENCE

Example:

* {@value Integer#MAX_VALUE}

Tree:

 --JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 `--VALUE_INLINE_TAG -> VALUE_INLINE_TAG
     |--JAVADOC_INLINE_TAG_START -> { @
     |--TAG_NAME -> value
     |--TEXT ->
     |--REFERENCE -> REFERENCE
     |   |--IDENTIFIER -> Integer
     |   |--HASH -> #
     |   `--MEMBER_REFERENCE -> MEMBER_REFERENCE
     |       `--IDENTIFIER -> MAX_VALUE
     |--TEXT ->
     `--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• JAVADOC_INLINE_TAG
• Constant Field Values

SUMMARY_INLINE_TAG

public static final int SUMMARY_INLINE_TAG

Inline {@summary ...} tag inside Javadoc.

This node represents an inline {@summary ...} tag used to provide a short summary description within a Javadoc sentence.

Example:

* Example showing {@summary This is a short summary.}

Tree:

 |--LEADING_ASTERISK -> *
 |--TEXT ->  Example showing
 `--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--SUMMARY_INLINE_TAG -> SUMMARY_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> { @
         |--TAG_NAME -> summary
         |--DESCRIPTION -> DESCRIPTION
         |   `--TEXT ->  This is a short summary.
         `--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• JAVADOC_INLINE_TAG
• Constant Field Values

INHERIT_DOC_INLINE_TAG

public static final int INHERIT_DOC_INLINE_TAG

{@inheritDoc} inline tag.

See Also:

• Constant Field Values

SYSTEM_PROPERTY_INLINE_TAG

public static final int SYSTEM_PROPERTY_INLINE_TAG

{@systemProperty} inline tag.

See Also:

• Constant Field Values

LITERAL_INLINE_TAG

public static final int LITERAL_INLINE_TAG

{@literal} inline tag.

See Also:

• Constant Field Values

RETURN_INLINE_TAG

public static final int RETURN_INLINE_TAG

Inline return tag inside Javadoc.

This node represents an inline {@return ...} tag used to describe the returned value directly within a Javadoc sentence.

Example:

Example showing result {@return The computed value.}

Tree:

 |--LEADING_ASTERISK -> *
 |--TEXT ->  Example showing result
 `--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--RETURN_INLINE_TAG -> RETURN_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> { @
         |--TAG_NAME -> return
         |--DESCRIPTION -> DESCRIPTION
         |   `--TEXT ->  The computed value.
         `--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• JAVADOC_INLINE_TAG
• Constant Field Values

INDEX_INLINE_TAG

public static final int INDEX_INLINE_TAG

{@index} inline tag.

This node represents an inline {@index ...} tag used to mark an index term inside a Javadoc sentence.

Example:

* Example showing {@index keyword description of the index term}.

Tree:

 |--LEADING_ASTERISK -> *
 |--TEXT ->  Example showing
 `--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--INDEX_INLINE_TAG -> INDEX_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> { @
         |--TAG_NAME -> index
         |--TEXT ->
         |--INDEX_TERM -> keyword
         |--DESCRIPTION -> DESCRIPTION
         |   `--TEXT ->  description of the index term
         `--JAVADOC_INLINE_TAG_END -> }
 |--TEXT -> .
 

See Also:

• JAVADOC_INLINE_TAG
• Constant Field Values

SNIPPET_INLINE_TAG

public static final int SNIPPET_INLINE_TAG

@snippet inline tag.

This node represents an inline { @code { @snippet :}} tag used to embed code snippets directly inside a Javadoc sentence.

Example:

{ @code * Example showing { @snippet :java |
 System.out.println("hello");
 }}

Tree:

 |--LEADING_ASTERISK -> *
 |--TEXT -> Example showing
 `--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--SNIPPET_INLINE_TAG -> SNIPPET_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> { @
         |--COLON -> :
         |--SNIPPET_BODY -> SNIPPET_BODY
         |   |--TEXT -> java |
         |   |--NEWLINE -> \n
         |   |--LEADING_ASTERISK -> *
         |   |--TEXT -> System.out.println("hello");
         |   |--NEWLINE -> \n
         |   |--LEADING_ASTERISK -> *
         |   `--TEXT ->
         `--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• JAVADOC_INLINE_TAG
• Constant Field Values

CUSTOM_INLINE_TAG

public static final int CUSTOM_INLINE_TAG

Custom or unrecognized inline tag.

See Also:

• Constant Field Values

IDENTIFIER

public static final int IDENTIFIER

Identifier token.

See Also:

• Constant Field Values

HASH

public static final int HASH

Hash symbol # used in references.

See Also:

• Constant Field Values

LPAREN

public static final int LPAREN

Left parenthesis ( .

See Also:

• Constant Field Values

RPAREN

public static final int RPAREN

Right parenthesis ) .

See Also:

• Constant Field Values

COMMA

public static final int COMMA

Comma symbol , .

See Also:

• Constant Field Values

SLASH

public static final int SLASH

Slash symbol / .

See Also:

• Constant Field Values

QUESTION

public static final int QUESTION

Question mark symbol ? .

See Also:

• Constant Field Values

LT

public static final int LT

Less-than symbol < .

See Also:

• Constant Field Values

GT

public static final int GT

Greater-than symbol > .

See Also:

• Constant Field Values

EXTENDS

public static final int EXTENDS

extends keyword inside type arguments of a Javadoc inline tag.

This node represents the extends bound used inside a parameterized type within an inline Javadoc tag.

Example:

 * {@link java.util.List<? extends Number> list of any subtype of Number}
 

Tree:

 |--LEADING_ASTERISK -> *
 |--TEXT ->
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--LINK_INLINE_TAG -> LINK_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> { @
         |--TAG_NAME -> link
         |--TEXT ->
         |--REFERENCE -> REFERENCE
         |   |--IDENTIFIER -> java.util.List
         |   `--TYPE_ARGUMENTS -> TYPE_ARGUMENTS
         |       |--LT -> <
         |       |--TYPE_ARGUMENT -> TYPE_ARGUMENT
         |       |   |--QUESTION -> ?
         |       |   |--TEXT ->
         |       |   |--EXTENDS -> extends
         |       |   |--TEXT ->
         |       |   `--IDENTIFIER -> Number
         |       `--GT -> >
         |--DESCRIPTION -> DESCRIPTION
         |   `--TEXT ->  list of any subtype of Number
         `--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• JAVADOC_INLINE_TAG
• Constant Field Values

SUPER

public static final int SUPER

Keyword super in type parameters.

See Also:

• Constant Field Values

PARAMETER_TYPE

public static final int PARAMETER_TYPE

Parameter type reference.

See Also:

• Constant Field Values

REFERENCE

public static final int REFERENCE

General reference within Javadoc.

See Also:

• Constant Field Values

TYPE_NAME

public static final int TYPE_NAME

Type name reference.

See Also:

• Constant Field Values

MEMBER_REFERENCE

public static final int MEMBER_REFERENCE

Member reference (e.g. method or field).

See Also:

• Constant Field Values

PARAMETER_TYPE_LIST

public static final int PARAMETER_TYPE_LIST

List of parameter types in a reference.

See Also:

• Constant Field Values

TYPE_ARGUMENTS

public static final int TYPE_ARGUMENTS

Type arguments in generics.

See Also:

• Constant Field Values

TYPE_ARGUMENT

public static final int TYPE_ARGUMENT

Single type argument in generics.

See Also:

• Constant Field Values

DESCRIPTION

public static final int DESCRIPTION

Description part of a Javadoc tag.

See Also:

• Constant Field Values

FORMAT_SPECIFIER

public static final int FORMAT_SPECIFIER

Format specifier inside Javadoc content.

See Also:

• Constant Field Values

SNIPPET_ATTR_NAME

public static final int SNIPPET_ATTR_NAME

Attribute name in a @snippet.

See Also:

• Constant Field Values

EQUALS

public static final int EQUALS

Equals sign = .

See Also:

• Constant Field Values

ATTRIBUTE_VALUE

public static final int ATTRIBUTE_VALUE

Value assigned to an attribute.

See Also:

• Constant Field Values

COLON

public static final int COLON

Colon symbol : .

See Also:

• Constant Field Values

INDEX_TERM

public static final int INDEX_TERM

Term used in {@index} tag.

See Also:

• Constant Field Values

SNIPPET_ATTRIBUTE

public static final int SNIPPET_ATTRIBUTE

Single snippet attribute.

See Also:

• Constant Field Values

SNIPPET_ATTRIBUTES

public static final int SNIPPET_ATTRIBUTES

Collection of snippet attributes.

See Also:

• Constant Field Values

SNIPPET_BODY

public static final int SNIPPET_BODY

Body content of a @snippet.

See Also:

• Constant Field Values

FIELD_TYPE

public static final int FIELD_TYPE

Field type reference.

See Also:

• Constant Field Values

PARAMETER_NAME

public static final int PARAMETER_NAME

Parameter name reference.

See Also:

• Constant Field Values

STRING_LITERAL

public static final int STRING_LITERAL

String literal inside Javadoc.

See Also:

• Constant Field Values

HTML_ELEMENT

public static final int HTML_ELEMENT

General HTML element.

See Also:

• Constant Field Values

VOID_ELEMENT

public static final int VOID_ELEMENT

Void HTML element (self-closing).

See Also:

• Constant Field Values

HTML_CONTENT

public static final int HTML_CONTENT

Content inside an HTML element.

This node represents the textual content between an HTML start tag and the corresponding end tag inside a Javadoc comment.

Example:

* <a href="https://example.com">link</a>

Tree:

 |--LEADING_ASTERISK -> *
 `--HTML_ELEMENT -> HTML_ELEMENT
     |--HTML_TAG_START -> HTML_TAG_START
     |   |--TAG_OPEN -> <
     |   |--TAG_NAME -> a
     |   |--HTML_ATTRIBUTES -> HTML_ATTRIBUTES
     |   |   `--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
     |   |       |--TEXT ->   (whitespace)
     |   |       |--TAG_ATTR_NAME -> href
     |   |       |--EQUALS -> =
     |   |       `--ATTRIBUTE_VALUE -> "https://example.com"
     |   `--TAG_CLOSE -> >
     |--HTML_CONTENT -> HTML_CONTENT
     |   `--TEXT -> link
     `--HTML_TAG_END -> HTML_TAG_END
         |--TAG_OPEN -> <
         |--TAG_SLASH -> /
         |--TAG_NAME -> a
         `--TAG_CLOSE -> >
 

See Also:

• HTML_ELEMENT
• Constant Field Values

HTML_ATTRIBUTE

public static final int HTML_ATTRIBUTE

Single HTML attribute.

See Also:

• Constant Field Values

HTML_ATTRIBUTES

public static final int HTML_ATTRIBUTES

List of HTML attributes.

See Also:

• Constant Field Values

HTML_TAG_START

public static final int HTML_TAG_START

Start of an HTML tag (the opening tag node).

This node represents the opening part of an HTML element and contains the opening delimiter, tag name, optional attributes, and the closing delimiter of the opening tag.

Example:

* <a href="https://example.com">link</a>

Tree:

 |--LEADING_ASTERISK -> *
 `--HTML_ELEMENT -> HTML_ELEMENT
     `--HTML_TAG_START -> HTML_TAG_START
         |--TAG_OPEN -> <
         |--TAG_NAME -> a
         |--HTML_ATTRIBUTES -> HTML_ATTRIBUTES
         |   `--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
         |       |--TEXT ->
         |       |--TAG_ATTR_NAME -> href
         |       |--EQUALS -> =
         |       `--ATTRIBUTE_VALUE -> "https://example.com"
         `--TAG_CLOSE -> >
 

See Also:

• HTML_ELEMENT
• Constant Field Values

HTML_TAG_END

public static final int HTML_TAG_END

End of an HTML tag (the closing tag node).

This node represents the closing part of an HTML element and contains the closing delimiter, optional slash, and the tag name.

Example:

* <a href="https://example.com">link</a>

Tree:

 |--LEADING_ASTERISK -> *
 `--HTML_ELEMENT -> HTML_ELEMENT
     |--HTML_TAG_START -> HTML_TAG_START
     |   |--TAG_OPEN -> <
     |   |--TAG_NAME -> a
     |   |--HTML_ATTRIBUTES -> HTML_ATTRIBUTES
     |   |   `--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
     |   |       |--TEXT ->   (whitespace)
     |   |       |--TAG_ATTR_NAME -> href
     |   |       |--EQUALS -> =
     |   |       `--ATTRIBUTE_VALUE -> "https://example.com"
     |   `--TAG_CLOSE -> >
     |--HTML_CONTENT -> HTML_CONTENT
     |   `--TEXT -> link
     `--HTML_TAG_END -> HTML_TAG_END
         |--TAG_OPEN -> <
         |--TAG_SLASH -> /
         |--TAG_NAME -> a
         `--TAG_CLOSE -> >
 

See Also:

• HTML_ELEMENT
• Constant Field Values

TAG_OPEN

public static final int TAG_OPEN

Opening tag delimiter < .

See Also:

• Constant Field Values

TAG_NAME

public static final int TAG_NAME

HTML tag name.

See Also:

• Constant Field Values

TAG_CLOSE

public static final int TAG_CLOSE

Closing tag delimiter > .

See Also:

• Constant Field Values

TAG_SLASH_CLOSE

public static final int TAG_SLASH_CLOSE

/> Self-closing tag delimiter.

Used for void HTML elements.

Example:

* <br />

Tree:

 VOID_ELEMENT -> VOID_ELEMENT
 |--TAG_OPEN -> <
 |--TAG_NAME -> br
 `--TAG_SLASH_CLOSE -> />
 

See Also:

• HTML_ELEMENT
• Constant Field Values

TAG_SLASH

public static final int TAG_SLASH

Slash symbol inside a closing tag.

See Also:

• Constant Field Values

TAG_ATTR_NAME

public static final int TAG_ATTR_NAME

Attribute name inside an HTML tag.

See Also:

• Constant Field Values

HTML_COMMENT

public static final int HTML_COMMENT

Start of an HTML comment node.

This node represents a full HTML comment inside Javadoc.

This node has three children:

1. HTML_COMMENT_START
2. HTML_COMMENT_CONTENT
3. HTML_COMMENT_END

Example:

* <!-- Hello World! -->

Tree:

 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--TEXT -> /**
 |--NEWLINE -> \r\n
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 |--HTML_COMMENT -> HTML_COMMENT
     |--HTML_COMMENT_START -> <!--
     |--HTML_COMMENT_CONTENT -> HTML_COMMENT_CONTENT
     |   `--TEXT ->  Hello World!
     `--HTML_COMMENT_END -> -->
 |--NEWLINE -> \r\n
 |--LEADING_ASTERISK ->  *
 |--TEXT -> /
 

See Also:

• HTML_COMMENT
• Constant Field Values

HTML_COMMENT_START

public static final int HTML_COMMENT_START

Opening part of an HTML comment.

See Also:

• Constant Field Values

HTML_COMMENT_END

public static final int HTML_COMMENT_END

Closing part of an HTML comment.

This node represents the closing delimiter of an HTML comment in Javadoc (for example -->).

Example:

* <!-- hidden comment -->

Tree:

 |--LEADING_ASTERISK -> *
 |--TEXT ->
 |--HTML_COMMENT -> HTML_COMMENT
 |   |--HTML_COMMENT_START -> <!--
 |   |--HTML_COMMENT_CONTENT -> HTML_COMMENT_CONTENT
 |   |   `--TEXT ->  hidden comment
 |   `--HTML_COMMENT_END -> -->
 

See Also:

• HTML_COMMENT
• Constant Field Values

HTML_COMMENT_CONTENT

public static final int HTML_COMMENT_CONTENT

Content inside an HTML comment.

See Also:

• Constant Field Values

Constructor Details

JavadocCommentsTokenTypes

private JavadocCommentsTokenTypes()

Empty private constructor of the current class.