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:

  • 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
    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 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 in a Javadoc.
    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 within Javadoc.
    static final int
    HIDDEN_BLOCK_TAG
    @hidden Javadoc block tag.
    static final int
    HTML_ATTRIBUTE
    HTML_ATTRIBUTE Single HTML attribute.
    static final int
    HTML_ATTRIBUTES
    HTML_ATTRIBUTES represents a collection of HTML attributes inside an HTML tag.
    static final int
    HTML_COMMENT
    Start of an HTML comment node.
    static final int
    HTML_COMMENT_CONTENT
    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
    HTML_COMMENT_START represents the beginning of an HTML comment, i.e., the "<!--" sequence inside a Javadoc comment.
    static final int
    HTML_CONTENT
    Content inside an HTML element.
    static final int
    HTML_ELEMENT
    General HTML element in a Javadoc comment.
    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 ( used in references within Javadoc.
    static final int
    LT
    Less-than symbol < .
    static final int
    MEMBER_REFERENCE
    MEMBER_REFERENCE Member reference (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 in a Javadoc @param block tag.
    static final int
    PARAMETER_TYPE
    PARAMETER_TYPE Parameter type reference.
    static final int
    PARAMETER_TYPE_LIST
    PARAMETER_TYPE_LIST represents the list of parameter types inside a member reference within a Javadoc inline @link tag.
    static final int
    PROVIDES_BLOCK_TAG
    @provides block tag.
    static final int
    QUESTION
    Question mark symbol ? used in generic type wildcards.
    static final int
    REFERENCE
    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 ( used in references within Javadoc.
    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 / used in module or package references within Javadoc.
    static final int
    SNIPPET_ATTR_NAME
    Attribute name in a @snippet tag.
    static final int
    SNIPPET_ATTRIBUTE
    Single attribute in a @snippet tag.
    static final int
    SNIPPET_ATTRIBUTES
    Collection of attributes in a @snippet tag.
    static final int
    SNIPPET_BODY
    Body content of a @snippet tag.
    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
    SUPER represents the super keyword inside a generic wildcard bound (e.g., ? super Number).
    static final int
    SYSTEM_PROPERTY_INLINE_TAG
    {@systemProperty} inline tag.
    static final int
    TAG_ATTR_NAME
    TAG_ATTR_NAME represents the name of an attribute inside an HTML element within a Javadoc comment.
    static final int
    TAG_CLOSE
    TAG_CLOSE represents the closing ">" symbol of an HTML tag.
    static final int
    TAG_NAME
    TAG_NAME Name of an HTML element.
    static final int
    TAG_OPEN
    Represents the opening "<" symbol of an HTML start tag.
    static final int
    TAG_SLASH
    TAG_SLASH represents the slash "/" used inside an HTML 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 Type arguments in generics.
    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:

    • LEADING_ASTERISK

      public static final int LEADING_ASTERISK
      Leading asterisk used to format Javadoc lines.

      Example:

      
 /**
  * This is a Javadoc line.
  * /

      Tree:

      
 --BLOCK_COMMENT_BEGIN -> /**
    |--COMMENT_CONTENT -> *\r\n * This is a Javadoc line.\r\n
    |   `--JAVADOC_CONTENT -> JAVADOC_CONTENT
    |       |--NEWLINE -> \r\n
    |       |--LEADING_ASTERISK ->  *
    |       |--TEXT ->  This is a Javadoc line.
    |       |--NEWLINE -> \r\n
    |       `--TEXT ->
 `   --BLOCK_COMMENT_END -> *
      See Also:

    • NEWLINE

      public static final int NEWLINE
      Newline character in a Javadoc comment.

      Example:

      
 /**
  * This is a Javadoc line.
  * /

      Tree:

      
 --BLOCK_COMMENT_BEGIN -> /**
    |--COMMENT_CONTENT -> *\r\n * This is a Javadoc line.\r\n
    |   `--JAVADOC_CONTENT -> JAVADOC_CONTENT
    |       |--NEWLINE -> \r\n
    |       |--LEADING_ASTERISK ->  *
    |       |--TEXT ->  This is a Javadoc line.
    |       |--NEWLINE -> \r\n
    |       `--TEXT ->
 `   --BLOCK_COMMENT_END -> *
      See Also:

    • TEXT

      public static final int TEXT
      Plain text content within a Javadoc comment.

      This node represents any plain text that appears in a Javadoc comment, including spaces and punctuation.

      Example:

      
 /**
  * This is plain text content.
  * /

      Tree:

      
 --BLOCK_COMMENT_BEGIN -> /**
    |--COMMENT_CONTENT -> *\r\n * This is plain text content.\r\n
    |   `--JAVADOC_CONTENT -> JAVADOC_CONTENT
    |       |--NEWLINE -> \r\n
    |       |--LEADING_ASTERISK ->  *
    |       |--TEXT ->  This is plain text content.
    |       |--NEWLINE -> \r\n
    |       `--TEXT ->
    `--BLOCK_COMMENT_END -> * /
      See Also:

    • JAVADOC_BLOCK_TAG

      public static final int JAVADOC_BLOCK_TAG
      General block tag (e.g. @param, @return).

      Such Javadoc tag can have these children:

      1. PARAM_BLOCK_TAG
      2. RETURN_BLOCK_TAG
      3. THROWS_BLOCK_TAG

      Example:

      * @param value The parameter of method.
      Tree: 
      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • AT_SIGN

      public static final int AT_SIGN
      At-sign @ that starts a block tag.

      Example:

      * @author name
      Tree: 
      
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--AUTHOR_BLOCK_TAG -> AUTHOR_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> author
         `--DESCRIPTION -> DESCRIPTION
             `--TEXT ->  name
      See Also:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--AUTHOR_BLOCK_TAG -> AUTHOR_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> author
         `--DESCRIPTION -> DESCRIPTION
             `--TEXT ->  name.
      See Also:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--DEPRECATED_BLOCK_TAG -> DEPRECATED_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> deprecated
         `--DESCRIPTION -> DESCRIPTION
             `--TEXT ->  deprecated text.
      See Also:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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

      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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--SINCE_BLOCK_TAG -> SINCE_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> since
         `--DESCRIPTION -> DESCRIPTION
             `--TEXT ->  1.0
      See Also:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--VERSION_BLOCK_TAG -> VERSION_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> version
         `--DESCRIPTION -> DESCRIPTION
             `--TEXT ->  value
      See Also:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--HIDDEN_BLOCK_TAG -> HIDDEN_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> hidden
         `--DESCRIPTION -> DESCRIPTION
             `--TEXT ->  value
      See Also:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--SERIAL_BLOCK_TAG -> SERIAL_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> serial
         `--DESCRIPTION -> DESCRIPTION
             `--TEXT ->  include
      See Also:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • 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_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--CUSTOM_BLOCK_TAG -> CUSTOM_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> mycustomtag
         `--DESCRIPTION -> DESCRIPTION
             `--TEXT ->  This is a custom block tag.
      See Also:

    • JAVADOC_INLINE_TAG

      public static final int JAVADOC_INLINE_TAG
      General inline tag (e.g. @link).

      Such Javadoc tag can have these children:

      1. CODE_INLINE_TAG
      2. LINK_INLINE_TAG
      3. VALUE_INLINE_TAG

      Example:

      
 /**
 * {@code code}
 &#42;/
      Tree: 
      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--TEXT -> /**
 |--NEWLINE -> \n
 |--LEADING_ASTERISK ->   *
 |--TEXT ->
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 |   `--CODE_INLINE_TAG -> CODE_INLINE_TAG
 |       |--JAVADOC_INLINE_TAG_START -> { @
 |       |--TAG_NAME -> code
 |       |--TEXT ->   code
 |       `--JAVADOC_INLINE_TAG_END -> }
 |--NEWLINE -> \n
 |--LEADING_ASTERISK ->   *
 |--TEXT -> /
 |--NEWLINE -> \n
 |--TEXT -> public class Test {}
 `--NEWLINE -> \n
      See Also:

    • JAVADOC_INLINE_TAG_START

      public static final int JAVADOC_INLINE_TAG_START
      Start of an inline tag {.

      This node represents the start of a Javadoc inline tag like @code or @link.

      Example:

      
 /**
 * {@code code}
 &#42;/
      Tree: 
      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--TEXT -> /**
 |--NEWLINE -> \n
 |--LEADING_ASTERISK ->   *
 |--TEXT ->
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 |   `--CODE_INLINE_TAG -> CODE_INLINE_TAG
 |       |--JAVADOC_INLINE_TAG_START -> { @
 |       |--TAG_NAME -> code
 |       |--TEXT ->   code
 |       `--JAVADOC_INLINE_TAG_END -> }
 |--NEWLINE -> \n
 |--LEADING_ASTERISK ->   *
 |--TEXT -> /
 |--NEWLINE -> \n
 |--TEXT -> public class Test {}
 `--NEWLINE -> \n
      See Also:

    • JAVADOC_INLINE_TAG_END

      public static final int JAVADOC_INLINE_TAG_END
      End of an inline tag }.

      This node represents the closing brace of a Javadoc inline tag like @code or @link.

      Example:

      
 /**
 * {@code code}
 &#42;/
      Tree: 
      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--TEXT -> /**
 |--NEWLINE -> \n
 |--LEADING_ASTERISK ->   *
 |--TEXT ->
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 |   `--CODE_INLINE_TAG -> CODE_INLINE_TAG
 |       |--JAVADOC_INLINE_TAG_START -> { @
 |       |--TAG_NAME -> code
 |       |--TEXT ->   code
 |       `--JAVADOC_INLINE_TAG_END -> }
 |--NEWLINE -> \n
 |--LEADING_ASTERISK ->   *
 |--TEXT -> /
 |--NEWLINE -> \n
 |--TEXT -> public class Test {}
 `--NEWLINE -> \n
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • INHERIT_DOC_INLINE_TAG

      public static final int INHERIT_DOC_INLINE_TAG
      {@inheritDoc} inline tag.

      This node models the inline {@inheritDoc} tag that instructs Javadoc to inherit documentation from the corresponding element in a parent class or interface.

      Example:

      * {@inheritDoc}
      Tree: 
      
 |--LEADING_ASTERISK ->      *
 |--TEXT ->
 `--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--INHERIT_DOC_INLINE_TAG -> INHERIT_DOC_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> { @
         |--TAG_NAME -> inheritDoc
         `--JAVADOC_INLINE_TAG_END -> }
      See Also:

    • SYSTEM_PROPERTY_INLINE_TAG

      public static final int SYSTEM_PROPERTY_INLINE_TAG
      {@systemProperty} inline tag.

      Such Javadoc tag is used to reference a system property.

      Example:

      * This method uses {@systemProperty user.home} system property.
      Tree: 
      
 |--LEADING_ASTERISK ->      *
 |--TEXT ->  This method uses
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 |   `--SYSTEM_PROPERTY_INLINE_TAG -> SYSTEM_PROPERTY_INLINE_TAG
 |       |--JAVADOC_INLINE_TAG_START -> { @
 |       |--TAG_NAME -> systemProperty
 |       |--TEXT ->
 |       |--IDENTIFIER -> user.home
 |       `--JAVADOC_INLINE_TAG_END -> }
 |--TEXT ->  system property.
      See Also:

    • LITERAL_INLINE_TAG

      public static final int LITERAL_INLINE_TAG
      {@literal} inline tag.

      Example:

      * {@literal @Override}
      Tree: 
      
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--LITERAL_INLINE_TAG -> LITERAL_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> { @
         |--TAG_NAME -> literal
         |--TEXT ->  @Override
         `--JAVADOC_INLINE_TAG_END -> }
      See Also:

    • 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:

    • 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:

    • 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:

    • CUSTOM_INLINE_TAG

      public static final int CUSTOM_INLINE_TAG
      @custom inline tag.

      Example:

      * Example showing {@custom This is a Custom Inline Tag}.

      Tree:

      
 |--LEADING_ASTERISK ->      *
 |--TEXT ->  Example showing
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 |   `--CUSTOM_INLINE_TAG -> CUSTOM_INLINE_TAG
 |       |--JAVADOC_INLINE_TAG_START -> { @
 |       |--TAG_NAME -> custom
 |       |--DESCRIPTION -> DESCRIPTION
 |       |   `--TEXT ->  This is a Custom Inline Tag
 |       `--JAVADOC_INLINE_TAG_END -> }
 |--TEXT -> .
      See Also:

    • IDENTIFIER

      public static final int IDENTIFIER
      Identifier token.

      Example:

      * @throws Exception if error.

      Tree:

      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--THROWS_BLOCK_TAG -> THROWS_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> throws
         |--TEXT ->
         |--IDENTIFIER -> Exception
         `--DESCRIPTION -> DESCRIPTION
             `--TEXT ->  if error.
      See Also:

    • HASH

      public static final int HASH
      Hash symbol # used in references within Javadoc.

      Example:

      * @see MyClass#myMethod()
      Tree: 
      
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 |--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 |   `--SEE_BLOCK_TAG -> SEE_BLOCK_TAG
 |       |--AT_SIGN -> @
 |       |--TAG_NAME -> see
 |       |--TEXT ->
 |       `--REFERENCE -> REFERENCE
 |           |--IDENTIFIER -> MyClass
 |           |--HASH -> #
 |           |--IDENTIFIER -> myMethod
 |           |--LPAREN -> (
 |           `--RPAREN -> )
      See Also:

    • LPAREN

      public static final int LPAREN
      Left parenthesis ( used in references within Javadoc.

      Example:

      
 * &#123;@link String#length()
 }
      Tree: 
      
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--LINK_INLINE_TAG -> LINK_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> &#123;@
         |--TAG_NAME -> link
         |--TEXT ->
         |--REFERENCE -> REFERENCE
             |--IDENTIFIER -> String
             |--HASH -> #
             `--MEMBER_REFERENCE -> MEMBER_REFERENCE
                 |--IDENTIFIER -> length
                 |--LPAREN -> (
                 `--RPAREN -> )
         `--JAVADOC_INLINE_TAG_END -> 
 }
      See Also:

    • RPAREN

      public static final int RPAREN
      Right parenthesis ( used in references within Javadoc.

      Example:

      
 * &#123;@link String#length()
 }
      Tree: 
      
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--LINK_INLINE_TAG -> LINK_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> &#123;@
         |--TAG_NAME -> link
         |--TEXT ->
         |--REFERENCE -> REFERENCE
             |--IDENTIFIER -> String
             |--HASH -> #
             `--MEMBER_REFERENCE -> MEMBER_REFERENCE
                 |--IDENTIFIER -> length
                 |--LPAREN -> (
                 `--RPAREN -> )
         `--JAVADOC_INLINE_TAG_END -> 
 }
      See Also:

    • COMMA

      public static final int COMMA
      Comma symbol , .

      Example:

      * @see #method(int, int)

      Tree:

      
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
     `--SEE_BLOCK_TAG -> SEE_BLOCK_TAG
         |--AT_SIGN -> @
         |--TAG_NAME -> see
         |--TEXT ->
         |--REFERENCE -> REFERENCE
         |   |--HASH -> #
         |   `--MEMBER_REFERENCE -> MEMBER_REFERENCE
         |       |--IDENTIFIER -> method
         |       |--LPAREN -> (
         |       |--PARAMETER_TYPE_LIST -> PARAMETER_TYPE_LIST
         |       |   |--PARAMETER_TYPE -> int
         |       |   |--COMMA -> ,
         |       |   |--TEXT ->
         |       |   `--PARAMETER_TYPE -> int
         |       `--RPAREN -> )
      See Also:

    • SLASH

      public static final int SLASH
      Slash symbol / used in module or package references within Javadoc.

      Example:

      
 &#123;@link java.base/java.lang.String&#125;
      Tree: 
      
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--LINK_INLINE_TAG -> LINK_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> &#123;@
         |--TAG_NAME -> link
         |--TEXT ->
         |--REFERENCE -> REFERENCE
         |   |--IDENTIFIER -> java.base
         |   |--SLASH -> /
         |   `--IDENTIFIER -> java.lang.String
         `--JAVADOC_INLINE_TAG_END -> 
 }
      See Also:

    • QUESTION

      public static final int QUESTION
      Question mark symbol ? used in generic type wildcards.

      This token appears in references that use wildcard type arguments, such as ? extends Type or ? super Type.

      Example:

      
 &#123;@link java.util.List&lt;? extends Number&gt;&#125;
      Tree: 
      
 |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     `--LINK_INLINE_TAG -> LINK_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START -> &#123;@
         |--TAG_NAME -> link
         |--TEXT ->
         |--REFERENCE -> REFERENCE
         |   `--TYPE_ARGUMENTS -> TYPE_ARGUMENTS
         |       |--LT -> <
         |       |--TYPE_ARGUMENT -> TYPE_ARGUMENT
         |       |   |--QUESTION -> ?
         |       |   |--TEXT ->
         |       |   |--EXTENDS -> extends
         |       |   |--TEXT ->
         |       |   `--IDENTIFIER -> Number
         |       `--GT -> >
         `--JAVADOC_INLINE_TAG_END -> 
 }
      See Also:

    • LT

      public static final int LT
      Less-than symbol < .

      Example:

      * @see List<String>
      Tree: 
      
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 |--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 |   `--SEE_BLOCK_TAG -> SEE_BLOCK_TAG
 |       |--AT_SIGN -> @
 |       |--TAG_NAME -> see
 |       |--TEXT ->
 |       `--REFERENCE -> REFERENCE
 |           |--IDENTIFIER -> List
 |           `--TYPE_ARGUMENTS -> TYPE_ARGUMENTS
 |               |--LT -> <
 |               |--TYPE_ARGUMENT -> TYPE_ARGUMENT
 |               |   `--IDENTIFIER -> String
 |               `--GT -> >
 |--NEWLINE -> \n
 `--TEXT ->
      See Also:

    • GT

      public static final int GT
      Greater-than symbol > .

      Example:

      * @see List<String>
      Tree: 
      
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 |--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 |   `--SEE_BLOCK_TAG -> SEE_BLOCK_TAG
 |       |--AT_SIGN -> @
 |       |--TAG_NAME -> see
 |       |--TEXT ->
 |       `--REFERENCE -> REFERENCE
 |           |--IDENTIFIER -> List
 |           `--TYPE_ARGUMENTS -> TYPE_ARGUMENTS
 |               |--LT -> <
 |               |--TYPE_ARGUMENT -> TYPE_ARGUMENT
 |               |   `--IDENTIFIER -> String
 |               `--GT -> >
 |--NEWLINE -> \n
 `--Text ->
      See Also:

    • 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&lt;? extends Number&gt; 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:

    • SUPER

      public static final int SUPER
      SUPER represents the super keyword inside a generic wildcard bound (e.g., ? super Number).

      Example: {@link java.util.List <? super Integer> list} of any supertype of Integer

      Tree:

      
 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 ->
     |       |   |--SUPER -> super
     |       |   |--TEXT ->
     |       |   `--IDENTIFIER -> Integer
     |       `--GT -> >
     |--DESCRIPTION -> DESCRIPTION
     |   `--TEXT ->  list of any supertype of Integer
     `--JAVADOC_INLINE_TAG_END -> }
      See Also:

    • PARAMETER_TYPE

      public static final int PARAMETER_TYPE
      PARAMETER_TYPE Parameter type reference.

      Represents a type used in a method parameter.

      Example:

      {@link java.util.List#add(Object)}
      Tree: 
      
 JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 `--LINK_INLINE_TAG -> LINK_INLINE_TAG
     |--JAVADOC_INLINE_TAG_START -> &#123;@
     |--TAG_NAME -> link
     |--REFERENCE -> REFERENCE
     |   |--IDENTIFIER -> List
     |   |--HASH -> #
     |   `--MEMBER_REFERENCE -> MEMBER_REFERENCE
     |       |--IDENTIFIER -> add
     |       |--LPAREN -> (
     |       |--PARAMETER_TYPE_LIST -> PARAMETER_TYPE_LIST
     |       |   `--PARAMETER_TYPE -> Object
     |       `--RPAREN -> )
     `--JAVADOC_INLINE_TAG_END -> 
 }
      See Also:

    • REFERENCE

      public static final int REFERENCE
      REFERENCE General reference within Javadoc.

      Represents the target of an inline reference tag such as {@link String#length()}.

      Example:

      
 {@link String#length()}
      Tree: 
      
 JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 |--LINK_INLINE_TAG -> LINK_INLINE_TAG
 |   |--JAVADOC_INLINE_TAG_START -> &#123;@
 |   |--TAG_NAME -> link
 |   `--REFERENCE -> String#length()
      See Also:

    • MEMBER_REFERENCE

      public static final int MEMBER_REFERENCE
      MEMBER_REFERENCE Member reference (method or field).

      Represents a field or method in a type reference.

      Example:

      
 {@link String#length()}

      Tree:

      
 JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 `--LINK_INLINE_TAG -> LINK_INLINE_TAG
     |--JAVADOC_INLINE_TAG_START -> &#123;@
     |--TAG_NAME -> link
     |--TEXT ->
     |--REFERENCE -> REFERENCE
     |   |--IDENTIFIER -> String
     |   |--HASH -> #
     |   `--MEMBER_REFERENCE -> MEMBER_REFERENCE
     |       |--IDENTIFIER -> length
     |       |--LPAREN -> (
     |       `--RPAREN -> )
     `--JAVADOC_INLINE_TAG_END -> 
 }
      See Also:

    • PARAMETER_TYPE_LIST

      public static final int PARAMETER_TYPE_LIST
      PARAMETER_TYPE_LIST represents the list of parameter types inside a member reference within a Javadoc inline @link tag.

      Example:

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

      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 -> )
     `--JAVADOC_INLINE_TAG_END -> }
      See Also:

    • TYPE_ARGUMENTS

      public static final int TYPE_ARGUMENTS
      TYPE_ARGUMENTS Type arguments in generics.

      Represents the type arguments inside a generic type reference.

      Example:

      {@link java.util.List<String>}

      Tree:

      
 JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 `--LINK_INLINE_TAG -> LINK_INLINE_TAG
     |--JAVADOC_INLINE_TAG_START -> &#123;@
     |--TAG_NAME -> link
     |--TEXT ->
     |--REFERENCE -> REFERENCE
     |   |--IDENTIFIER -> java.util.List
     |   `--TYPE_ARGUMENTS -> TYPE_ARGUMENTS
     |       |--LT -> <
     |       |--TYPE_ARGUMENT -> TYPE_ARGUMENT
     |       |   `--IDENTIFIER -> String
     |       `--GT -> >
     `--JAVADOC_INLINE_TAG_END -> 
 }
      See Also:

    • TYPE_ARGUMENT

      public static final int TYPE_ARGUMENT
      Single type argument in generics.

      This node represents one individual type inside a generic type argument list.

      Example:

      
 {@link java.util.List<String>}

      Tree:

      
 JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 `--LINK_INLINE_TAG -> LINK_INLINE_TAG
     |--JAVADOC_INLINE_TAG_START -> &#123;@
     |--TAG_NAME -> link
     |--TEXT ->
     |--REFERENCE -> REFERENCE
         |--IDENTIFIER -> java.util.List
         `--TYPE_ARGUMENTS -> TYPE_ARGUMENTS
             |--LT -> <
             |--TYPE_ARGUMENT -> TYPE_ARGUMENT
             |   `--IDENTIFIER -> String
             `--GT -> >
     `--JAVADOC_INLINE_TAG_END -> 
 }
      See Also:

    • DESCRIPTION

      public static final int DESCRIPTION
      Description part of a Javadoc tag.
      See Also:

    • FORMAT_SPECIFIER

      public static final int FORMAT_SPECIFIER
      Format specifier inside Javadoc content.
      See Also:

    • SNIPPET_ATTR_NAME

      public static final int SNIPPET_ATTR_NAME
      Attribute name in a @snippet tag.

      Note: In the current Checkstyle AST, all snippet attributes (such as lang=java) appear as plain text under the DESCRIPTION node. There is no SNIPPET_ATTR_NAME node in the AST tree. All attribute content is represented as TEXT.

      Example: 

      * @snippet lang=java

      Tree: 

      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
    `--CUSTOM_BLOCK_TAG -> CUSTOM_BLOCK_TAG
        |--AT_SIGN -> @
        |--TAG_NAME -> snippet
        `--DESCRIPTION -> DESCRIPTION
            `--TEXT ->  lang=java
      See Also:

    • EQUALS

      public static final int EQUALS
      Equals sign =.

      Used within snippet attributes to assign values.

      Example:

      
 &#123;@snippet lang="java" :
   int x = 1;
 
 }

      Tree:

      
 JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
 `--SNIPPET_INLINE_TAG -> SNIPPET_INLINE_TAG
     |--JAVADOC_INLINE_TAG_START -> &#123;@
     |--SNIPPET_ATTRIBUTES -> SNIPPET_ATTRIBUTES
     |   `--SNIPPET_ATTRIBUTE -> SNIPPET_ATTRIBUTE
     |       |--TEXT ->
     |       |--SNIPPET_ATTR_NAME -> lang
     |       |--EQUALS -> =
     |       `--ATTRIBUTE_VALUE -> "java"
     |--COLON -> :
     |--SNIPPET_BODY -> SNIPPET_BODY
     |   |--NEWLINE -> \n
     |   |--TEXT ->   int x = 1;
     |   |--NEWLINE -> \r\n
     `--JAVADOC_INLINE_TAG_END -> 
 }
      See Also:

    • ATTRIBUTE_VALUE

      public static final int ATTRIBUTE_VALUE
      ATTRIBUTE_VALUE Value assigned to an attribute.

      Example:

      <a href="example">text</a>

      Tree:

      
 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 -> "example"
 |   `--TAG_CLOSE -> >
 |--HTML_CONTENT -> HTML_CONTENT
 |   `--TEXT -> text
 `--HTML_TAG_END -> HTML_TAG_END
 |--TAG_OPEN -> <
 |--TAG_SLASH -> /
 |--TAG_NAME -> a
 `--TAG_CLOSE -> >
      See Also:

    • COLON

      public static final int COLON
      Colon symbol : .
      See Also:

    • INDEX_TERM

      public static final int INDEX_TERM
      Term used in {@index} tag.

      This node represents the term inside an inline {@index ...} tag in Javadoc.

      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:

    • SNIPPET_ATTRIBUTE

      public static final int SNIPPET_ATTRIBUTE
      Single attribute in a @snippet tag.

      Represents a single attribute (e.g., lang=java) in a @snippet tag.

      Note: In the current Checkstyle AST, all snippet attributes appear as plain text under the DESCRIPTION node, not as a separate SNIPPET_ATTRIBUTE node.

      Example:

      * @snippet lang=java

      Tree:

      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
    `--CUSTOM_BLOCK_TAG -> CUSTOM_BLOCK_TAG
        |--AT_SIGN -> @
        |--TAG_NAME -> snippet
        `--DESCRIPTION -> DESCRIPTION
            `--TEXT ->  lang=java
      See Also:

    • SNIPPET_ATTRIBUTES

      public static final int SNIPPET_ATTRIBUTES
      Collection of attributes in a @snippet tag.

      Represents all attributes (e.g., lang=java region=main) in a @snippet tag.

      Note: In the current Checkstyle AST, all snippet attributes appear as plain text under the DESCRIPTION node, not as a separate SNIPPET_ATTRIBUTES node.

      Example:

      * @snippet lang=java region=main

      Tree:

      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
    `--CUSTOM_BLOCK_TAG -> CUSTOM_BLOCK_TAG
        |--AT_SIGN -> @
        |--TAG_NAME -> snippet
        `--DESCRIPTION -> DESCRIPTION
            `--TEXT ->  lang=java region=main
      See Also:

    • SNIPPET_BODY

      public static final int SNIPPET_BODY
      Body content of a @snippet tag.

      Represents the code or text content inside a @snippet tag in Javadoc.

      Example: 
      * @snippet lang=java * System.out.println("hello");
      Tree: 
      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
    `--CUSTOM_BLOCK_TAG -> CUSTOM_BLOCK_TAG
        |--AT_SIGN -> @
        |--TAG_NAME -> snippet
        `--DESCRIPTION -> DESCRIPTION
            |--TEXT ->  lang=java
            |--NEWLINE -> \n
            |--LEADING_ASTERISK ->  *
            `--TEXT -> System.out.println("hello");
      See Also:

    • FIELD_TYPE

      public static final int FIELD_TYPE
      Field type reference in a Javadoc.

      Example:

       /**
 * @serialField counter int The counter.
 */
      Tree: 
       JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--TEXT -> /**
 |--NEWLINE -> \n
 |--LEADING_ASTERISK ->  *
 |--TEXT ->
 `--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--SERIAL_FIELD_BLOCK_TAG -> SERIAL_FIELD_BLOCK_TAG
 |--AT_SIGN -> @
 |--TAG_NAME -> serialField
 |--TEXT ->
 |--IDENTIFIER -> counter
 |--TEXT ->
 |--FIELD_TYPE -> int
 `--DESCRIPTION -> DESCRIPTION
 |--TEXT ->  The counter.
 |--NEWLINE -> \n
 |--LEADING_ASTERISK ->  *
 `--TEXT -> /
      See Also:

    • PARAMETER_NAME

      public static final int PARAMETER_NAME
      Parameter name reference in a Javadoc @param block tag.

      Example:

      * @param value The parameter of method.
      Tree: 
      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK -> *
 |--TEXT ->
 `--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:

    • STRING_LITERAL

      public static final int STRING_LITERAL
      String literal inside Javadoc.

      Example in Javadoc:

      
 {@see "foo"}

      Tree:

      
 JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
 `--SEE_BLOCK_TAG -> SEE_BLOCK_TAG
     |--AT_SIGN -> @
     |--TAG_NAME -> see
     |--TEXT ->
     `--STRING_LITERAL -> "foo"
      See Also:

    • HTML_ELEMENT

      public static final int HTML_ELEMENT
      General HTML element in a Javadoc comment.

      Example:

      
 /**
  * <p>Hello</p>
  &#42;/
      Tree: 
      
 JAVADOC_CONTENT -> JAVADOC_CONTENT
 |--LEADING_ASTERISK ->      *
 |--TEXT ->
 |--HTML_ELEMENT -> HTML_ELEMENT
 |   |--HTML_TAG_START -> HTML_TAG_START
 |   |   |--TAG_OPEN -> <
 |   |   |--TAG_NAME -> p
 |   |   `--TAG_CLOSE -> >
 |   |--HTML_CONTENT -> HTML_CONTENT
 |   |   `--TEXT -> Hello
 |   `--HTML_TAG_END -> HTML_TAG_END
 |       |--TAG_OPEN -> <
 |       |--TAG_SLASH -> /
 |       |--TAG_NAME -> p
 |       `--TAG_CLOSE -> >
 |--NEWLINE -> \n
 |--LEADING_ASTERISK ->      *
 |--TEXT -> /
      See Also:

    • VOID_ELEMENT

      public static final int VOID_ELEMENT
      Void HTML element (self-closing).

      Example in Javadoc:

       <br>

      Tree:

       HTML_ELEMENT -> HTML_ELEMENT
 `--VOID_ELEMENT -> VOID_ELEMENT
     `--HTML_TAG_START -> HTML_TAG_START
         |--TAG_OPEN -> <
         |--TAG_NAME -> br
         `--TAG_CLOSE -> >
      See Also:

    • 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_ATTRIBUTE

      public static final int HTML_ATTRIBUTE
      HTML_ATTRIBUTE Single HTML attribute.

      Represents one attribute inside an HTML tag.

      Example:

      
 <input type="text">
      Tree: 
      
 HTML_ELEMENT -> HTML_ELEMENT
 `--VOID_ELEMENT -> VOID_ELEMENT
     `--HTML_TAG_START -> HTML_TAG_START
         |--TAG_OPEN -> <
         |--TAG_NAME -> input
         |--HTML_ATTRIBUTES -> HTML_ATTRIBUTES
         |   `--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
         |       |--TEXT ->
         |       |--TAG_ATTR_NAME -> type
         |       |--EQUALS -> =
         |       `--ATTRIBUTE_VALUE -> "text"
         `--TAG_CLOSE -> >
      See Also:

    • HTML_ATTRIBUTES

      public static final int HTML_ATTRIBUTES
      HTML_ATTRIBUTES represents a collection of HTML attributes inside an HTML tag.

      Appears in Javadoc comments when documenting HTML elements that contain multiple attributes.

      Example:

      
 <div lang="en" custom-attr="value"></div>

      Tree:

      
 HTML_ELEMENT -> HTML_ELEMENT
 |--HTML_TAG_START -> HTML_TAG_START
 |   |--TAG_OPEN -> <
 |   |--TAG_NAME -> div
 |   |--HTML_ATTRIBUTES -> HTML_ATTRIBUTES
 |   |   |--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
 |   |   |   |--TEXT ->
 |   |   |   |--TAG_ATTR_NAME -> lang
 |   |   |   |--EQUALS -> =
 |   |   |   `--ATTRIBUTE_VALUE -> "en"
 |   |   `--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
 |   |       |--TEXT ->
 |   |       |--TAG_ATTR_NAME -> custom-attr
 |   |       |--EQUALS -> =
 |   |       `--ATTRIBUTE_VALUE -> "value"
 |   `--TAG_CLOSE -> >
      See Also:

    • 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_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:

    • TAG_OPEN

      public static final int TAG_OPEN
      Represents the opening "<" symbol of an HTML start tag.

      Example:

      
 <div class="container" lang="en"></div>
      Tree: 
      
 HTML_ELEMENT -> HTML_ELEMENT
 |--HTML_TAG_START -> HTML_TAG_START
 |   |--TAG_OPEN -> <
 |   |--TAG_NAME -> div
 |   |--HTML_ATTRIBUTES -> HTML_ATTRIBUTES
 |   |   |--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
 |   |   |   |--TAG_ATTR_NAME -> class
 |   |   |   |--EQUALS -> =
 |   |   |   `--ATTRIBUTE_VALUE -> "container"
 |   |   `--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
 |   |       |--TAG_ATTR_NAME -> lang
 |   |       |--EQUALS -> =
 |   |       `--ATTRIBUTE_VALUE -> "en"
 |   `--TAG_CLOSE -> >
 `--HTML_TAG_END -> HTML_TAG_END
     |--TAG_OPEN -> <
     |--TAG_SLASH -> /
     |--TAG_NAME -> div
     `--TAG_CLOSE -> >
      See Also:

    • TAG_NAME

      public static final int TAG_NAME
      TAG_NAME Name of an HTML element.

      Appears inside an HTML tag within Javadoc comments.

      Example:

      
 <div class="container">
     Content
 </div>
      Tree: 
      
 HTML_ELEMENT -> HTML_ELEMENT
 |--HTML_TAG_START -> HTML_TAG_START
 |   |--TAG_OPEN -> <
 |   |--TAG_NAME -> div
 |   |--HTML_ATTRIBUTES -> HTML_ATTRIBUTES
 |   |   `--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
 |   |       |--TAG_ATTR_NAME -> class
 |   |       |--EQUALS -> =
 |   |       `--ATTRIBUTE_VALUE -> "container"
 |   `--TAG_CLOSE -> >
 |--HTML_CONTENT -> HTML_CONTENT
 |   `--TEXT ->      Content
 `--HTML_TAG_END -> HTML_TAG_END
     |--TAG_OPEN -> <
     |--TAG_SLASH -> /
     |--TAG_NAME -> div
     `--TAG_CLOSE -> >

      Here TAG_NAME corresponds to "div".

      See Also:

    • TAG_CLOSE

      public static final int TAG_CLOSE
      TAG_CLOSE represents the closing ">" symbol of an HTML tag.

      Appears in Javadoc comments when documenting HTML elements.

      Example:

      
 <p>Some text</p>
      Tree: 
      
 HTML_ELEMENT -> HTML_ELEMENT
 |--HTML_TAG_START -> HTML_TAG_START
 |   |--TAG_OPEN -> <
 |   |--TAG_NAME -> p
 |   `--TAG_CLOSE -> >
 |--HTML_CONTENT -> HTML_CONTENT
 |   `--TEXT -> Some text
 `--HTML_TAG_END -> HTML_TAG_END
     |--TAG_OPEN -> <
     |--TAG_SLASH -> /
     |--TAG_NAME -> p
     `--TAG_CLOSE -> >
      See Also:

    • 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:

    • TAG_SLASH

      public static final int TAG_SLASH
      TAG_SLASH represents the slash "/" used inside an HTML closing tag.

      Appears in Javadoc comments when closing HTML elements.

      Example:

      
 <p>Paragraph text</p>
      Tree: 
      
 HTML_ELEMENT -> HTML_ELEMENT
 |--HTML_TAG_START -> HTML_TAG_START
 |   |--TAG_OPEN -> <
 |   |--TAG_NAME -> p
 |   `--TAG_CLOSE -> >
 |--HTML_CONTENT -> HTML_CONTENT
 |   `--TEXT -> Paragraph text
 `--HTML_TAG_END -> HTML_TAG_END
     |--TAG_OPEN -> <
     |--TAG_SLASH -> /
     |--TAG_NAME -> p
     `--TAG_CLOSE -> >
      See Also:

    • TAG_ATTR_NAME

      public static final int TAG_ATTR_NAME
      TAG_ATTR_NAME represents the name of an attribute inside an HTML element within a Javadoc comment.

      Example:

      
 <img src="logo.png" alt="Site logo">

      Tree:

      
 HTML_ELEMENT -> HTML_ELEMENT
 `--VOID_ELEMENT -> VOID_ELEMENT
     `--HTML_TAG_START -> HTML_TAG_START
         |--TAG_OPEN -> <
         |--TAG_NAME -> img
         |--HTML_ATTRIBUTES -> HTML_ATTRIBUTES
         |   |--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
         |   |   |--TEXT ->
         |   |   |--TAG_ATTR_NAME -> src
         |   |   |--EQUALS -> =
         |   |   `--ATTRIBUTE_VALUE -> "logo.png"
         |   `--HTML_ATTRIBUTE -> HTML_ATTRIBUTE
         |       |--TEXT ->
         |       |--TAG_ATTR_NAME -> alt
         |       |--EQUALS -> =
         |       `--ATTRIBUTE_VALUE -> "Site logo"
         `--TAG_CLOSE -> >
      See Also:

    • 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_START

      public static final int HTML_COMMENT_START
      HTML_COMMENT_START represents the beginning of an HTML comment, i.e., the "<!--" sequence inside a Javadoc comment.

      HTML comments occasionally appear in Javadoc to add internal notes or explanations without affecting the rendered output.

      Example: <!-- Note: This method is for demonstration purposes only. -->

      Tree:

      
 HTML_COMMENT -> HTML_COMMENT
 |--HTML_COMMENT_START -> <!--
 |--HTML_COMMENT_CONTENT -> HTML_COMMENT_CONTENT
 |   `--TEXT ->  Note: This method is for demonstration purposes only.
 `--HTML_COMMENT_END -> -->
      See Also:

    • 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_CONTENT

      public static final int HTML_COMMENT_CONTENT
      HTML_COMMENT_CONTENT Content inside an HTML comment.

      Text within an HTML comment.

      Example: <!-- This is a comment -->

      Tree:

      
 HTML_COMMENT -> HTML_COMMENT
 |--HTML_COMMENT_START -> <!--
 |--HTML_COMMENT_CONTENT -> HTML_COMMENT_CONTENT
 |   `--TEXT ->  This is a comment
 `--HTML_COMMENT_END -> -->
      See Also:

  • Constructor Details