JavadocTokenTypes

///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2025 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
///////////////////////////////////////////////////////////////////////////////////////////////

package com.puppycrawl.tools.checkstyle.api;

import com.puppycrawl.tools.checkstyle.grammar.javadoc.JavadocParser;

/**
 * Contains the constants for all the tokens contained in the Abstract
 * Syntax Tree for the javadoc grammar.
 *
 * @see <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html">
 * javadoc - The Java API Documentation Generator</a>
 */
public final class JavadocTokenTypes {

    // ------------------------------------------------------------------------------------------ //
    // -----------------        JAVADOC TAGS          ------------------------------------------- //
    // ------------------------------------------------------------------------------------------ //

    /**
     * '@return' literal in {@code @return} Javadoc tag.
     *
     * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @return true if file exists}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     * JAVADOC_TAG -> JAVADOC_TAG
     *  |--RETURN_LITERAL -> @return
     *  |--WS ->
     *  `--DESCRIPTION -> DESCRIPTION
     *      |--TEXT -> true if file exists
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCDBGG">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int RETURN_LITERAL = JavadocParser.RETURN_LITERAL;

    /**
     * '{@literal @}deprecated' literal in {@literal @}deprecated Javadoc tag.
     *
     * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @deprecated It is deprecated method}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     * JAVADOC_TAG -> JAVADOC_TAG
     *  |--DEPRECATED_LITERAL -> @deprecated
     *  |--WS ->
     *  `--DESCRIPTION -> DESCRIPTION
     *      |--TEXT -> It is deprecated method
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#deprecated">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int DEPRECATED_LITERAL = JavadocParser.DEPRECATED_LITERAL;

    /**
     * '@since' literal in {@code @since} Javadoc tag.
     *
     * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @since 3.4 RELEASE}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     * JAVADOC_TAG -> JAVADOC_TAG
     *  |--SINCE_LITERAL -> @since
     *  |--WS ->
     *  `--DESCRIPTION -> DESCRIPTION
     *      |--TEXT -> 3.4 RELEASE
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHGJGD">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int SINCE_LITERAL = JavadocParser.SINCE_LITERAL;

    /**
     * '@serialData' literal in {@code @serialData} Javadoc tag.
     *
     * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @serialData Two values of Integer type}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     * JAVADOC_TAG -> JAVADOC_TAG
     *  |--SERIAL_DATA_LITERAL -> @serialData
     *  |--WS ->
     *  `--DESCRIPTION -> DESCRIPTION
     *      |--TEXT -> Two values of Integer type
     * }
     * </pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDJBFDB">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int SERIAL_DATA_LITERAL = JavadocParser.SERIAL_DATA_LITERAL;

    /**
     * '@serialField' literal in {@code @serialField} Javadoc tag.
     *
     * <p>Such Javadoc tag can have three arguments:</p>
     * <ol>
     * <li>{@link #FIELD_NAME}</li>
     * <li>{@link #FIELD_TYPE}</li>
     * <li>{@link #DESCRIPTION}</li>
     * </ol>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @serialField counter Integer objects counter}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     * JAVADOC_TAG -> JAVADOC_TAG
     *  |--SERIAL_FIELD_LITERAL -> @serialField
     *  |--WS ->
     *  |--FIELD_NAME -> counter
     *  |--WS ->
     *  |--FIELD_TYPE -> Integer
     *  |--WS ->
     *  `--DESCRIPTION -> DESCRIPTION
     *      |--TEXT -> objects counter
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDGHIDG">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int SERIAL_FIELD_LITERAL = JavadocParser.SERIAL_FIELD_LITERAL;

    /**
     * '@param' literal in {@code @param} Javadoc tag.
     *
     * <p>Such Javadoc tag can have two arguments:</p>
     * <ol>
     * <li>{@link #PARAMETER_NAME}</li>
     * <li>{@link #DESCRIPTION}</li>
     * </ol>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @param value The parameter of method.}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     * JAVADOC_TAG -> JAVADOC_TAG
     *  |--PARAM_LITERAL -> @param
     *  |--WS ->
     *  |--PARAMETER_NAME -> value
     *  |--WS ->
     *  `--DESCRIPTION -> DESCRIPTION
     *      |--TEXT -> The parameter of method.
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHJECF">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int PARAM_LITERAL = JavadocParser.PARAM_LITERAL;

    /**
     * '@see' literal in {@code @see} Javadoc tag.
     *
     * <p>Such Javadoc tag can have one argument - {@link #REFERENCE}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @see org.apache.utils.Lists.Comparator#compare(Object)}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   JAVADOC_TAG -> JAVADOC_TAG
     *    |--SEE_LITERAL -> @see
     *    |--WS ->
     *    |--REFERENCE -> REFERENCE
     *        |--PACKAGE_CLASS -> org.apache.utils.Lists.Comparator
     *        |--HASH -> #
     *        |--MEMBER -> compare
     *        `--PARAMETERS -> PARAMETERS
     *            |--LEFT_BRACE -> (
     *            |--ARGUMENT -> Object
     *            `--RIGHT_BRACE -> )
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDDIEDI">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int SEE_LITERAL = JavadocParser.SEE_LITERAL;

    /**
     * '@serial' literal in {@code @serial} Javadoc tag.
     *
     * <p>Such Javadoc tag can have one argument - {@link #REFERENCE} or {@link #LITERAL_EXCLUDE}
     * or {@link #LITERAL_INCLUDE}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @serial include}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   |--JAVADOC_TAG -> JAVADOC_TAG
     *       |--SERIAL_LITERAL -> @serial
     *       |--WS
     *       |--LITERAL_INCLUDE -> include
     * }</pre>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @serial serialized company name}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   |--JAVADOC_TAG-> JAVADOC_TAG
     *       |--SERIAL_LITERAL -> @serial
     *       |--WS
     *       |--DESCRIPTION -> DESCRIPTION
     *           |--TEXT -> serialized company name
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int SERIAL_LITERAL = JavadocParser.SERIAL_LITERAL;

    /**
     * '@version' literal in {@code @version} Javadoc tag.
     *
     * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @version 1.3}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   JAVADOC_TAG -> JAVADOC_TAG
     *    |--VERSION_LITERAL -> @version
     *    |--WS ->
     *    `--DESCRIPTION -> DESCRIPTION
     *        |--TEXT -> 1.3
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCHBAE">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int VERSION_LITERAL = JavadocParser.VERSION_LITERAL;

    /**
     * '@exception' literal in {@code @exception} Javadoc tag.
     *
     * <p>Such Javadoc tag can have two argument - {@link #CLASS_NAME} and {@link #DESCRIPTION}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @exception SQLException if query is not correct}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   JAVADOC_TAG -> JAVADOC_TAG
     *    |--EXCEPTION_LITERAL -> @exception
     *    |--WS ->
     *    |--CLASS_NAME -> SQLException
     *    |--WS ->
     *    `--DESCRIPTION -> DESCRIPTION
     *        `--TEXT -> if query is not correct
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCEAHH">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int EXCEPTION_LITERAL = JavadocParser.EXCEPTION_LITERAL;

    /**
     * '@throws' literal in {@code @throws} Javadoc tag.
     *
     * <p>Such Javadoc tag can have two argument - {@link #CLASS_NAME} and {@link #DESCRIPTION}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @throws SQLException if query is not correct}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   JAVADOC_TAG -&gt; JAVADOC_TAG
     *    |--THROWS_LITERAL -&gt; @throws
     *    |--WS -&gt;
     *    |--CLASS_NAME -&gt; SQLException
     *    |--WS -&gt;
     *    `--DESCRIPTION -&gt; DESCRIPTION
     *        `--TEXT -&gt; if query is not correct
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCHAHD">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int THROWS_LITERAL = JavadocParser.THROWS_LITERAL;

    /**
     * '@author' literal in {@code @author} Javadoc tag.
     *
     * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @author Baratali Izmailov}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   JAVADOC_TAG -> JAVADOC_TAG
     *      |--AUTHOR_LITERAL -> @author
     *      |--WS ->
     *      `--DESCRIPTION -> DESCRIPTION
     *          |--TEXT -> Baratali Izmailov
     *          |--NEWLINE -> \r\n
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCBAHA">
     * Oracle Docs</a>
     * @see #JAVADOC_TAG
     */
    public static final int AUTHOR_LITERAL = JavadocParser.AUTHOR_LITERAL;

    /**
     * Name of custom Javadoc tag (or Javadoc inline tag).
     *
     * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @myJavadocTag some magic}</pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   JAVADOC_TAG --> JAVADOC_TAG
     *       |--CUSTOM_NAME --> @myJavadocTag
     *       |--WS -->
     *       `--DESCRIPTION --> DESCRIPTION
     *           |--TEXT --> some magic
     * }</pre>
     */
    public static final int CUSTOM_NAME = JavadocParser.CUSTOM_NAME;

    /**
     * First child of {@link #JAVADOC_INLINE_TAG} that represents left curly brace '{'.
     *
     * <p><b>Example:</b></p>
     * <pre><code>{&#64;code Comparable&lt;E&gt;}</code></pre>
     * <b>Tree:</b>
     * <pre>
     * <code> JAVADOC_INLINE_TAG --&gt; JAVADOC_INLINE_TAG
     *         |--JAVADOC_INLINE_TAG_START --&gt; {
     *         |--CODE_LITERAL --&gt; @code
     *         |--WS --&gt;
     *         |--TEXT --&gt; Comparable&lt;E&gt;
     *         `--JAVADOC_INLINE_TAG_END --&gt; }
     * </code>
     * </pre>
     *
     * @noinspection HtmlTagCanBeJavadocTag
     * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
     *      replaced with Javadoc tag
     */
    public static final int JAVADOC_INLINE_TAG_START = JavadocParser.JAVADOC_INLINE_TAG_START;

    /**
     * Last child of {@link #JAVADOC_INLINE_TAG} that represents right curly brace '}'.
     *
     * <p><b>Example:</b></p>
     * <pre><code>{&#64;code Comparable&lt;E&gt;}</code></pre>
     * <b>Tree:</b>
     * <pre>
     * <code>JAVADOC_INLINE_TAG --&gt; JAVADOC_INLINE_TAG
     *        |--JAVADOC_INLINE_TAG_START --&gt; {
     *        |--CODE_LITERAL --&gt; @code
     *        |--WS --&gt;
     *        |--TEXT --&gt; Comparable&lt;E&gt;
     *        `--JAVADOC_INLINE_TAG_END --&gt; }
     *
     * </code>
     * </pre>
     *
     * @noinspection HtmlTagCanBeJavadocTag
     * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
     *      replaced with Javadoc tag
     */
    public static final int JAVADOC_INLINE_TAG_END = JavadocParser.JAVADOC_INLINE_TAG_END;

    /**
     * '@code' literal in {&#64;code} Javadoc inline tag.
     *
     * <p>Such Javadoc inline tag can have such child nodes:</p>
     * <ul>
     * <li>{@link #NEWLINE}</li>
     * <li>{@link #WS}</li>
     * <li>{@link #TEXT}</li>
     * </ul>
     *
     * <p><b>Example:</b></p>
     * <pre><code>{&#64;code Comparable&lt;E&gt;}</code></pre>
     * <b>Tree:</b>
     * <pre>
     * <code>JAVADOC_TAG -&gt; JAVADOC_TAG
     *        |--CUSTOM_NAME -&gt; @code
     *        |--WS -&gt;
     *        `--DESCRIPTION -&gt; DESCRIPTION
     *            |--TEXT -&gt; Comparable&lt;E&gt;
     * </code>
     * </pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDFHHBB">
     * Oracle Docs</a>
     * @see #JAVADOC_INLINE_TAG
     * @noinspection HtmlTagCanBeJavadocTag
     * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
     *      replaced with Javadoc tag
     */
    public static final int CODE_LITERAL = JavadocParser.CODE_LITERAL;

    /**
     * '@docRoot' literal in {&#64;docRoot} Javadoc inline tag.
     *
     * <p>Such Javadoc inline tag does not have any arguments and can have such child nodes:</p>
     * <ul>
     * <li>{@link #NEWLINE}</li>
     * <li>{@link #WS}</li>
     * </ul>
     *
     * <p><b>Example:</b></p>
     * <pre><code>{&#64;docRoot}</code></pre>
     * <b>Tree:</b>
     * <pre>
     * <code>
     * |--JAVADOC_INLINE_TAG -&gt; JAVADOC_INLINE_TAG
     *      |--JAVADOC_INLINE_TAG_START -&gt; {
     *      |--DOC_ROOT_LITERAL -&gt; @docRoot
     *      `--JAVADOC_INLINE_TAG_END -&gt; }
     * </code>
     * </pre>
     *
     * <pre><code>Example :{&#64;docRoot
     * } in a Javadoc comment.
     * </code></pre>
     * <b>Tree:</b>
     * <pre>
     * <code>
     *   |--JAVADOC_INLINE_TAG -&gt; JAVADOC_INLINE_TAG
     *     |--JAVADOC_INLINE_TAG_START -&gt; {
     *     |--DOC_ROOT_LITERAL -&gt; @docRoot
     *     |--NEWLINE -&gt; \r\n
     *     |--LEADING_ASTERISK -&gt;       *
     *     |--WS -&gt;
     *     `--JAVADOC_INLINE_TAG_END -&gt; }
     * </code>
     * </pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDBACBF">
     * Oracle Docs</a>
     * @see #JAVADOC_INLINE_TAG
     * @noinspection HtmlTagCanBeJavadocTag
     * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
     *      replaced with Javadoc tag
     */
    public static final int DOC_ROOT_LITERAL = JavadocParser.DOC_ROOT_LITERAL;

    /**
     * '@link' literal in {&#64;link} Javadoc inline tag.
     *
     * <p>Such Javadoc inline tag can have one argument - {@link #REFERENCE}</p>
     *
     * <p><b>Example:</b></p>
     *
     * <pre><code>{&#64;link org.apache.utils.Lists.Comparator#compare(Object)}</code></pre>
     *
     * <p><b>Tree:</b></p>
     *
     * <pre>
     * <code>
     *   JAVADOC_INLINE_TAG -&gt; JAVADOC_INLINE_TAG
     *    |--JAVADOC_INLINE_TAG_START -&gt; {
     *    |--LINK_LITERAL -&gt; @link
     *    |--WS -&gt;
     *    |--REFERENCE -&gt; REFERENCE
     *    |   |--PACKAGE_CLASS -&gt; org.apache.utils.Lists.Comparator
     *    |   |--HASH -&gt; #
     *    |   |--MEMBER -&gt; compare
     *    |   `--PARAMETERS -&gt; PARAMETERS
     *    |       |--LEFT_BRACE -&gt; (
     *    |       |--ARGUMENT -&gt; Object
     *    |       `--RIGHT_BRACE -&gt; )
     *    `--JAVADOC_INLINE_TAG_END -&gt; }
     * </code>
     * </pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDDIECH">
     * Oracle Docs</a>
     * @see #JAVADOC_INLINE_TAG
     * @noinspection HtmlTagCanBeJavadocTag
     * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
     *      replaced with Javadoc tag
     */
    public static final int LINK_LITERAL = JavadocParser.LINK_LITERAL;

    /**
     * '@inheritDoc' literal in {&#64;inheritDoc} Javadoc inline tag.
     *
     * <p>Such Javadoc inline tag does not have any arguments and can have such child nodes:</p>
     * <ul>
     * <li>{@link #NEWLINE}</li>
     * <li>{@link #WS}</li>
     * </ul>
     *
     * <p><b>Example:</b></p>
     * <pre><code>{&#64;inheritDoc}</code></pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     *    |--JAVADOC_INLINE_TAG_START -> {
     *    |--INHERIT_DOC_LITERAL -> @inheritDoc
     *    |--JAVADOC_INLINE_TAG_END -> }
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDGJCHC">
     * Oracle Docs</a>
     * @see #JAVADOC_INLINE_TAG
     * @noinspection HtmlTagCanBeJavadocTag
     * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
     *      replaced with Javadoc tag
     */
    public static final int INHERIT_DOC_LITERAL = JavadocParser.INHERIT_DOC_LITERAL;

    /**
     * '@linkplain' literal in {&#64;linkplain} Javadoc inline tag.
     *
     * <p>Such Javadoc inline tag can have one argument - {@link #REFERENCE}</p>
     *
     * <p><b>Example:</b></p>
     * <pre><code>{&#64;linkplain org.apache.utils.Lists.Comparator#compare(Object) compare}</code>
     * </pre>
     * <b>Tree:</b>
     * <pre>{@code
     *   JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
     *    |--JAVADOC_INLINE_TAG_START -> {
     *    |--LINKPLAIN_LITERAL -> @linkplain
     *    |--WS ->
     *    |--REFERENCE -> org.apache.utils.Lists.Comparator#compare(Object)
     *        |--PACKAGE_CLASS -> org.apache.utils
     *        |--DOT -> .
     *        |--CLASS -> Lists
     *        |--DOT -> .
     *        |--CLASS -> Comparator
     *        |--HASH -> #
     *        |--MEMBER -> compare
     *        |--PARAMETERS -> (Object)
     *            |--LEFT_BRACE -> (
     *            |--ARGUMENT -> Object
     *            |--RIGHT_BRACE -> )
     *     |--DESCRIPTION -> compare
     *         |--TEXT -> compare
     *     |--JAVADOC_INLINE_TAG_END -> }
     * }</pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDGBICD">
     * Oracle Docs</a>
     * @see #JAVADOC_INLINE_TAG
     * @noinspection HtmlTagCanBeJavadocTag
     * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
     *      replaced with Javadoc tag
     */
    public static final int LINKPLAIN_LITERAL = JavadocParser.LINKPLAIN_LITERAL;

    /**
     * '@literal' literal in {&#64;literal} Javadoc inline tag.
     *
     * <p>Such Javadoc inline tag can have such child nodes:</p>
     * <ul>
     * <li>{@link #NEWLINE}</li>
     * <li>{@link #WS}</li>
     * <li>{@link #TEXT}</li>
     * </ul>
     *
     * <p><b>Example:</b></p>
     * <pre><code>{&#64;literal #compare(Object)}</code></pre>
     * <b>Tree:</b>
     * <pre>
     * <code>
     *     |--JAVADOC_INLINE_TAG -&gt; JAVADOC_INLINE_TAG
     *        |--JAVADOC_INLINE_TAG_START -&gt; {
     *        |--LITERAL_LITERAL -&gt; @literal
     *        |--WS -&gt;
     *        |--TEXT -&gt; #compare(Object)
     *        `--JAVADOC_INLINE_TAG_END -&gt; }
     * </code>
     * </pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCFJDG">
     * Oracle Docs</a>
     * @see #JAVADOC_INLINE_TAG
     * @noinspection HtmlTagCanBeJavadocTag
     * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
     *      replaced with Javadoc tag
     */
    public static final int LITERAL_LITERAL = JavadocParser.LITERAL_LITERAL;

    /**
     * '@value' literal in {&#64;value} Javadoc inline tag.
     *
     * <p>Such Javadoc inline tag has one argument {@link #REFERENCE}
     * and can have such child nodes:</p>
     * <ul>
     * <li>{@link #NEWLINE}</li>
     * <li>{@link #WS}</li>
     * </ul>
     *
     * <p><b>Example:</b></p>
     * <pre><code>{&#64;value Integer#MAX_VALUE}</code></pre>
     * <b>Tree:</b>
     * <pre>
     * <code> JAVADOC_INLINE_TAG --&gt; JAVADOC_INLINE_TAG
     *         |--JAVADOC_INLINE_TAG_START --&gt; {
     *         |--VALUE_LITERAL --&gt; @value
     *         |--WS --&gt;
     *         |--REFERENCE --&gt; REFERENCE
     *         |   |--PACKAGE_CLASS --&gt; Integer
     *         |   |--HASH --&gt; #
     *         |   `--MEMBER --&gt; MAX_VALUE
     *         `--JAVADOC_INLINE_TAG_END --&gt; }
     * </code>
     * </pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDDCDHH">
     * Oracle Docs</a>
     * @see #JAVADOC_INLINE_TAG
     * @noinspection HtmlTagCanBeJavadocTag
     * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
     *      replaced with Javadoc tag
     */
    public static final int VALUE_LITERAL = JavadocParser.VALUE_LITERAL;

    /**
     * PACKAGE_CLASS represents the package or class which has been referenced in the `@see`,
     * `@link`, `@linkplain` or `@value` javadoc tags. In the javadoc tree it shall be a child
     * of {@link #REFERENCE}.
     * <br>
     * <strong>IMPORTANT:</strong> Constructs like
     * {@code package.Class.NestedClassAtDepth1.NestedClassAtDepth2#member} are recognized by
     * the javadoc tool from oracle, and no assumptions like, package names wouldn't consist of
     * uppercase characters or class names begin with an uppercase character, are made.
     * Also, <i>the reference</i> in a javadoc tag can consist just a package name or a
     * simple class name or even a full class name. Thus, PACKAGE_CLASS can represent a
     * package name or a simple class name or a full class name i.e. checkstyle doesn't
     * resolve references at present.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @see org.apache.utils.Lists.Comparator#compare(Object)}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code
     * JAVADOC_TAG -&gt JAVADOC_TAG
     *  |--SEE_LITERAL -&gt @see
     *  |--WS -&gt
     *  |--REFERENCE -&gt REFERENCE
     *  |   |--PACKAGE_CLASS -&gt org.apache.utils.Lists.Comparator
     *  |   |--HASH -&gt #
     *  |   |--MEMBER -&gt compare
     *  |   `--PARAMETERS -&gt PARAMETERS
     *  |       |--LEFT_BRACE -&gt (
     *  |       |--ARGUMENT -&gt Object
     *  |       `--RIGHT_BRACE -&gt )
     *  |--NEWLINE -&gt \r\n
     *  `--WS -&gt
     * }
     * </pre>
     */
    public static final int PACKAGE_CLASS = JavadocParser.PACKAGE_CLASS;

    /**
     * Hash character in {@link #REFERENCE}.
     * Hash character is used before specifying a class member.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @see org.apache.utils.Lists.Comparator#compare(Object)}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code
     * JAVADOC_TAG -&gt JAVADOC_TAG
     *  |--SEE_LITERAL -&gt @see
     *  |--WS -&gt
     *  |--REFERENCE -&gt REFERENCE
     *      |--PACKAGE_CLASS -&gt org.apache.utils.Lists.Comparator
     *      |--HASH -&gt #
     *      |--MEMBER -&gt compare
     *      `--PARAMETERS -&gt PARAMETERS
     *          |--LEFT_BRACE -&gt (
     *          |--ARGUMENT -&gt Object
     *          `--RIGHT_BRACE -&gt )
     * }
     * </pre>
     */
    public static final int HASH = JavadocParser.HASH;

    /**
     * A class member in {@link #REFERENCE}.
     * Class member is specified after {@link #HASH} symbol.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @see org.apache.utils.Lists.Comparator#compare(Object)}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code
     * JAVADOC_TAG -> JAVADOC_TAG
     *  |--SEE_LITERAL -> @see
     *  |--WS ->
     *  |--REFERENCE -> REFERENCE
     *      |--PACKAGE_CLASS -> org.apache.utils.Lists.Comparator
     *      |--HASH -> #
     *      |--MEMBER -> compare
     *      `--PARAMETERS -> PARAMETERS
     *          |--LEFT_BRACE -> (
     *          |--ARGUMENT -> Object
     *          `--RIGHT_BRACE -> )
     * }
     * </pre>
     */
    public static final int MEMBER = JavadocParser.MEMBER;

    /**
     * Left brace in {@link #PARAMETERS} part of {@link #REFERENCE}.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @see #method(Processor, String)}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code JAVADOC_TAG -&gt JAVADOC_TAG
     *         |--SEE_LITERAL -&gt @see
     *         |--WS -&gt
     *         |--REFERENCE -&gt REFERENCE
     *         |   |--HASH -&gt #
     *         |   |--MEMBER -&gt method
     *         |   `--PARAMETERS -&gt PARAMETERS
     *         |       |--LEFT_BRACE -&gt (
     *         |       |--ARGUMENT -&gt Processor
     *         |       |--COMMA -&gt ,
     *         |       |--WS -&gt
     *         |       |--ARGUMENT -&gt String
     *         |       `--RIGHT_BRACE -&gt )
     * }
     * </pre>
     */
    public static final int LEFT_BRACE = JavadocParser.LEFT_BRACE;

    /**
     * Right brace in {@link #PARAMETERS} part of {@link #REFERENCE}.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @see #method(Processor, String)}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code JAVADOC_TAG -&gt JAVADOC_TAG
     *         |--SEE_LITERAL -&gt @see
     *         |--WS -&gt
     *         |--REFERENCE -&gt REFERENCE
     *         |   |--HASH -&gt #
     *         |   |--MEMBER -&gt method
     *         |   `--PARAMETERS -&gt PARAMETERS
     *         |       |--LEFT_BRACE -&gt (
     *         |       |--ARGUMENT -&gt Processor
     *         |       |--COMMA -&gt ,
     *         |       |--WS -&gt
     *         |       |--ARGUMENT -&gt String
     *         |       `--RIGHT_BRACE -&gt )
     * }
     * </pre>
     */
    public static final int RIGHT_BRACE = JavadocParser.RIGHT_BRACE;

    /**
     * Argument definition in {@link #PARAMETERS} part of {@link #REFERENCE}.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @see #method(Processor, String)}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code JAVADOC_TAG -&gt JAVADOC_TAG
     *         |--SEE_LITERAL -&gt @see
     *         |--WS -&gt
     *         |--REFERENCE -&gt REFERENCE
     *         |   |--HASH -&gt #
     *         |   |--MEMBER -&gt method
     *         |   `--PARAMETERS -&gt PARAMETERS
     *         |       |--LEFT_BRACE -&gt (
     *         |       |--ARGUMENT -&gt Processor
     *         |       |--COMMA -&gt ,
     *         |       |--WS -&gt
     *         |       |--ARGUMENT -&gt String
     *         |       `--RIGHT_BRACE -&gt )
     *         `--NEWLINE -&gt \n
     * }
     * </pre>
     */
    public static final int ARGUMENT = JavadocParser.ARGUMENT;

    /**
     * Comma separator between parameters in {@link #PARAMETERS} part of {@link #REFERENCE}.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @see #method(Processor, String)}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code
     * JAVADOC_TAG -&gt JAVADOC_TAG
     *  |--SEE_LITERAL -&gt @see
     *  |--WS -&gt
     *  |--REFERENCE -&gt REFERENCE
     *  |   |--HASH -&gt #
     *  |   |--MEMBER -&gt method
     *  |   `--PARAMETERS -&gt PARAMETERS
     *  |       |--LEFT_BRACE -&gt (
     *  |       |--ARGUMENT -&gt Processor
     *  |       |--COMMA -&gt ,
     *  |       |--WS -&gt
     *  |       |--ARGUMENT -&gt String
     *  |       `--RIGHT_BRACE -&gt )
     *  |--NEWLINE -&gt \r\n
     *  `--WS -&gt
     * }
     * </pre>
     *
     * @see #PARAMETERS
     * @see #REFERENCE
     * @see #ARGUMENT
     */
    public static final int COMMA = JavadocParser.COMMA;

    /**
     * Quoted text.
     * One of possible {@code @see} tag arguments.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @see "Spring Framework"}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code
     * JAVADOC_TAG -&gt JAVADOC_TAG
     *  |--SEE_LITERAL -&gt @see
     *  |--WS -&gt
     *  |--STRING -&gt "Spring Framework"
     *  |--NEWLINE -&gt \r\n
     *  `--WS -&gt
     * }
     * </pre>
     *
     * @see #SEE_LITERAL
     */
    public static final int STRING = JavadocParser.STRING;

    /**
     * Exception class name. First argument in {@link #THROWS_LITERAL @throws} and
     * {@link #EXCEPTION_LITERAL @exception} Javadoc tags.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @throws IOException connection problems}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code
     * JAVADOC_TAG -&gt JAVADOC_TAG
     *  |--THROWS_LITERAL -&gt @throws
     *  |--WS -&gt
     *  |--CLASS_NAME -&gt IOException
     *  |--WS -&gt
     *  `--DESCRIPTION -&gt DESCRIPTION
     *      |--TEXT -&gt connection problems
     *      |--NEWLINE -&gt \r\n
     *      `--TEXT -&gt
     * }
     * </pre>
     *
     * @see #EXCEPTION_LITERAL
     * @see #THROWS_LITERAL
     */
    public static final int CLASS_NAME = JavadocParser.CLASS_NAME;

    /**
     * First argument in {@link #PARAM_LITERAL @param} Javadoc tag.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @param T The bar.}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code JAVADOC_TAG -&gt JAVADOC_TAG
     *         |--PARAM_LITERAL -&gt @param
     *         |--WS -&gt
     *         |--PARAMETER_NAME -&gt T
     *         |--WS -&gt
     *         `--DESCRIPTION -&gt DESCRIPTION
     *             |--TEXT -&gt The bar.
     *             |--NEWLINE -&gt \r\n
     *             `--TEXT -&gt
     * }
     * </pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHJECF">
     * Oracle Docs</a>
     * @see #PARAM_LITERAL
     */
    public static final int PARAMETER_NAME = JavadocParser.PARAMETER_NAME;

    /**
     * 'exclude' literal.
     * One of three possible {@link #SERIAL_LITERAL @serial} tag arguments.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @serial exclude}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code
     *   JAVADOC_TAG -> JAVADOC_TAG
     *    |--SERIAL_LITERAL -> @serial
     *    |--WS ->
     *    `--DESCRIPTION -> DESCRIPTION
     *        |--TEXT -> serialized company name
     *        |--NEWLINE -> \r\n
     *        `--TEXT ->
     * }
     * </pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
     * Oracle Docs</a>
     * @see #SERIAL_LITERAL
     */
    public static final int LITERAL_EXCLUDE = JavadocParser.LITERAL_EXCLUDE;

    /**
     * 'include' literal.
     * One of three possible {@link #SERIAL_LITERAL @serial} tag arguments.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @serial include}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code
     * JAVADOC_TAG -&gt JAVADOC_TAG
     *  |--SERIAL_LITERAL -&gt @serial
     *  |--WS -&gt
     *  |--LITERAL_INCLUDE -&gt include
     *  |--NEWLINE -&gt \r\n
     *  `--WS -&gt
     * }
     * </pre>
     *
     * @see
     * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
     * Oracle Docs</a>
     * @see #SERIAL_LITERAL
     */
    public static final int LITERAL_INCLUDE = JavadocParser.LITERAL_INCLUDE;

    /**
     * Field name. First argument of {@link #SERIAL_FIELD_LITERAL @serialField} Javadoc tag.
     *
     * <p><b>Example:</b></p>
     * <pre>{@code @serialField counter Integer objects counter}</pre>
     * <b>Tree:</b>
     * <pre>
     * {@code
      *   JAVADOC_TAG -&gt; JAVADOC_TAG
      *    |--SERIAL_FIELD_LITERAL -&gt; @serialField
      *    |--WS -&gt;
      *    |--FIELD_NAME -&gt; counter
      *    |--WS -&gt;
      *    |--FIELD_TYPE -&gt; Integer
      *    |--WS -&gt;
      *    `--DESCRIPTION -&gt; DESCRIPTION
      *        |--TEXT -&gt; objects counter
      *        |--NEWLINE -&gt; \r\n
      *        `--TEXT -&gt;
      * }</pre>
      *
      * @see
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
      * Oracle Docs</a>
      * @see #SERIAL_FIELD_LITERAL
      */
     public static final int FIELD_NAME = JavadocParser.FIELD_NAME;

     /**
      * Field type. Second argument of {@link #SERIAL_FIELD_LITERAL @serialField} Javadoc tag.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code @serialField counter Integer objects counter}</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code JAVADOC_TAG -&gt JAVADOC_TAG
      *         |--SERIAL_FIELD_LITERAL -&gt @serialField
      *         |--WS -&gt
      *         |--FIELD_NAME -&gt counter
      *         |--WS -&gt
      *         |--FIELD_TYPE -&gt Integer
      *         |--WS -&gt
      *         `--DESCRIPTION -&gt DESCRIPTION
      *             |--TEXT -&gt objects counter
      *             `--NEWLINE -&gt \n
      * }
      * </pre>
      *
      * @see
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
      * Oracle Docs</a>
      * @see #SERIAL_FIELD_LITERAL
      */
     public static final int FIELD_TYPE = JavadocParser.FIELD_TYPE;

     // ------------------------------------------------------------------------------------------ //
     // -----------------        HTML TAGS          ---------------------------------------------- //
     // ------------------------------------------------------------------------------------------ //

     /**
      * Identifier inside HTML tag: tag name or attribute name.
      */
     public static final int HTML_TAG_NAME = JavadocParser.HTML_TAG_NAME;

     // HTML tag components

     /**
      * Start html tag component: {@code '<'}.
      */
     public static final int START = JavadocParser.START;

     /**
      * Slash html tag component: {@code '/'}.
      */
     public static final int SLASH = JavadocParser.SLASH;

     /**
      * End html tag component: {@code '>'}.
      */
     public static final int END = JavadocParser.END;

     /**
      * Slash close html tag component: {@code '/>'}.
      */
     public static final int SLASH_END = JavadocParser.SLASH_END;

     /**
      * Equals html tag component: {@code '='}.
      */
     public static final int EQUALS = JavadocParser.EQUALS;

     /**
      * Attribute value html tag component.
      */
     public static final int ATTR_VALUE = JavadocParser.ATTR_VALUE;

     /////////////////////// HTML TAGS WITH OPTIONAL END TAG /////////////////////////////////////

     /**
      * Paragraph tag name.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code <p>Paragraph Tag.</p>}</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *  JAVADOC -&gt; JAVADOC
      *     |--NEWLINE -&gt; \r\n
      *     |--LEADING_ASTERISK -&gt;      *
      *     |--TEXT -&gt;
      *     |--HTML_ELEMENT -&gt; HTML_ELEMENT
      *         `--PARAGRAPH -&gt; PARAGRAPH
      *             |--P_TAG_START -&gt; P_TAG_START
      *             |   |--START -&gt; &lt;
      *             |   |--P_HTML_TAG_NAME -&gt; p
      *             |   `--END -&gt; &gt;
      *             |--TEXT -&gt; Paragraph Tag.
      *             `--P_TAG_END -&gt; P_TAG_END
      *                 |--START -&gt; &lt;
      *                 |--SLASH -&gt; /
      *                 |--P_HTML_TAG_NAME -&gt; p
      *                 `--END -&gt; &gt;
      * }
      * </pre>
      *
      * @see
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#JSSOR647">
      * Comments are written in HTML</a>
      * @see #P_HTML_TAG_NAME
      */
     public static final int P_HTML_TAG_NAME = JavadocParser.P_HTML_TAG_NAME;

     /** List item tag name. */
     public static final int LI_HTML_TAG_NAME = JavadocParser.LI_HTML_TAG_NAME;

     /** Table row tag name. */
     public static final int TR_HTML_TAG_NAME = JavadocParser.TR_HTML_TAG_NAME;

     /** Table cell tag name. */
     public static final int TD_HTML_TAG_NAME = JavadocParser.TD_HTML_TAG_NAME;

     /** Table header cell tag name. */
     public static final int TH_HTML_TAG_NAME = JavadocParser.TH_HTML_TAG_NAME;

     /** Body tag name. */
     public static final int BODY_HTML_TAG_NAME = JavadocParser.BODY_HTML_TAG_NAME;

     /** Colgroup tag name. */
     public static final int COLGROUP_HTML_TAG_NAME = JavadocParser.COLGROUP_HTML_TAG_NAME;

     /** Description of a term tag name. */
     public static final int DD_HTML_TAG_NAME = JavadocParser.DD_HTML_TAG_NAME;

     /** Description term tag name. */
     public static final int DT_HTML_TAG_NAME = JavadocParser.DT_HTML_TAG_NAME;

     /** Head tag name. */
     public static final int HEAD_HTML_TAG_NAME = JavadocParser.HEAD_HTML_TAG_NAME;

     /** Html tag name. */
     public static final int HTML_HTML_TAG_NAME = JavadocParser.HTML_HTML_TAG_NAME;

     /** Option tag name. */
     public static final int OPTION_HTML_TAG_NAME = JavadocParser.OPTION_HTML_TAG_NAME;

     /** Table body tag name. */
     public static final int TBODY_HTML_TAG_NAME = JavadocParser.TBODY_HTML_TAG_NAME;

     /** Table foot tag name. */
     public static final int TFOOT_HTML_TAG_NAME = JavadocParser.TFOOT_HTML_TAG_NAME;

     /** Table head tag name. */
     public static final int THEAD_HTML_TAG_NAME = JavadocParser.THEAD_HTML_TAG_NAME;

     /** `optgroup` tag name. */
     public static final int OPTGROUP_HTML_TAG_NAME = JavadocParser.OPTGROUP_HTML_TAG_NAME;

     /** `rb` tag name. */
     public static final int RB_HTML_TAG_NAME = JavadocParser.RB_HTML_TAG_NAME;

     /** `rt` tag name. */
     public static final int RT_HTML_TAG_NAME = JavadocParser.RT_HTML_TAG_NAME;

     /** `rtc` tag name. */
     public static final int RTC_HTML_TAG_NAME = JavadocParser.RTC_HTML_TAG_NAME;

     /** `rp` tag name. */
     public static final int RP_HTML_TAG_NAME = JavadocParser.RP_HTML_TAG_NAME;
     ///////////////////////////////////////////////////////////////////////////////////////////////

     /////////////////////// SINGLETON HTML TAGS  //////////////////////////////////////////////////
     /**
      * Area tag name.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code &lt area shape="rect" &gt}</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   JAVADOC -> JAVADOC
      *        |--NEWLINE -> \n
      *        |--LEADING_ASTERISK ->  *
      *        |--TEXT ->
      *        |--HTML_ELEMENT -> HTML_ELEMENT
      *        |   `--SINGLETON_ELEMENT -> SINGLETON_ELEMENT
      *        |       `--AREA_TAG -> AREA_TAG
      *        |           |--START -> <
      *        |           |--AREA_HTML_TAG_NAME -> area
      *        |           |--WS ->
      *        |           |--ATTRIBUTE -> ATTRIBUTE
      *        |           |   |--HTML_TAG_NAME -> shape
      *        |           |   |--EQUALS -> =
      *        |           |   `--ATTR_VALUE -> "rect"
      *        |           `--END -> >
      *        |--TEXT ->
      *        |--NEWLINE -> \n
      *        |--TEXT ->
      * }
      * </pre>
      */

     public static final int AREA_HTML_TAG_NAME = JavadocParser.AREA_HTML_TAG_NAME;

     /** Base tag name. */
     public static final int BASE_HTML_TAG_NAME = JavadocParser.BASE_HTML_TAG_NAME;

     /** Basefont tag name. */
     public static final int BASEFONT_HTML_TAG_NAME = JavadocParser.BASEFONT_HTML_TAG_NAME;

     /**
      * Br tag name.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code text before break &lt br &gt text after break}</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   JAVADOC -&gt; JAVADOC
      *        |--NEWLINE -&gt; \r\n
      *        |--LEADING_ASTERISK -&gt;  *
      *        |--TEXT -&gt;  text before break
      *        |--HTML_ELEMENT -&gt; HTML_ELEMENT
      *        |   `--SINGLETON_ELEMENT -&gt; SINGLETON_ELEMENT
      *        |       `--BR_TAG -&gt; BR_TAG
      *        |           |--START -&gt; -&lt;
      *        |           |--BR_HTML_TAG_NAME -&gt; br
      *        |           `--END -&gt; &gt;
      *        |--TEXT -&gt;  text after break
      *        |--NEWLINE -&gt; \r\n
      *        |--TEXT -&gt;
      * }
      * </pre>
      */

     public static final int BR_HTML_TAG_NAME = JavadocParser.BR_HTML_TAG_NAME;

     /** Col tag name. */
     public static final int COL_HTML_TAG_NAME = JavadocParser.COL_HTML_TAG_NAME;

     /** Frame tag name. */
     public static final int FRAME_HTML_TAG_NAME = JavadocParser.FRAME_HTML_TAG_NAME;

     /** Hr tag name. */
     public static final int HR_HTML_TAG_NAME = JavadocParser.HR_HTML_TAG_NAME;

     /** Img tag name. */
     public static final int IMG_HTML_TAG_NAME = JavadocParser.IMG_HTML_TAG_NAME;

     /** Input tag name. */
     public static final int INPUT_HTML_TAG_NAME = JavadocParser.INPUT_HTML_TAG_NAME;

     /** Isindex tag name. */
     public static final int ISINDEX_HTML_TAG_NAME = JavadocParser.ISINDEX_HTML_TAG_NAME;

     /** Link tag name. */
     public static final int LINK_HTML_TAG_NAME = JavadocParser.LINK_HTML_TAG_NAME;

     /** Meta tag name. */
     public static final int META_HTML_TAG_NAME = JavadocParser.META_HTML_TAG_NAME;

     /** Param tag name. */
     public static final int PARAM_HTML_TAG_NAME = JavadocParser.PARAM_HTML_TAG_NAME;
     /** "embed" tag name. */
     public static final int EMBED_HTML_TAG_NAME = JavadocParser.EMBED_HTML_TAG_NAME;
     /** "keygen" tag name. */
     public static final int KEYGEN_HTML_TAG_NAME = JavadocParser.KEYGEN_HTML_TAG_NAME;
     /** "source" tag name. */
     public static final int SOURCE_HTML_TAG_NAME = JavadocParser.SOURCE_HTML_TAG_NAME;
     /** "track" tag name. */
     public static final int TRACK_HTML_TAG_NAME = JavadocParser.TRACK_HTML_TAG_NAME;
     /** "wbr" tag name. */
     public static final int WBR_HTML_TAG_NAME = JavadocParser.WBR_HTML_TAG_NAME;
     ///////////////////////////////////////////////////////////////////////////////////////////////

     /**
      * HTML comment start symbol '&lt;&#33;--'.
      */
     public static final int HTML_COMMENT_START = JavadocParser.HTML_COMMENT_START;

     /**
      * HTML comment end symbol '--&gt;'.
      */
     public static final int HTML_COMMENT_END = JavadocParser.HTML_COMMENT_END;

     // ------------------------------------------------------------------------------------------ //
     // -----------------        OTHER          -------------------------------------------------- //
     // ------------------------------------------------------------------------------------------ //

     /** Leading asterisk. */
     public static final int LEADING_ASTERISK = JavadocParser.LEADING_ASTERISK;

     /**
      * Newline symbol - '\n'.
      */
     public static final int NEWLINE = JavadocParser.NEWLINE;

     /**
      * Any other symbol.
      */
     public static final int CHAR = JavadocParser.CHAR;

     /**
      * Whitespace or tab ('\t') symbol.
      */
     public static final int WS = JavadocParser.WS;

     /**
      * End Of File symbol. Copied from
      * {@link org.antlr.v4.runtime.Recognizer#EOF} to avoid ANTLR dependency in
      * API.
      */
     public static final int EOF = -1;

     // ------------------------------------------------------------------------------------------ //
     // ------ JAVADOC TAGS DEPENDING ON RULE TYPES OFFSET --------------------------------------- //
     // ------------------------------------------------------------------------------------------ //

     /**
      * Rule types offset.
      * RULE_TYPES_OFFSET constant is used to split lexer tokens types and parser rules types.
      * We need unique numbers for all tokens,
      * ANTLR do not need this and that is why these types are mixed by used values.
      * All values we can take a look at
      * target/generated-sources/antlr/com/puppycrawl/tools/checkstyle/grammar/javadoc/JavadocParser.java
      * For example: LEADING_ASTERISK=1 and RULE_htmlElement = 1.
      * RULE_TYPES_OFFSET required to shift parser rules,
      * to let them not overlap with types that have prefix "RULE_".
      */
     private static final int RULE_TYPES_OFFSET = 10000;

     /**
      * Root node of any Javadoc comment.
      * Last child is always {@link #EOF}.
      *
      * <p><b>Tree for example:</b></p>
      * <pre>{@code
      * JAVADOC -> JAVADOC
      *  |--NEWLINE -> \n
      *  |--LEADING_ASTERISK ->  *
      *  |--WS ->
      *  |--JAVADOC_TAG -> JAVADOC_TAG
      *  |   |--PARAM_LITERAL -> @param
      *  |   |--WS ->
      *  |   |--PARAMETER_NAME -> T
      *  |   |--WS ->
      *  |   `--DESCRIPTION -> DESCRIPTION
      *  |       |--TEXT -> The bar.
      *  |       |--NEWLINE -> \n
      *  |       `--TEXT ->
      *  `--EOF -> <EOF>
      * }</pre>
      */
     public static final int JAVADOC = JavadocParser.RULE_javadoc + RULE_TYPES_OFFSET;

     /**
      * Javadoc tag.
      *
      * <p>Type of Javadoc tag is resolved by literal node that is first child of this node.</p>
      *
      * <p>As literal could be:</p>
      * <ul>
      * <li>{@link #RETURN_LITERAL}</li>
      * <li>{@link #DEPRECATED_LITERAL}</li>
      * <li>{@link #SINCE_LITERAL}</li>
      * <li>{@link #SERIAL_DATA_LITERAL}</li>
      * <li>{@link #SERIAL_FIELD_LITERAL}</li>
      * <li>{@link #PARAM_LITERAL}</li>
      * <li>{@link #SEE_LITERAL}</li>
      * <li>{@link #SERIAL_LITERAL}</li>
      * <li>{@link #VERSION_LITERAL}</li>
      * <li>{@link #EXCEPTION_LITERAL}</li>
      * <li>{@link #THROWS_LITERAL}</li>
      * <li>{@link #AUTHOR_LITERAL}</li>
      * <li>or {@link #CUSTOM_NAME} if it is custom Javadoc tag.</li>
      * </ul>
      *
      * <p><b>Example</b></p>
      * <pre>{@code &#64;param T The bar.}</pre>
      * <b>Tree</b>
      * <pre>{@code
      * JAVADOC_TAG -&gt JAVADOC_TAG
      *  |--PARAM_LITERAL -&gt @param
      *  |--WS -&gt
      *  |--PARAMETER_NAME -&gt T
      *  |--WS -&gt
      *  `--DESCRIPTION -&gt DESCRIPTION
      *      |--TEXT -&gt The bar.
      *      |--NEWLINE -&gt \r\n
      *      `--TEXT -&gt
      * }</pre>
      */

     public static final int JAVADOC_TAG = JavadocParser.RULE_javadocTag + RULE_TYPES_OFFSET;
     /**
      * Javadoc inline tag.
      *
      * <p>Type of Javadoc inline tag is resolved by literal node that is second child of this node.
      * First child is always {@link #JAVADOC_INLINE_TAG_START} and last node is always
      * {@link #JAVADOC_INLINE_TAG_END}.</p>
      *
      * <p>As literal could be:</p>
      * <ul>
      * <li>{@link #CODE_LITERAL}</li>
      * <li>{@link #DOC_ROOT_LITERAL}</li>
      * <li>{@link #LINK_LITERAL}</li>
      * <li>{@link #INHERIT_DOC_LITERAL}</li>
      * <li>{@link #LINKPLAIN_LITERAL}</li>
      * <li>{@link #LITERAL_LITERAL}</li>
      * <li>{@link #VALUE_LITERAL}</li>
      * <li>or {@link #CUSTOM_NAME} if it is custom Javadoc inline tag.</li>
      * </ul>
      *
      * <p><b>Example:</b></p>
      * <pre><code>{&#64;link String}</code></pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *  JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
      *      |--JAVADOC_INLINE_TAG_START -> {
      *      |--LINK_LITERAL -> @link
      *      |--WS ->
      *      |--REFERENCE -> REFERENCE
      *          `--PACKAGE_CLASS -> String
      *      `--JAVADOC_INLINE_TAG_END -> }
      * }
      * </pre>
      *
      * @noinspection HtmlTagCanBeJavadocTag
      * @noinspection HtmlTagCanBeJavadocTag
      * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
      *      replaced with Javadoc tag
      */
     public static final int JAVADOC_INLINE_TAG = JavadocParser.RULE_javadocInlineTag
             + RULE_TYPES_OFFSET;

     /**
      * Parameter of the Javadoc tags listed below.
      * <ul>
      * <li>{@link #SEE_LITERAL @see}</li>
      * <li>{@link #LINK_LITERAL &#123;&#64;link&#125;}</li>
      * <li>{@link #LINKPLAIN_LITERAL &#123;&#64;linkplain&#125;}</li>
      * <li>{@link #VALUE_LITERAL &#123;&#64;value&#125;}</li>
      * </ul>
      */
     public static final int REFERENCE = JavadocParser.RULE_reference + RULE_TYPES_OFFSET;

     /**
      * Parameters part in {@link #REFERENCE}.
      * It is used to specify parameters for {@link #MEMBER method}.
      * Always contains {@link #LEFT_BRACE} as first child and {@link #RIGHT_BRACE} as last child.
      * Each parameter is represented by {@link #ARGUMENT} node.
      * Arguments in braces are separated by {@link #COMMA} (and optional {@link #WS}).
      *
      * <p><b>Example:</b></p>
      * <pre>{@code @see #method(Processor, String)}</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *      JAVADOC_TAG -> JAVADOC_TAG
      *          |--SEE_LITERAL -> @see
      *          |--WS ->
      *          |--REFERENCE -> REFERENCE
      *              |--HASH -> #
      *              |--MEMBER -> method
      *              `--PARAMETERS -> PARAMETERS
      *                  |--LEFT_BRACE -> (
      *                  |--ARGUMENT -> Processor
      *                  |--COMMA -> ,
      *                  |--WS ->
      *                  |--ARGUMENT -> String
      *                  `--RIGHT_BRACE -> )
      * }
      * </pre>
      */
     public static final int PARAMETERS = JavadocParser.RULE_parameters + RULE_TYPES_OFFSET;

     /**
      * Description node. It contains:
      * <ul>
      * <li>{@link #TEXT}</li>
      * <li>{@link #WS}</li>
      * <li>{@link #NEWLINE}</li>
      * <li>{@link #HTML_ELEMENT}</li>
      * </ul>
      *
      * <p>It is argument for many Javadoc tags and inline tags.</p>
      *
      * <p><b>Example:</b></p>
      * <pre>{@code @throws IOException if <b>connection</b> problems occur}</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   --JAVADOC_TAG -> JAVADOC_TAG
      *      |--THROWS_LITERAL -> @throws
      *      |--WS ->
      *      |--CLASS_NAME -> IOException
      *      |--WS ->
      *      `--DESCRIPTION -> DESCRIPTION
      *          |--TEXT -> if
      *          |--HTML_ELEMENT -> HTML_ELEMENT
      *          |   `--HTML_TAG -> HTML_TAG
      *          |       |--HTML_ELEMENT_START -> HTML_ELEMENT_START
      *          |       |   |--START -> <
      *          |       |   |--HTML_TAG_NAME -> b
      *          |       |   `--END -> >
      *          |       |--TEXT -> connection
      *          |       `--HTML_ELEMENT_END -> HTML_ELEMENT_END
      *          |           |--START -> <
      *          |           |--SLASH -> /
      *          |           |--HTML_TAG_NAME -> b
      *          |           `--END -> >
      *          |--TEXT ->  problems occur
      * }
      * </pre>
      */
     public static final int DESCRIPTION = JavadocParser.RULE_description + RULE_TYPES_OFFSET;

     // ------------------------------------------------------------------------------------------ //
     // -------- HTML TAGS DEPENDING ON RULE TYPES OFFSET ---------------------------------------- //
     // ------------------------------------------------------------------------------------------ //

     /**
      * Parent node for all html tags.
      */
     public static final int HTML_ELEMENT = JavadocParser.RULE_htmlElement
             + RULE_TYPES_OFFSET;

     /**
      * Start html tag: &lt;XXXX&gt;.
      */
     public static final int HTML_ELEMENT_START = JavadocParser.RULE_htmlElementStart
             + RULE_TYPES_OFFSET;

     /**
      * End html tag: &lt;XXXX&gt;.
      */
     public static final int HTML_ELEMENT_END = JavadocParser.RULE_htmlElementEnd
             + RULE_TYPES_OFFSET;

     /**
      * Non-special HTML tag.
      */
     public static final int HTML_TAG = JavadocParser.RULE_htmlTag + RULE_TYPES_OFFSET;

     /**
      * Html tag attribute. Parent node for: {@code HTML_TAG_IDENT, EQUALS, ATTR_VALUE}.
      */
     public static final int ATTRIBUTE = JavadocParser.RULE_attribute
             + RULE_TYPES_OFFSET;

     /////////////////////// HTML TAGS WITH OPTIONAL END TAG /////////////////////////////////////
     /**
      * Paragraph html tag.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code <p>Sample text</p>}</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   `--JAVADOC -> JAVADOC
      *       |--NEWLINE -> \r\n
      *       |--LEADING_ASTERISK ->  *
      *       |--TEXT ->
      *       |--HTML_ELEMENT -> HTML_ELEMENT
      *       |   `--PARAGRAPH -> PARAGRAPH
      *       |       |--P_TAG_START -> P_TAG_START
      *       |       |   |--START -> <
      *       |       |   |--P_HTML_TAG_NAME -> p
      *       |       |   `--END -> >
      *       |       |--TEXT -> Sample text
      *       |       `--P_TAG_END -> P_TAG_END
      *       |           |--START -> <
      *       |           |--SLASH -> /
      *       |           |--P_HTML_TAG_NAME -> p
      *       |           `--END -> >
      *       |--NEWLINE -> \r\n
      *       |--TEXT ->
      * }
      * </pre>
      */
     public static final int PARAGRAPH = JavadocParser.RULE_paragraph + RULE_TYPES_OFFSET;
     /** Start paragraph tag. */
     public static final int P_TAG_START = JavadocParser.RULE_pTagStart + RULE_TYPES_OFFSET;
     /** End paragraph tag. */
     public static final int P_TAG_END = JavadocParser.RULE_pTagEnd + RULE_TYPES_OFFSET;

     /**
      * List items html tag.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code
      * <ul>
      *      <li>Item 1</li>
      * </ul>
      * }</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   --JAVADOC -> JAVADOC
      *     |--NEWLINE -> \n
      *     |--LEADING_ASTERISK ->  *
      *     |--TEXT ->
      *     |--HTML_ELEMENT -> HTML_ELEMENT
      *     |   `--HTML_TAG -> HTML_TAG
      *     |       |--HTML_ELEMENT_START -> HTML_ELEMENT_START
      *     |       |   |--START -> <
      *     |       |   |--HTML_TAG_NAME -> ul
      *     |       |   `--END -> >
      *     |       |--NEWLINE -> \n
      *     |       |--LEADING_ASTERISK ->  *
      *     |       |--TEXT ->
      *     |       |--HTML_ELEMENT -> HTML_ELEMENT
      *     |       |   `--LI -> LI
      *     |       |       |--LI_TAG_START -> LI_TAG_START
      *     |       |       |   |--START -> <
      *     |       |       |   |--LI_HTML_TAG_NAME -> li
      *     |       |       |   `--END -> >
      *     |       |       |--TEXT -> Item 1
      *     |       |       `--LI_TAG_END -> LI_TAG_END
      *     |       |           |--START -> <
      *     |       |           |--SLASH -> /
      *     |       |           |--LI_HTML_TAG_NAME -> li
      *     |       |           `--END -> >
      *     |       |--NEWLINE -> \n
      *     |       |--LEADING_ASTERISK ->  *
      *     |       |--TEXT ->
      *     |       `--HTML_ELEMENT_END -> HTML_ELEMENT_END
      *     |           |--START -> <
      *     |           |--SLASH -> /
      *     |           |--HTML_TAG_NAME -> ul
      *     |           `--END -> >
      *     |--NEWLINE -> \n
      *     |--TEXT ->
      * }
      * </pre>
      */
     public static final int LI = JavadocParser.RULE_li + RULE_TYPES_OFFSET;
     /** Start list item tag. */
     public static final int LI_TAG_START = JavadocParser.RULE_liTagStart + RULE_TYPES_OFFSET;
     /** End list item tag. */
     public static final int LI_TAG_END = JavadocParser.RULE_liTagEnd + RULE_TYPES_OFFSET;

     /**
      * Table row html tag.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code <tr></tr>}</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   JAVADOC -> JAVADOC
      *        |--NEWLINE -&gt \r\n
      *        |--LEADING_ASTERISK -&gt  *
      *        |--TEXT -&gt
      *        |--HTML_ELEMENT -&gt HTML_ELEMENT
      *        |   `--TR -&gt TR
      *        |       |--TR_TAG_START -&gt TR_TAG_START
      *        |       |   |--START -&gt &lt
      *        |       |   |--TR_HTML_TAG_NAME -&gt tr
      *        |       |   `--END -&gt &gt
      *        |       `--TR_TAG_END -&gt TR_TAG_END
      *        |           |--START -&gt &lt
      *        |           |--SLASH -&gt /
      *        |           |--TR_HTML_TAG_NAME -&gt tr
      *        |           `--END -&gt &gt
      *        |--NEWLINE -&gt \r\n
      *        |--TEXT -&gt
      * }
      * </pre>
      */
     public static final int TR = JavadocParser.RULE_tr + RULE_TYPES_OFFSET;
     /** Start table row tag. */
     public static final int TR_TAG_START = JavadocParser.RULE_trTagStart + RULE_TYPES_OFFSET;
     /** End table row tag. */
     public static final int TR_TAG_END = JavadocParser.RULE_trTagEnd + RULE_TYPES_OFFSET;

     /** Table cell html tag: {@code <td></td>}. */
     public static final int TD = JavadocParser.RULE_td + RULE_TYPES_OFFSET;
     /** Start table cell tag. */
     public static final int TD_TAG_START = JavadocParser.RULE_tdTagStart + RULE_TYPES_OFFSET;
     /** End table cell tag. */
     public static final int TD_TAG_END = JavadocParser.RULE_tdTagEnd + RULE_TYPES_OFFSET;

     /** Table header cell html tag: {@code <th></th>}. */
     public static final int TH = JavadocParser.RULE_th + RULE_TYPES_OFFSET;
     /** Start table header cell tag. */
     public static final int TH_TAG_START = JavadocParser.RULE_thTagStart + RULE_TYPES_OFFSET;
     /** End table header cell tag. */
     public static final int TH_TAG_END = JavadocParser.RULE_thTagEnd + RULE_TYPES_OFFSET;

     /** Body html tag. */
     public static final int BODY = JavadocParser.RULE_body + RULE_TYPES_OFFSET;

     /**
      * Start body tag.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code
      * &lt;body&gt;
      * This is a test
      * &lt;/body&gt;
      * }</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   JAVADOC -> JAVADOC
      *        |--TEXT -> /**
      *        |--NEWLINE -> \n
      *        |--LEADING_ASTERISK ->  *
      *        |--TEXT ->
      *        |--HTML_ELEMENT -> HTML_ELEMENT
      *        |    `--BODY -> BODY
      *        |         |--BODY_TAG_START -> BODY_TAG_START
      *        |         |    |--START -> <
      *        |         |    |--BODY_HTML_TAG_NAME -> body
      *        |         |    `--END -> >
      *        |         |--NEWLINE -> \n
      *        |         |--LEADING_ASTERISK ->  *
      *        |         |--TEXT ->  This is inside the body tag.
      *        |         |--NEWLINE -> \n
      *        |         |--LEADING_ASTERISK ->  *
      *        |         |--TEXT ->
      *        |         `--BODY_TAG_END -> BODY_TAG_END
      *        |             |--START -> <
      *        |             |--SLASH -> /
      *        |             |--BODY_HTML_TAG_NAME -> body
      *        |             `--END -> >
      *          |--NEWLINE -> \n
      *          |--LEADING_ASTERISK ->  *
      *          |--TEXT -> /
      *          |--NEWLINE -> \n
      *          |--TEXT -> public class Test {
      *          |--NEWLINE -> \n
      *          |--TEXT -> }
      *          |--NEWLINE -> \n
      * }
      * </pre>
      */
     public static final int BODY_TAG_START = JavadocParser.RULE_bodyTagStart + RULE_TYPES_OFFSET;

     /**
      * End body tag.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code
      *  &lt;body&gt;
      *     This is a test
      * &lt;/body&gt;
      * }</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   JAVADOC -> JAVADOC
      *        |--TEXT -> /**
      *        |--NEWLINE -> \n
      *        |--LEADING_ASTERISK ->  *
      *        |--TEXT ->
      *        |--HTML_ELEMENT -> HTML_ELEMENT
      *        |    `--BODY -> BODY
      *        |         |--BODY_TAG_START -> BODY_TAG_START
      *        |         |    |--START -> <
      *        |         |    |--BODY_HTML_TAG_NAME -> body
      *        |         |    `--END -> >
      *        |         |--NEWLINE -> \n
      *        |         |--LEADING_ASTERISK ->  *
      *        |         |--TEXT ->  This is inside the body tag.
      *        |         |--NEWLINE -> \n
      *        |         |--LEADING_ASTERISK ->  *
      *        |         |--TEXT ->
      *        |         `--BODY_TAG_END -> BODY_TAG_END
      *        |             |--START -> <
      *        |             |--SLASH -> /
      *        |             |--BODY_HTML_TAG_NAME -> body
      *        |             `--END -> >
      *        |--NEWLINE -> \n
      *        |--LEADING_ASTERISK ->  *
      *        |--TEXT -> /
      *        |--NEWLINE -> \n
      *        |--TEXT -> public class Test {
      *        |--NEWLINE -> \n
      *        |--TEXT -> }
      *        |--NEWLINE -> \n
      * }
      * </pre>
      */
     public static final int BODY_TAG_END = JavadocParser.RULE_bodyTagEnd + RULE_TYPES_OFFSET;

     /**
      * Colgroup html tag.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code
      * <colgroup>
      *     <col />
      *     <col span="2" class="batman" />
      * </colgroup>
      * }</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   --JAVADOC -> JAVADOC
      *       |--NEWLINE -> \n
      *       |--LEADING_ASTERISK ->  *
      *       |--TEXT ->
      *       |--HTML_ELEMENT -> HTML_ELEMENT
      *       |   `--COLGROUP -> COLGROUP
      *       |       |--COLGROUP_TAG_START -> COLGROUP_TAG_START
      *       |       |   |--START -> <
      *       |       |   |--COLGROUP_HTML_TAG_NAME -> colgroup
      *       |       |   |   `--END -> >
      *       |       |--NEWLINE -> \n
      *       |       |--LEADING_ASTERISK ->  *
      *       |       |--TEXT ->
      *       |       |--SINGLETON_ELEMENT -> SINGLETON_ELEMENT
      *       |       |   `--COL_TAG -> COL_TAG
      *       |       |       |--START -> <
      *       |       |       |--COL_HTML_TAG_NAME -> col
      *       |       |       |--WS ->
      *       |       |       `--SLASH_END -> />
      *       |       |--NEWLINE -> \n
      *       |       |--LEADING_ASTERISK ->  *
      *       |       |--TEXT ->
      *       |       |--SINGLETON_ELEMENT -> SINGLETON_ELEMENT
      *       |       |   `--COL_TAG -> COL_TAG
      *       |       |       |--START -> <
      *       |       |       |--COL_HTML_TAG_NAME -> col
      *       |       |       |--WS ->
      *       |       |       |--ATTRIBUTE -> ATTRIBUTE
      *       |       |       |   |--HTML_TAG_NAME -> span
      *       |       |       |   |--EQUALS -> =
      *       |       |       |   `--ATTR_VALUE -> "2"
      *       |       |       |--WS ->
      *       |       |       |--ATTRIBUTE -> ATTRIBUTE
      *       |       |       |   |--HTML_TAG_NAME -> class
      *       |       |       |   |--EQUALS -> =
      *       |       |       |   `--ATTR_VALUE -> "batman"
      *       |       |       |--WS ->
      *       |       |       `--SLASH_END -> />
      *       |       |--NEWLINE -> \n
      *       |       |--LEADING_ASTERISK ->  *
      *       |       |--TEXT ->
      *       |       `--COLGROUP_TAG_END -> COLGROUP_TAG_END
      *       |       |       |--START -> <
      *       |       |       |--SLASH -> /
      *       |       |       |--COLGROUP_HTML_TAG_NAME -> colgroup
      *       |       |       `--END -> >
      *       |--NEWLINE -> \n
      *       |--TEXT ->
      * }
      * </pre>
      */
     public static final int COLGROUP = JavadocParser.RULE_colgroup + RULE_TYPES_OFFSET;
     /** Start colgroup tag. */
     public static final int COLGROUP_TAG_START = JavadocParser.RULE_colgroupTagStart
             + RULE_TYPES_OFFSET;
     /** End colgroup tag. */
     public static final int COLGROUP_TAG_END = JavadocParser.RULE_colgroupTagEnd
             + RULE_TYPES_OFFSET;

     /** Description of a term html tag: {@code <dd></dd>}. */
     public static final int DD = JavadocParser.RULE_dd + RULE_TYPES_OFFSET;
     /** Start description of a term tag. */
     public static final int DD_TAG_START = JavadocParser.RULE_ddTagStart + RULE_TYPES_OFFSET;
     /** End description of a term tag. */
     public static final int DD_TAG_END = JavadocParser.RULE_ddTagEnd + RULE_TYPES_OFFSET;

     /** Description term html tag: {@code <dt></dt>}. */
     public static final int DT = JavadocParser.RULE_dt + RULE_TYPES_OFFSET;
     /** Start description term tag. */
     public static final int DT_TAG_START = JavadocParser.RULE_dtTagStart + RULE_TYPES_OFFSET;
     /** End description term tag. */
     public static final int DT_TAG_END = JavadocParser.RULE_dtTagEnd + RULE_TYPES_OFFSET;

     /** Head html tag. */
     public static final int HEAD = JavadocParser.RULE_head + RULE_TYPES_OFFSET;
     /** Start head tag. */
     public static final int HEAD_TAG_START = JavadocParser.RULE_headTagStart + RULE_TYPES_OFFSET;
     /** End head tag. */
     public static final int HEAD_TAG_END = JavadocParser.RULE_headTagEnd + RULE_TYPES_OFFSET;

     /** Html html tag. */
     public static final int HTML = JavadocParser.RULE_html + RULE_TYPES_OFFSET;
     /** Start html tag. */
     public static final int HTML_TAG_START = JavadocParser.RULE_htmlTagStart + RULE_TYPES_OFFSET;
     /** End html tag. */
     public static final int HTML_TAG_END = JavadocParser.RULE_htmlTagEnd + RULE_TYPES_OFFSET;

     /** Option html tag. */
     public static final int OPTION = JavadocParser.RULE_option + RULE_TYPES_OFFSET;
     /** Start option tag. */
     public static final int OPTION_TAG_START =
             JavadocParser.RULE_optionTagStart + RULE_TYPES_OFFSET;
     /** End option tag. */
     public static final int OPTION_TAG_END = JavadocParser.RULE_optionTagEnd
             + RULE_TYPES_OFFSET;

     /** Table body html tag. */
     public static final int TBODY = JavadocParser.RULE_tbody + RULE_TYPES_OFFSET;
     /** Start table body tag. */
     public static final int TBODY_TAG_START = JavadocParser.RULE_tbodyTagStart + RULE_TYPES_OFFSET;
     /** End table body tag. */
     public static final int TBODY_TAG_END = JavadocParser.RULE_tbodyTagEnd + RULE_TYPES_OFFSET;

     /** Table foot html tag. */
     public static final int TFOOT = JavadocParser.RULE_tfoot + RULE_TYPES_OFFSET;
     /** Start table foot tag. */
     public static final int TFOOT_TAG_START = JavadocParser.RULE_tfootTagStart + RULE_TYPES_OFFSET;
     /** End table foot tag. */
     public static final int TFOOT_TAG_END = JavadocParser.RULE_tfootTagEnd + RULE_TYPES_OFFSET;

     /** Table head html tag. */
     public static final int THEAD = JavadocParser.RULE_thead + RULE_TYPES_OFFSET;
     /** Start table head tag. */
     public static final int THEAD_TAG_START = JavadocParser.RULE_theadTagStart + RULE_TYPES_OFFSET;
     /** End table head tag. */
     public static final int THEAD_TAG_END = JavadocParser.RULE_theadTagEnd + RULE_TYPES_OFFSET;

     /** `optgroup` html tag. */
     public static final int OPTGROUP = JavadocParser.RULE_optgroup + RULE_TYPES_OFFSET;
     /** `optgroup` tag start. */
     public static final int OPTGROUP_TAG_START =
             JavadocParser.RULE_optgroupTagStart + RULE_TYPES_OFFSET;
     /** `optgroup` tag end. */
     public static final int OPTGROUP_TAG_END =
             JavadocParser.RULE_optgroupTagEnd + RULE_TYPES_OFFSET;

     /** `rb` html tag. */
     public static final int RB = JavadocParser.RULE_rb + RULE_TYPES_OFFSET;
     /** `rb` tag start. */
     public static final int RB_TAG_START =
             JavadocParser.RULE_rbTagStart + RULE_TYPES_OFFSET;
     /** `rb` tag end. */
     public static final int RB_TAG_END =
             JavadocParser.RULE_rbTagEnd + RULE_TYPES_OFFSET;

     /** `rt` html tag. */
     public static final int RT = JavadocParser.RULE_rt + RULE_TYPES_OFFSET;
     /** `rt` tag start. */
     public static final int RT_TAG_START =
             JavadocParser.RULE_rtTagStart + RULE_TYPES_OFFSET;
     /** `rt` tag end. */
     public static final int RT_TAG_END =
             JavadocParser.RULE_rtTagEnd + RULE_TYPES_OFFSET;

     /** `rtc` html tag. */
     public static final int RTC = JavadocParser.RULE_rtc + RULE_TYPES_OFFSET;
     /** `rtc` tag start. */
     public static final int RTC_TAG_START =
             JavadocParser.RULE_rtcTagStart + RULE_TYPES_OFFSET;
     /** `rtc` tag end. */
     public static final int RTC_TAG_END =
             JavadocParser.RULE_rtcTagEnd + RULE_TYPES_OFFSET;

     /** `rp` html tag. */
     public static final int RP = JavadocParser.RULE_rp + RULE_TYPES_OFFSET;
     /** `rp` tag start. */
     public static final int RP_TAG_START =
             JavadocParser.RULE_rpTagStart + RULE_TYPES_OFFSET;
     /** `rp` tag end. */
     public static final int RP_TAG_END =
             JavadocParser.RULE_rpTagEnd + RULE_TYPES_OFFSET;

     /////////////////////// SINGLETON HTML TAGS  //////////////////////////////////////////////////
     /**
      * Parent node for all singleton html tags.
      */
     public static final int SINGLETON_ELEMENT = JavadocParser.RULE_singletonElement
             + RULE_TYPES_OFFSET;

     /**
      * Non-special empty html tag.
      */
     public static final int EMPTY_TAG = JavadocParser.RULE_emptyTag
             + RULE_TYPES_OFFSET;

     /**
      * Area html tag.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code &lt area shape="rect" &gt}</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   JAVADOC -> JAVADOC
      *        |--NEWLINE -> \n
      *        |--LEADING_ASTERISK ->  *
      *        |--TEXT ->
      *        |--HTML_ELEMENT -> HTML_ELEMENT
      *        |   `--SINGLETON_ELEMENT -> SINGLETON_ELEMENT
      *        |       `--AREA_TAG -> AREA_TAG
      *        |           |--START -> <
      *        |           |--AREA_HTML_TAG_NAME -> area
      *        |           |--WS ->
      *        |           |--ATTRIBUTE -> ATTRIBUTE
      *        |           |   |--HTML_TAG_NAME -> shape
      *        |           |   |--EQUALS -> =
      *        |           |   `--ATTR_VALUE -> "rect"
      *        |           `--END -> >
      *        |--TEXT ->
      *        |--NEWLINE -> \n
      *        |--TEXT ->
      * }
      * </pre>
      */
     public static final int AREA_TAG = JavadocParser.RULE_areaTag + RULE_TYPES_OFFSET;

     /** Base html tag. */
     public static final int BASE_TAG = JavadocParser.RULE_baseTag + RULE_TYPES_OFFSET;

     /** Basefont html tag. */
     public static final int BASEFONT_TAG = JavadocParser.RULE_basefontTag + RULE_TYPES_OFFSET;

     /** Br html tag. */
     public static final int BR_TAG = JavadocParser.RULE_brTag + RULE_TYPES_OFFSET;

     /** Col html tag. */
     public static final int COL_TAG = JavadocParser.RULE_colTag + RULE_TYPES_OFFSET;

     /** Frame html tag. */
     public static final int FRAME_TAG = JavadocParser.RULE_frameTag + RULE_TYPES_OFFSET;

     /** Hr html tag. */
     public static final int HR_TAG = JavadocParser.RULE_hrTag + RULE_TYPES_OFFSET;

     /** Img html tag. */
     public static final int IMG_TAG = JavadocParser.RULE_imgTag + RULE_TYPES_OFFSET;

     /**
      * Input html tag.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code Type here: <input type="text" id="id" name="name"> }</pre>
      * <b>Tree:</b>
      * <pre>
      * {@code
      *   JAVADOC -> JAVADOC
      *        |--NEWLINE -> \r\n
      *        |--LEADING_ASTERISK ->  *
      *        |--TEXT ->   Type here:
      *        |--HTML_ELEMENT -> HTML_ELEMENT
      *        |   `--SINGLETON_ELEMENT -> SINGLETON_ELEMENT
      *        |       `--INPUT_TAG -> INPUT_TAG
      *        |           |--START -> <
      *        |           |--INPUT_HTML_TAG_NAME -> input
      *        |           |--WS ->
      *        |           |--ATTRIBUTE -> ATTRIBUTE
      *        |           |   |--HTML_TAG_NAME -> type
      *        |           |   |--EQUALS -> =
      *        |           |   `--ATTR_VALUE -> "text"
      *        |           |--WS ->
      *        |           |--ATTRIBUTE -> ATTRIBUTE
      *        |           |   |--HTML_TAG_NAME -> id
      *        |           |   |--EQUALS -> =
      *        |           |   `--ATTR_VALUE -> "id"
      *        |           |--WS ->
      *        |           |--ATTRIBUTE -> ATTRIBUTE
      *        |           |   |--HTML_TAG_NAME -> name
      *        |           |   |--EQUALS -> =
      *        |           |   `--ATTR_VALUE -> "name"
      *        |           `--END -> >
      *        |--NEWLINE -> \r\n
      *        |--TEXT ->
      * }
      * </pre>
      */
     public static final int INPUT_TAG = JavadocParser.RULE_inputTag + RULE_TYPES_OFFSET;

     /** Isindex html tag. */
     public static final int ISINDEX_TAG = JavadocParser.RULE_isindexTag + RULE_TYPES_OFFSET;

     /** Link html tag. */
     public static final int LINK_TAG = JavadocParser.RULE_linkTag + RULE_TYPES_OFFSET;

     /** Meta html tag. */
     public static final int META_TAG = JavadocParser.RULE_metaTag + RULE_TYPES_OFFSET;

     /** Param html tag. */
     public static final int PARAM_TAG = JavadocParser.RULE_paramTag + RULE_TYPES_OFFSET;

     /**
      * HTML void element {@code <embed>}.
      *
      * @see #SINGLETON_ELEMENT
      * @see <a href="https://www.w3.org/TR/html51/semantics-embedded-content.html#elementdef-embed">
      *     W3 docs</a>
      */
     public static final int EMBED_TAG = JavadocParser.RULE_embedTag + RULE_TYPES_OFFSET;

     /**
      * HTML void element {@code <keygen>}.
      *
      * @see #SINGLETON_ELEMENT
      * @see <a href="https://www.w3.org/TR/html51/sec-forms.html#elementdef-keygen">
      *     W3 docs</a>
      */
     public static final int KEYGEN_TAG = JavadocParser.RULE_keygenTag + RULE_TYPES_OFFSET;

     /**
      * HTML void element {@code <source>}.
      *
      * @see #SINGLETON_ELEMENT
      * @see <a href=
      *     "https://www.w3.org/TR/html51/semantics-embedded-content.html#elementdef-media-source">
      *     W3 docs</a>
      */
     public static final int SOURCE_TAG = JavadocParser.RULE_sourceTag + RULE_TYPES_OFFSET;

     /**
      * HTML void element {@code <track>}.
      *
      * @see #SINGLETON_ELEMENT
      * @see <a
      *     href="https://www.w3.org/TR/html51/semantics-embedded-content.html#elementdef-track">
      *     W3 docs</a>
      */
     public static final int TRACK_TAG = JavadocParser.RULE_trackTag + RULE_TYPES_OFFSET;

     /**
      * HTML void element {@code <wbr>}.
      *
      * @see #SINGLETON_ELEMENT
      * @see <a href="https://www.w3.org/TR/html51/textlevel-semantics.html#elementdef-wbr">
      *     W3 docs</a>
      */
     public static final int WBR_TAG = JavadocParser.RULE_wbrTag + RULE_TYPES_OFFSET;

     ///////////////////////////////////////////////////////////////////////////////////////////////

     /**
      * Html comment: <code>&lt;&#33;-- --&gt;</code>.
      *
      * @noinspection HtmlTagCanBeJavadocTag
      * @noinspectionreason HtmlTagCanBeJavadocTag - encoded symbols were not decoded when
      *      replaced with Javadoc tag
      */
     public static final int HTML_COMMENT = JavadocParser.RULE_htmlComment
             + RULE_TYPES_OFFSET;
     /**
      * CHAR and WS sequence.
      */
     public static final int TEXT = JavadocParser.RULE_text + RULE_TYPES_OFFSET;

     /** Empty private constructor of the current class. */
     private JavadocTokenTypes() {
     }

 }