Coverage Report - com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
 
Classes in this File Line Coverage Branch Coverage Complexity
JavadocTokenTypes
100%
2/2
N/A
1
 
 1  
 ////////////////////////////////////////////////////////////////////////////////
 2  
 // checkstyle: Checks Java source code for adherence to a set of rules.
 3  
 // Copyright (C) 2001-2017 the original author or authors.
 4  
 //
 5  
 // This library is free software; you can redistribute it and/or
 6  
 // modify it under the terms of the GNU Lesser General Public
 7  
 // License as published by the Free Software Foundation; either
 8  
 // version 2.1 of the License, or (at your option) any later version.
 9  
 //
 10  
 // This library is distributed in the hope that it will be useful,
 11  
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 12  
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 13  
 // Lesser General Public License for more details.
 14  
 //
 15  
 // You should have received a copy of the GNU Lesser General Public
 16  
 // License along with this library; if not, write to the Free Software
 17  
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 18  
 ////////////////////////////////////////////////////////////////////////////////
 19  
 
 20  
 package com.puppycrawl.tools.checkstyle.api;
 21  
 
 22  
 import org.antlr.v4.runtime.Recognizer;
 23  
 
 24  
 import com.puppycrawl.tools.checkstyle.grammars.javadoc.JavadocParser;
 25  
 
 26  
 /**
 27  
  * Contains the constants for all the tokens contained in the Abstract
 28  
  * Syntax Tree for the javadoc grammar.
 29  
  *
 30  
  * @author Baratali Izmailov
 31  
  * @see <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html">
 32  
  * javadoc - The Java API Documentation Generator</a>
 33  
  */
 34  
 public final class JavadocTokenTypes {
 35  
     //--------------------------------------------------------------------------------------------//
 36  
     //------------------        JAVADOC TAGS          --------------------------------------------//
 37  
     //--------------------------------------------------------------------------------------------//
 38  
 
 39  
     /**
 40  
      * '@return' literal in @return Javadoc tag.
 41  
      *
 42  
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
 43  
      *
 44  
      * <p><b>Example:</b></p>
 45  
      * <pre>{@code @return true if file exists}</pre>
 46  
      * <b>Tree:</b>
 47  
      * <pre>{@code
 48  
      *   |--JAVADOC_TAG[4x3] : [@return true if file exists]
 49  
      *       |--RETURN_LITERAL[4x3] : [@return]
 50  
      *       |--WS[4x10] : [ ]
 51  
      *       |--DESCRIPTION[4x11] : [true if file exists]
 52  
      *           |--TEXT[4x11] : [true if file exists]
 53  
      * }</pre>
 54  
      *
 55  
      * @see
 56  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCDBGG">
 57  
      * Oracle Docs</a>
 58  
      * @see #JAVADOC_TAG
 59  
      */
 60  
     public static final int RETURN_LITERAL = JavadocParser.RETURN_LITERAL;
 61  
 
 62  
     /**
 63  
      * '{@literal @}deprecated' literal in {@literal @}deprecated Javadoc tag.
 64  
      *
 65  
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
 66  
      *
 67  
      * <p><b>Example:</b></p>
 68  
      * <pre>{@code @deprecated it is deprecated method}</pre>
 69  
      * <b>Tree:</b>
 70  
      * <pre>{@code
 71  
      *   |--JAVADOC_TAG[3x0] : [@deprecated it is deprecated method]
 72  
      *   |--DEPRECATED_LITERAL[3x0] : [@deprecated]
 73  
      *   |--WS[3x11] : [ ]
 74  
      *   |--DESCRIPTION[3x12] : [it is deprecated method]
 75  
      *       |--TEXT[3x12] : [it is deprecated method]
 76  
      * }</pre>
 77  
      *
 78  
      * @see
 79  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#deprecated">
 80  
      * Oracle Docs</a>
 81  
      * @see #JAVADOC_TAG
 82  
      */
 83  
     public static final int DEPRECATED_LITERAL = JavadocParser.DEPRECATED_LITERAL;
 84  
 
 85  
     /**
 86  
      * '@since' literal in @since Javadoc tag.
 87  
      *
 88  
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
 89  
      *
 90  
      * <p><b>Example:</b></p>
 91  
      * <pre>{@code @since 3.4 RELEASE}</pre>
 92  
      * <b>Tree:</b>
 93  
      * <pre>{@code
 94  
      *   |--JAVADOC_TAG[3x0] : [@since 3.4 RELEASE]
 95  
      *       |--SINCE_LITERAL[3x0] : [@since]
 96  
      *       |--WS[3x6] : [ ]
 97  
      *       |--DESCRIPTION[3x7] : [3.4 RELEASE]
 98  
      *           |--TEXT[3x7] : [3.4 RELEASE]
 99  
      * }</pre>
 100  
      *
 101  
      * @see
 102  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHGJGD">
 103  
      * Oracle Docs</a>
 104  
      * @see #JAVADOC_TAG
 105  
      */
 106  
     public static final int SINCE_LITERAL = JavadocParser.SINCE_LITERAL;
 107  
 
 108  
     /**
 109  
      * '@serialData' literal in @serialData Javadoc tag.
 110  
      *
 111  
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
 112  
      *
 113  
      * <p><b>Example:</b></p>
 114  
      * <pre>{@code @serialData two values of Integer type}</pre>
 115  
      * <b>Tree:</b>
 116  
      * <pre>{@code
 117  
      *   |--JAVADOC_TAG[3x0] : [@serialData two values of Integer type ]
 118  
      *       |--SERIAL_DATA_LITERAL[3x0] : [@serialData]
 119  
      *       |--WS[3x11] : [ ]
 120  
      *       |--DESCRIPTION[3x12] : [two values of Integer type ]
 121  
      *           |--TEXT[3x12] : [two values of Integer type ]
 122  
      * }
 123  
      * </pre>
 124  
      *
 125  
      * @see
 126  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDJBFDB">
 127  
      * Oracle Docs</a>
 128  
      * @see #JAVADOC_TAG
 129  
      */
 130  
     public static final int SERIAL_DATA_LITERAL = JavadocParser.SERIAL_DATA_LITERAL;
 131  
 
 132  
     /**
 133  
      * '@serialField' literal in @serialField Javadoc tag.
 134  
      *
 135  
      * <p>Such Javadoc tag can have three arguments:</p>
 136  
      * <ol>
 137  
      * <li>{@link #FIELD_NAME}</li>
 138  
      * <li>{@link #FIELD_TYPE}</li>
 139  
      * <li>{@link #DESCRIPTION}</li>
 140  
      * </ol>
 141  
      *
 142  
      * <p><b>Example:</b></p>
 143  
      * <pre>{@code @serialField counter Integer objects counter}</pre>
 144  
      * <b>Tree:</b>
 145  
      * <pre>{@code
 146  
      *   |--JAVADOC_TAG[3x0] : [@serialField counter Integer objects counter]
 147  
      *       |--SERIAL_FIELD_LITERAL[3x0] : [@serialField]
 148  
      *       |--WS[3x12] : [ ]
 149  
      *       |--FIELD_NAME[3x13] : [counter]
 150  
      *       |--WS[3x20] : [ ]
 151  
      *       |--FIELD_TYPE[3x21] : [Integer]
 152  
      *       |--WS[3x28] : [ ]
 153  
      *       |--DESCRIPTION[3x29] : [objects counter]
 154  
      *           |--TEXT[3x29] : [objects counter]
 155  
      * }</pre>
 156  
      *
 157  
      * @see
 158  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDGHIDG">
 159  
      * Oracle Docs</a>
 160  
      * @see #JAVADOC_TAG
 161  
      */
 162  
     public static final int SERIAL_FIELD_LITERAL = JavadocParser.SERIAL_FIELD_LITERAL;
 163  
 
 164  
     /**
 165  
      * '@param' literal in @param Javadoc tag.
 166  
      *
 167  
      * <p>Such Javadoc tag can have two arguments:</p>
 168  
      * <ol>
 169  
      * <li>{@link #PARAMETER_NAME}</li>
 170  
      * <li>{@link #DESCRIPTION}</li>
 171  
      * </ol>
 172  
      *
 173  
      * <p><b>Example:</b></p>
 174  
      * <pre>{@code @param T The bar.}</pre>
 175  
      * <b>Tree:</b>
 176  
      * <pre>{@code
 177  
      *   |--JAVADOC_TAG[4x3] : [@param T The bar.]
 178  
      *       |--PARAM_LITERAL[4x3] : [@param]
 179  
      *       |--WS[4x9] : [ ]
 180  
      *       |--PARAMETER_NAME[4x10] : [T]
 181  
      *       |--WS[4x11] : [ ]
 182  
      *       |--DESCRIPTION[4x12] : [The bar.]
 183  
      *           |--TEXT[4x12] : [The bar.]
 184  
      * }</pre>
 185  
      *
 186  
      * @see
 187  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHJECF">
 188  
      * Oracle Docs</a>
 189  
      * @see #JAVADOC_TAG
 190  
      */
 191  
     public static final int PARAM_LITERAL = JavadocParser.PARAM_LITERAL;
 192  
 
 193  
     /**
 194  
      * '@see' literal in @see Javadoc tag.
 195  
      *
 196  
      * <p>Such Javadoc tag can have one argument - {@link #REFERENCE}</p>
 197  
      *
 198  
      * <p><b>Example:</b></p>
 199  
      * <pre>{@code @see org.apache.utils.Lists.Comparator#compare(Object)}</pre>
 200  
      * <b>Tree:</b>
 201  
      * <pre>{@code
 202  
      *   |--JAVADOC_TAG[3x0] : [@see org.apache.utils.Lists.Comparator#compare(Object)]
 203  
      *       |--SEE_LITERAL[3x0] : [@see]
 204  
      *       |--WS[3x4] : [ ]
 205  
      *       |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
 206  
      *           |--PACKAGE_CLASS[3x5] : [org.apache.utils]
 207  
      *           |--DOT[3x21] : [.]
 208  
      *           |--CLASS[3x22] : [Lists]
 209  
      *           |--DOT[3x27] : [.]
 210  
      *           |--CLASS[3x28] : [Comparator]
 211  
      *           |--HASH[3x38] : [#]
 212  
      *           |--MEMBER[3x39] : [compare]
 213  
      *           |--PARAMETERS[3x46] : [(Object)]
 214  
      *               |--LEFT_BRACE[3x46] : [(]
 215  
      *               |--ARGUMENT[3x47] : [Object]
 216  
      *               |--RIGHT_BRACE[3x53] : [)]
 217  
      * }</pre>
 218  
      *
 219  
      * @see
 220  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDDIEDI">
 221  
      * Oracle Docs</a>
 222  
      * @see #JAVADOC_TAG
 223  
      */
 224  
     public static final int SEE_LITERAL = JavadocParser.SEE_LITERAL;
 225  
 
 226  
     /**
 227  
      * '@see' literal in @see Javadoc tag.
 228  
      *
 229  
      * <p>Such Javadoc tag can have one argument - {@link #REFERENCE} or {@link #LITERAL_EXCLUDE}
 230  
      * or {@link #LITERAL_INCLUDE}</p>
 231  
      *
 232  
      * <p><b>Example:</b></p>
 233  
      * <pre>{@code @serial include}</pre>
 234  
      * <b>Tree:</b>
 235  
      * <pre>{@code
 236  
      *   |--JAVADOC_TAG[3x0] : [@serial include]
 237  
      *       |--SERIAL_LITERAL[3x0] : [@serial]
 238  
      *       |--WS[3x7] : [ ]
 239  
      *       |--LITERAL_INCLUDE[3x8] : [include]
 240  
      * }</pre>
 241  
      *
 242  
      * <p><b>Example:</b></p>
 243  
      * <pre>{@code @serial serialized company name}</pre>
 244  
      * <b>Tree:</b>
 245  
      * <pre>{@code
 246  
      *   |--JAVADOC_TAG[3x0] : [@serial serialized company name]
 247  
      *       |--SERIAL_LITERAL[3x0] : [@serial]
 248  
      *       |--WS[3x7] : [ ]
 249  
      *       |--DESCRIPTION[3x8] : [serialized company name]
 250  
      *           |--TEXT[3x8] : [serialized company name]
 251  
      * }</pre>
 252  
      *
 253  
      * @see
 254  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
 255  
      * Oracle Docs</a>
 256  
      * @see #JAVADOC_TAG
 257  
      */
 258  
     public static final int SERIAL_LITERAL = JavadocParser.SERIAL_LITERAL;
 259  
 
 260  
     /**
 261  
      * '@version' literal in @version Javadoc tag.
 262  
      *
 263  
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
 264  
      *
 265  
      * <p><b>Example:</b></p>
 266  
      * <pre>{@code @version 1.3}</pre>
 267  
      * <b>Tree:</b>
 268  
      * <pre>{@code
 269  
      *   |--JAVADOC_TAG[3x0] : [@version 1.3]
 270  
      *       |--VERSION_LITERAL[3x0] : [@version]
 271  
      *       |--WS[3x8] : [ ]
 272  
      *       |--DESCRIPTION[3x9] : [1.3]
 273  
      *           |--TEXT[3x9] : [1.3]
 274  
      * }</pre>
 275  
      *
 276  
      * @see
 277  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCHBAE">
 278  
      * Oracle Docs</a>
 279  
      * @see #JAVADOC_TAG
 280  
      */
 281  
     public static final int VERSION_LITERAL = JavadocParser.VERSION_LITERAL;
 282  
 
 283  
     /**
 284  
      * '@exception' literal in @exception Javadoc tag.
 285  
      *
 286  
      * <p>Such Javadoc tag can have two argument - {@link #CLASS_NAME} and {@link #DESCRIPTION}</p>
 287  
      *
 288  
      * <p><b>Example:</b></p>
 289  
      * <pre>{@code @exception SQLException if query is not correct}</pre>
 290  
      * <b>Tree:</b>
 291  
      * <pre>{@code
 292  
      *   |--JAVADOC_TAG[3x0] : [@exception SQLException if query is not correct]
 293  
      *       |--EXCEPTION_LITERAL[3x0] : [@exception]
 294  
      *       |--WS[3x10] : [ ]
 295  
      *       |--CLASS_NAME[3x11] : [SQLException]
 296  
      *       |--WS[3x23] : [ ]
 297  
      *       |--DESCRIPTION[3x24] : [if query is not correct]
 298  
      *           |--TEXT[3x24] : [if query is not correct]
 299  
      * }</pre>
 300  
      *
 301  
      * @see
 302  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCEAHH">
 303  
      * Oracle Docs</a>
 304  
      * @see #JAVADOC_TAG
 305  
      */
 306  
     public static final int EXCEPTION_LITERAL = JavadocParser.EXCEPTION_LITERAL;
 307  
 
 308  
     /**
 309  
      * '@throws' literal in @throws Javadoc tag.
 310  
      *
 311  
      * <p>Such Javadoc tag can have two argument - {@link #CLASS_NAME} and {@link #DESCRIPTION}</p>
 312  
      *
 313  
      * <p><b>Example:</b></p>
 314  
      * <pre>{@code @throws SQLException if query is not correct}</pre>
 315  
      * <b>Tree:</b>
 316  
      * <pre>{@code
 317  
      *   |--JAVADOC_TAG[3x0] : [@throws SQLException if query is not correct]
 318  
      *       |--THROWS_LITERAL[3x0] : [@throws]
 319  
      *       |--WS[3x7] : [ ]
 320  
      *       |--CLASS_NAME[3x8] : [SQLException]
 321  
      *       |--WS[3x20] : [ ]
 322  
      *       |--DESCRIPTION[3x21] : [if query is not correct]
 323  
      *           |--TEXT[3x21] : [if query is not correct]
 324  
      * }</pre>
 325  
      *
 326  
      * @see
 327  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCHAHD">
 328  
      * Oracle Docs</a>
 329  
      * @see #JAVADOC_TAG
 330  
      */
 331  
     public static final int THROWS_LITERAL = JavadocParser.THROWS_LITERAL;
 332  
 
 333  
     /**
 334  
      * '@author' literal in @author Javadoc tag.
 335  
      *
 336  
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
 337  
      *
 338  
      * <p><b>Example:</b></p>
 339  
      * <pre>{@code @author Baratali Izmailov}</pre>
 340  
      * <b>Tree:</b>
 341  
      * <pre>{@code
 342  
      *   |--JAVADOC_TAG[3x0] : [@author Baratali Izmailov]
 343  
      *       |--AUTHOR_LITERAL[3x0] : [@author]
 344  
      *       |--WS[3x7] : [ ]
 345  
      *       |--DESCRIPTION[3x8] : [Baratali Izmailov]
 346  
      *           |--TEXT[3x8] : [Baratali Izmailov]
 347  
      * }</pre>
 348  
      *
 349  
      * @see
 350  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCBAHA">
 351  
      * Oracle Docs</a>
 352  
      * @see #JAVADOC_TAG
 353  
      */
 354  
     public static final int AUTHOR_LITERAL = JavadocParser.AUTHOR_LITERAL;
 355  
 
 356  
     /**
 357  
      * Name of custom Javadoc tag (or Javadoc inline tag).
 358  
      *
 359  
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
 360  
      *
 361  
      * <p><b>Example:</b></p>
 362  
      * <pre>{@code @myJavadocTag some magic}</pre>
 363  
      * <b>Tree:</b>
 364  
      * <pre>{@code
 365  
      *   |--JAVADOC_TAG[3x0] : [@myJavadocTag some magic]
 366  
      *       |--CUSTOM_NAME[3x0] : [@myJavadocTag]
 367  
      *       |--WS[3x13] : [ ]
 368  
      *       |--DESCRIPTION[3x14] : [some magic]
 369  
      *           |--TEXT[3x14] : [some magic]
 370  
      * }</pre>
 371  
      */
 372  
     public static final int CUSTOM_NAME = JavadocParser.CUSTOM_NAME;
 373  
 
 374  
     /**
 375  
      * First child of {@link #JAVADOC_INLINE_TAG} that represents left curly brace '{'.
 376  
      *
 377  
      * <p><b>Example:</b></p>
 378  
      * <pre>{@code {&#64;code Comparable&lt;E&gt;}}</pre>
 379  
      * <b>Tree:</b>
 380  
      * <pre>
 381  
      * {@code |--JAVADOC_INLINE_TAG[3x0] : [{&#64;code Comparable&lt;E&gt;}]
 382  
      *         |--JAVADOC_INLINE_TAG_START[3x0] : [{]
 383  
      *         |--CODE_LITERAL[3x1] : [@code]
 384  
      *         |--WS[3x6] : [ ]
 385  
      *         |--TEXT[3x7] : [Comparable&lt;E&gt;]
 386  
      *         |--JAVADOC_INLINE_TAG_END[3x21] : [}]
 387  
      * }</pre>
 388  
      */
 389  
     public static final int JAVADOC_INLINE_TAG_START = JavadocParser.JAVADOC_INLINE_TAG_START;
 390  
 
 391  
     /**
 392  
      * Last child of {@link #JAVADOC_INLINE_TAG} that represents right curly brace '}'.
 393  
      *
 394  
      * <p><b>Example:</b></p>
 395  
      * <pre>{@code {&#64;code Comparable&lt;E&gt;}}</pre>
 396  
      * <b>Tree:</b>
 397  
      * <pre>
 398  
      * {@code |--JAVADOC_INLINE_TAG[3x0] : [{&#64;code Comparable&lt;E&gt;}]
 399  
      *         |--JAVADOC_INLINE_TAG_START[3x0] : [{]
 400  
      *         |--CODE_LITERAL[3x1] : [@code]
 401  
      *         |--WS[3x6] : [ ]
 402  
      *         |--TEXT[3x7] : [Comparable&lt;E&gt;]
 403  
      *         |--JAVADOC_INLINE_TAG_END[3x21] : [}]
 404  
      * }
 405  
      * </pre>
 406  
      */
 407  
     public static final int JAVADOC_INLINE_TAG_END = JavadocParser.JAVADOC_INLINE_TAG_END;
 408  
 
 409  
     /**
 410  
      * '@code' literal in {&#64;code} Javadoc inline tag.
 411  
      *
 412  
      * <p>Such Javadoc inline tag can have such child nodes:</p>
 413  
      * <ul>
 414  
      * <li>{@link #NEWLINE}</li>
 415  
      * <li>{@link #WS}</li>
 416  
      * <li>{@link #TEXT}</li>
 417  
      * </ul>
 418  
      *
 419  
      * <p><b>Example:</b></p>
 420  
      * <pre>{@code {&#64;code Comparable&lt;E&gt;}}</pre>
 421  
      * <b>Tree:</b>
 422  
      * <pre>
 423  
      * {@code |--JAVADOC_INLINE_TAG[3x0] : [{&#64;code Comparable&lt;E&gt;}]
 424  
      *         |--JAVADOC_INLINE_TAG_START[3x0] : [{]
 425  
      *         |--CODE_LITERAL[3x1] : [@code]
 426  
      *         |--WS[3x6] : [ ]
 427  
      *         |--TEXT[3x7] : [Comparable&lt;E&gt;]
 428  
      *         |--JAVADOC_INLINE_TAG_END[3x21] : [}]
 429  
      * }
 430  
      * </pre>
 431  
      *
 432  
      * @see
 433  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDFHHBB">
 434  
      * Oracle Docs</a>
 435  
      * @see #JAVADOC_INLINE_TAG
 436  
      */
 437  
     public static final int CODE_LITERAL = JavadocParser.CODE_LITERAL;
 438  
 
 439  
     /**
 440  
      * '@docRoot' literal in {&#64;docRoot} Javadoc inline tag.
 441  
      *
 442  
      * <p>Such Javadoc inline tag does not have any arguments and can have such child nodes:</p>
 443  
      * <ul>
 444  
      * <li>{@link #NEWLINE}</li>
 445  
      * <li>{@link #WS}</li>
 446  
      * </ul>
 447  
      *
 448  
      * <p><b>Example:</b></p>
 449  
      * <pre>{@code {&#64;docRoot}}</pre>
 450  
      * <b>Tree:</b>
 451  
      * <pre>
 452  
      * {@code  |--JAVADOC_INLINE_TAG[1x0] : [{&#64;docRoot \n}]
 453  
      *            |--JAVADOC_INLINE_TAG_START[1x0] : [{]
 454  
      *            |--DOC_ROOT_LITERAL[1x1] : [@docRoot]
 455  
      *            |--JAVADOC_INLINE_TAG_END[2x0] : [}]
 456  
      * }
 457  
      * </pre>
 458  
      *
 459  
      * <p><b>Example:</b></p>
 460  
      * <pre>{@code {&#64;docRoot
 461  
      *}}</pre>
 462  
      * <b>Tree:</b>
 463  
      * <pre>
 464  
      * {@code  |--JAVADOC_INLINE_TAG[1x0] : [{&#64;docRoot \n}]
 465  
      *            |--JAVADOC_INLINE_TAG_START[1x0] : [{]
 466  
      *            |--DOC_ROOT_LITERAL[1x1] : [@docRoot]
 467  
      *            |--WS[1x9] : [ ]
 468  
      *            |--NEWLINE[1x10] : [\n]
 469  
      *            |--JAVADOC_INLINE_TAG_END[2x0] : [}]
 470  
      * }
 471  
      * </pre>
 472  
      *
 473  
      * @see
 474  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDBACBF">
 475  
      * Oracle Docs</a>
 476  
      * @see #JAVADOC_INLINE_TAG
 477  
      */
 478  
     public static final int DOC_ROOT_LITERAL = JavadocParser.DOC_ROOT_LITERAL;
 479  
 
 480  
     /**
 481  
      * '@link' literal in {&#64;link} Javadoc inline tag.
 482  
      * <p>Such Javadoc inline tag can have one argument - {@link #REFERENCE}</p>
 483  
      * <p><b>Example:</b></p>
 484  
      * <pre>{@code {&#64;link org.apache.utils.Lists.Comparator#compare(Object)}}</pre>
 485  
      * <p><b>Tree:</b></p>
 486  
      * <pre>
 487  
      * {@code |--JAVADOC_INLINE_TAG[1x0] :
 488  
      *               [{&#64;link org.apache.utils.Lists.Comparator#compare(Object)}]
 489  
      *        |--JAVADOC_INLINE_TAG_START[1x0] : [{]
 490  
      *        |--LINK_LITERAL[1x1] : [@link]
 491  
      *        |--WS[1x6] : [ ]
 492  
      *        |--REFERENCE[1x7] : [org.apache.utils.Lists.Comparator#compare(Object)]
 493  
      *            |--PACKAGE_CLASS[1x7] : [org.apache.utils]
 494  
      *            |--DOT[1x23] : [.]
 495  
      *            |--CLASS[1x24] : [Lists]
 496  
      *            |--DOT[1x29] : [.]
 497  
      *            |--CLASS[1x30] : [Comparator]
 498  
      *            |--HASH[1x40] : [#]
 499  
      *            |--MEMBER[1x41] : [compare]
 500  
      *            |--PARAMETERS[1x48] : [(Object)]
 501  
      *                |--LEFT_BRACE[1x48] : [(]
 502  
      *                |--ARGUMENT[1x49] : [Object]
 503  
      *                |--RIGHT_BRACE[1x55] : [)]
 504  
      *        |--JAVADOC_INLINE_TAG_END[1x56] : [}]
 505  
      * }
 506  
      * </pre>
 507  
      *
 508  
      * @see
 509  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDDIECH">
 510  
      * Oracle Docs</a>
 511  
      * @see #JAVADOC_INLINE_TAG
 512  
      */
 513  
     public static final int LINK_LITERAL = JavadocParser.LINK_LITERAL;
 514  
 
 515  
     /**
 516  
      * '@inheritDoc' literal in {&#64;inheritDoc} Javadoc inline tag.
 517  
      *
 518  
      * <p>Such Javadoc inline tag does not have any arguments and can have such child nodes:</p>
 519  
      * <ul>
 520  
      * <li>{@link #NEWLINE}</li>
 521  
      * <li>{@link #WS}</li>
 522  
      * </ul>
 523  
      *
 524  
      * <p><b>Example:</b></p>
 525  
      * <pre>{@code {&#64;inheritDoc}}</pre>
 526  
      * <b>Tree:</b>
 527  
      * <pre>
 528  
      * {@code  |--JAVADOC_INLINE_TAG[1x0] : [{&#64;inheritDoc}]
 529  
      *            |--JAVADOC_INLINE_TAG_START[1x0] : [{]
 530  
      *            |--INHERIT_DOC_LITERAL[1x1] : [@inheritDoc]
 531  
      *            |--JAVADOC_INLINE_TAG_END[1x12] : [}]
 532  
      * }
 533  
      * </pre>
 534  
      *
 535  
      * @see
 536  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDGJCHC">
 537  
      * Oracle Docs</a>
 538  
      * @see #JAVADOC_INLINE_TAG
 539  
      */
 540  
     public static final int INHERIT_DOC_LITERAL = JavadocParser.INHERIT_DOC_LITERAL;
 541  
 
 542  
     /**
 543  
      * '@linkplain' literal in {&#64;linkplain} Javadoc inline tag.
 544  
      *
 545  
      * <p>Such Javadoc inline tag can have one argument - {@link #REFERENCE}</p>
 546  
      *
 547  
      * <p><b>Example:</b></p>
 548  
      * <pre>{@code {&#64;linkplain org.apache.utils.Lists.Comparator#compare(Object) compare}}</pre>
 549  
      * <b>Tree:</b>
 550  
      * <pre>
 551  
      * {@code |--JAVADOC_INLINE_TAG[1x0] :
 552  
      *               [{&#64;linkplain org.apache.utils.Lists.Comparator#compare(Object) compare}]
 553  
      *        |--JAVADOC_INLINE_TAG_START[1x0] : [{]
 554  
      *        |--LINKPLAIN_LITERAL[1x1] : [@linkplain]
 555  
      *        |--WS[1x11] : [ ]
 556  
      *        |--REFERENCE[1x12] : [org.apache.utils.Lists.Comparator#compare(Object)]
 557  
      *            |--PACKAGE_CLASS[1x12] : [org.apache.utils]
 558  
      *            |--DOT[1x28] : [.]
 559  
      *            |--CLASS[1x29] : [Lists]
 560  
      *            |--DOT[1x34] : [.]
 561  
      *            |--CLASS[1x35] : [Comparator]
 562  
      *            |--HASH[1x45] : [#]
 563  
      *            |--MEMBER[1x46] : [compare]
 564  
      *            |--PARAMETERS[1x53] : [(Object)]
 565  
      *                |--LEFT_BRACE[1x53] : [(]
 566  
      *                |--ARGUMENT[1x54] : [Object]
 567  
      *                |--RIGHT_BRACE[1x60] : [)]
 568  
      *        |--DESCRIPTION[1x61] : [ compare]
 569  
      *            |--TEXT[1x61] : [ compare]
 570  
      *        |--JAVADOC_INLINE_TAG_END[1x69] : [}]
 571  
      * }
 572  
      * </pre>
 573  
      *
 574  
      * @see
 575  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDGBICD">
 576  
      * Oracle Docs</a>
 577  
      * @see #JAVADOC_INLINE_TAG
 578  
      */
 579  
     public static final int LINKPLAIN_LITERAL = JavadocParser.LINKPLAIN_LITERAL;
 580  
 
 581  
     /**
 582  
      * '@literal' literal in {&#64;literal} Javadoc inline tag.
 583  
      *
 584  
      * <p>Such Javadoc inline tag can have such child nodes:</p>
 585  
      * <ul>
 586  
      * <li>{@link #NEWLINE}</li>
 587  
      * <li>{@link #WS}</li>
 588  
      * <li>{@link #TEXT}</li>
 589  
      * </ul>
 590  
      *
 591  
      * <p><b>Example:</b></p>
 592  
      * <pre>{@code {&#64;literal #compare(Object)}}</pre>
 593  
      * <b>Tree:</b>
 594  
      * <pre>
 595  
      * {@code |--JAVADOC_INLINE_TAG[1x0] : [{&#64;literal #compare(Object)}]
 596  
      *        |--JAVADOC_INLINE_TAG_START[1x0] : [{]
 597  
      *        |--LITERAL_LITERAL[1x1] : [@literal]
 598  
      *        |--WS[1x9] : [ ]
 599  
      *        |--TEXT[1x10] : [#compare(Object)]
 600  
      *        |--JAVADOC_INLINE_TAG_END[1x27] : [}]
 601  
      * }
 602  
      * </pre>
 603  
      *
 604  
      * @see
 605  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDCFJDG">
 606  
      * Oracle Docs</a>
 607  
      * @see #JAVADOC_INLINE_TAG
 608  
      */
 609  
     public static final int LITERAL_LITERAL = JavadocParser.LITERAL_LITERAL;
 610  
 
 611  
     /**
 612  
      * '@value' literal in {&#64;value} Javadoc inline tag.
 613  
      *
 614  
      * <p>Such Javadoc inline tag has one argument {@link #REFERENCE}
 615  
      * and can have such child nodes:</p>
 616  
      * <ul>
 617  
      * <li>{@link #NEWLINE}</li>
 618  
      * <li>{@link #WS}</li>
 619  
      * </ul>
 620  
      *
 621  
      * <p><b>Example:</b></p>
 622  
      * <pre>{@code {&#64;value Integer#MAX_VALUE}}</pre>
 623  
      * <b>Tree:</b>
 624  
      * <pre>
 625  
      * {@code |--JAVADOC_INLINE_TAG[1x0] : [{&#64;value Integer#MAX_VALUE}]
 626  
      *        |--JAVADOC_INLINE_TAG_START[1x0] : [{]
 627  
      *        |--VALUE_LITERAL[1x1] : [@value]
 628  
      *        |--WS[1x7] : [ ]
 629  
      *        |--REFERENCE[1x8] : [Integer#MAX_VALUE]
 630  
      *            |--CLASS[1x8] : [Integer]
 631  
      *            |--HASH[1x15] : [#]
 632  
      *            |--MEMBER[1x16] : [MAX_VALUE]
 633  
      *        |--JAVADOC_INLINE_TAG_END[1x25] : [}]
 634  
      * }
 635  
      * </pre>
 636  
      *
 637  
      * @see
 638  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDDCDHH">
 639  
      * Oracle Docs</a>
 640  
      * @see #JAVADOC_INLINE_TAG
 641  
      */
 642  
     public static final int VALUE_LITERAL = JavadocParser.VALUE_LITERAL;
 643  
 
 644  
     /**
 645  
      * PACKAGE_CLASS represents the package or class which has been referenced in the `@see`,
 646  
      * `@link`, `@linkplain` or `@value` javadoc tags. In the javadoc tree it shall be a child
 647  
      * of {@link #REFERENCE}.
 648  
      * <br>
 649  
      * <strong>IMPORTANT:</strong> Constructs like
 650  
      * {@code package.Class.NestedClassAtDepth1.NestedClassAtDepth2#member} are recognized by
 651  
      * the javadoc tool from oracle, and no assumptions like, package names wouldn't consist of
 652  
      * uppercase characters or class names begin with an uppercase character, are made.
 653  
      * Also, <i>the reference</i> in a javadoc tag can consist just a package name or a
 654  
      * simple class name or even a full class name. Thus, PACKAGE_CLASS can represent a
 655  
      * package name or a simple class name or a full class name i.e checkstyle doesn't
 656  
      * resolve references at present.
 657  
      *
 658  
      * <p><b>Example:</b></p>
 659  
      * <pre>{@code @see org.apache.utils.Lists.Comparator#compare(Object)}</pre>
 660  
      * <b>Tree:</b>
 661  
      * <pre>
 662  
      * {@code |--JAVADOC_TAG[3x0] : [@see org.apache.utils.Lists.Comparator#compare(Object)]
 663  
      *        |--SEE_LITERAL[3x0] : [@see]
 664  
      *        |--WS[3x4] : [ ]
 665  
      *        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
 666  
      *            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
 667  
      *            |--DOT[3x21] : [.]
 668  
      *            |--CLASS[3x22] : [Lists]
 669  
      *            |--DOT[3x27] : [.]
 670  
      *            |--CLASS[3x28] : [Comparator]
 671  
      *            |--HASH[3x38] : [#]
 672  
      *            |--MEMBER[3x39] : [compare]
 673  
      *            |--PARAMETERS[3x46] : [(Object)]
 674  
      *                |--LEFT_BRACE[3x46] : [(]
 675  
      *                |--ARGUMENT[3x47] : [Object]
 676  
      *                |--RIGHT_BRACE[3x53] : [)]
 677  
      * }
 678  
      * </pre>
 679  
      */
 680  
     public static final int PACKAGE_CLASS = JavadocParser.PACKAGE_CLASS;
 681  
 
 682  
     /**
 683  
      * Hash character in {@link #REFERENCE}.
 684  
      * Hash character is used before specifying a class member.
 685  
      *
 686  
      * <p><b>Example:</b></p>
 687  
      * <pre>{@code @see org.apache.utils.Lists.Comparator#compare(Object)}</pre>
 688  
      * <b>Tree:</b>
 689  
      * <pre>
 690  
      * {@code |--JAVADOC_TAG[3x0] : [@see org.apache.utils.Lists.Comparator#compare(Object)]
 691  
      *        |--SEE_LITERAL[3x0] : [@see]
 692  
      *        |--WS[3x4] : [ ]
 693  
      *        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
 694  
      *            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
 695  
      *            |--DOT[3x21] : [.]
 696  
      *            |--CLASS[3x22] : [Lists]
 697  
      *            |--DOT[3x27] : [.]
 698  
      *            |--CLASS[3x28] : [Comparator]
 699  
      *            |--HASH[3x38] : [#]
 700  
      *            |--MEMBER[3x39] : [compare]
 701  
      *            |--PARAMETERS[3x46] : [(Object)]
 702  
      *                |--LEFT_BRACE[3x46] : [(]
 703  
      *                |--ARGUMENT[3x47] : [Object]
 704  
      *                |--RIGHT_BRACE[3x53] : [)]
 705  
      * }
 706  
      * </pre>
 707  
      */
 708  
     public static final int HASH = JavadocParser.HASH;
 709  
 
 710  
     /**
 711  
      * A class member in {@link #REFERENCE}.
 712  
      * Class member is specified after {@link #HASH} symbol.
 713  
      *
 714  
      * <p><b>Example:</b></p>
 715  
      * <pre>{@code @see org.apache.utils.Lists.Comparator#compare(Object)}</pre>
 716  
      * <b>Tree:</b>
 717  
      * <pre>
 718  
      * {@code |--JAVADOC_TAG[3x0] : [@see org.apache.utils.Lists.Comparator#compare(Object)]
 719  
      *        |--SEE_LITERAL[3x0] : [@see]
 720  
      *        |--WS[3x4] : [ ]
 721  
      *        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
 722  
      *            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
 723  
      *            |--DOT[3x21] : [.]
 724  
      *            |--CLASS[3x22] : [Lists]
 725  
      *            |--DOT[3x27] : [.]
 726  
      *            |--CLASS[3x28] : [Comparator]
 727  
      *            |--HASH[3x38] : [#]
 728  
      *            |--MEMBER[3x39] : [compare]
 729  
      *            |--PARAMETERS[3x46] : [(Object)]
 730  
      *                |--LEFT_BRACE[3x46] : [(]
 731  
      *                |--ARGUMENT[3x47] : [Object]
 732  
      *                |--RIGHT_BRACE[3x53] : [)]
 733  
      * }
 734  
      * </pre>
 735  
      */
 736  
     public static final int MEMBER = JavadocParser.MEMBER;
 737  
 
 738  
     /**
 739  
      * Left brace in {@link #PARAMETERS} part of {@link #REFERENCE}.
 740  
      *
 741  
      * <p><b>Example:</b></p>
 742  
      * <pre>{@code @see #method(Processor, String)}</pre>
 743  
      * <b>Tree:</b>
 744  
      * <pre>
 745  
      * {@code |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
 746  
      *        |--SEE_LITERAL[1x0] : [@see]
 747  
      *        |--WS[1x4] : [ ]
 748  
      *        |--REFERENCE[1x5] : [#method(Processor, String)]
 749  
      *            |--HASH[1x5] : [#]
 750  
      *            |--MEMBER[1x6] : [method]
 751  
      *            |--PARAMETERS[1x12] : [(Processor, String)]
 752  
      *                |--LEFT_BRACE[1x12] : [(]
 753  
      *                |--ARGUMENT[1x13] : [Processor]
 754  
      *                |--COMMA[1x22] : [,]
 755  
      *                |--WS[1x23] : [ ]
 756  
      *                |--ARGUMENT[1x24] : [String]
 757  
      *                |--RIGHT_BRACE[1x30] : [)]
 758  
      * }
 759  
      * </pre>
 760  
      */
 761  
     public static final int LEFT_BRACE = JavadocParser.LEFT_BRACE;
 762  
 
 763  
     /**
 764  
      * Right brace in {@link #PARAMETERS} part of {@link #REFERENCE}.
 765  
      *
 766  
      * <p><b>Example:</b></p>
 767  
      * <pre>{@code @see #method(Processor, String)}</pre>
 768  
      * <b>Tree:</b>
 769  
      * <pre>
 770  
      * {@code |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
 771  
      *        |--SEE_LITERAL[1x0] : [@see]
 772  
      *        |--WS[1x4] : [ ]
 773  
      *        |--REFERENCE[1x5] : [#method(Processor, String)]
 774  
      *            |--HASH[1x5] : [#]
 775  
      *            |--MEMBER[1x6] : [method]
 776  
      *            |--PARAMETERS[1x12] : [(Processor, String)]
 777  
      *                |--LEFT_BRACE[1x12] : [(]
 778  
      *                |--ARGUMENT[1x13] : [Processor]
 779  
      *                |--COMMA[1x22] : [,]
 780  
      *                |--WS[1x23] : [ ]
 781  
      *                |--ARGUMENT[1x24] : [String]
 782  
      *                |--RIGHT_BRACE[1x30] : [)]
 783  
      * }
 784  
      * </pre>
 785  
      */
 786  
     public static final int RIGHT_BRACE = JavadocParser.RIGHT_BRACE;
 787  
 
 788  
     /**
 789  
      * Argument definition in {@link #PARAMETERS} part of {@link #REFERENCE}.
 790  
      *
 791  
      * <p><b>Example:</b></p>
 792  
      * <pre>{@code @see #method(Processor, String)}</pre>
 793  
      * <b>Tree:</b>
 794  
      * <pre>
 795  
      * {@code |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
 796  
      *        |--SEE_LITERAL[1x0] : [@see]
 797  
      *        |--WS[1x4] : [ ]
 798  
      *        |--REFERENCE[1x5] : [#method(Processor, String)]
 799  
      *            |--HASH[1x5] : [#]
 800  
      *            |--MEMBER[1x6] : [method]
 801  
      *            |--PARAMETERS[1x12] : [(Processor, String)]
 802  
      *                |--LEFT_BRACE[1x12] : [(]
 803  
      *                |--ARGUMENT[1x13] : [Processor]
 804  
      *                |--COMMA[1x22] : [,]
 805  
      *                |--WS[1x23] : [ ]
 806  
      *                |--ARGUMENT[1x24] : [String]
 807  
      *                |--RIGHT_BRACE[1x30] : [)]
 808  
      * }
 809  
      * </pre>
 810  
      */
 811  
     public static final int ARGUMENT = JavadocParser.ARGUMENT;
 812  
 
 813  
     /**
 814  
      * Comma separator between parameters in {@link #PARAMETERS} part of {@link #REFERENCE}.
 815  
      *
 816  
      * <p><b>Example:</b></p>
 817  
      * <pre>{@code @see #method(Processor, String)}</pre>
 818  
      * <b>Tree:</b>
 819  
      * <pre>
 820  
      * {@code |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
 821  
      *        |--SEE_LITERAL[1x0] : [@see]
 822  
      *        |--WS[1x4] : [ ]
 823  
      *        |--REFERENCE[1x5] : [#method(Processor, String)]
 824  
      *            |--HASH[1x5] : [#]
 825  
      *            |--MEMBER[1x6] : [method]
 826  
      *            |--PARAMETERS[1x12] : [(Processor, String)]
 827  
      *                |--LEFT_BRACE[1x12] : [(]
 828  
      *                |--ARGUMENT[1x13] : [Processor]
 829  
      *                |--COMMA[1x22] : [,]
 830  
      *                |--WS[1x23] : [ ]
 831  
      *                |--ARGUMENT[1x24] : [String]
 832  
      *                |--RIGHT_BRACE[1x30] : [)]
 833  
      * }
 834  
      * </pre>
 835  
      *
 836  
      * @see #PARAMETERS
 837  
      * @see #REFERENCE
 838  
      * @see #ARGUMENT
 839  
      */
 840  
     public static final int COMMA = JavadocParser.COMMA;
 841  
 
 842  
     /**
 843  
      * Quoted text.
 844  
      * One of possible @see tag arguments.
 845  
      *
 846  
      * <p><b>Example:</b></p>
 847  
      * <pre>{@code @see "Spring Framework"}</pre>
 848  
      * <b>Tree:</b>
 849  
      * <pre>
 850  
      * {@code |--JAVADOC_TAG[1x0] : [@see "Spring Framework"]
 851  
      *        |--SEE_LITERAL[1x0] : [@see]
 852  
      *        |--WS[1x4] : [ ]
 853  
      *        |--STRING[1x5] : ["Spring Framework"]
 854  
      * }
 855  
      * </pre>
 856  
      *
 857  
      * @see #SEE_LITERAL
 858  
      */
 859  
     public static final int STRING = JavadocParser.STRING;
 860  
 
 861  
     /**
 862  
      * Exception class name. First argument in {@link #THROWS_LITERAL @throws} and
 863  
      * {@link #EXCEPTION_LITERAL @exception} Javadoc tags.
 864  
      *
 865  
      * <p><b>Example:</b></p>
 866  
      * <pre>{@code @throws IOException connection problems}</pre>
 867  
      * <b>Tree:</b>
 868  
      * <pre>
 869  
      * {@code |--JAVADOC_TAG[1x0] : [@throws IOException connection problems]
 870  
      *        |--THROWS_LITERAL[1x0] : [@throws]
 871  
      *        |--WS[1x7] : [ ]
 872  
      *        |--CLASS_NAME[1x8] : [IOException]
 873  
      *        |--WS[1x19] : [ ]
 874  
      *        |--DESCRIPTION[1x20] : [connection problems]
 875  
      *            |--TEXT[1x20] : [connection problems]
 876  
      * }
 877  
      * </pre>
 878  
      *
 879  
      * @see #EXCEPTION_LITERAL
 880  
      * @see #THROWS_LITERAL
 881  
      */
 882  
     public static final int CLASS_NAME = JavadocParser.CLASS_NAME;
 883  
 
 884  
     /**
 885  
      * First argument in {@link #PARAM_LITERAL @param} Javadoc tag.
 886  
      *
 887  
      * <p><b>Example:</b></p>
 888  
      * <pre>{@code @param T The bar.}</pre>
 889  
      * <b>Tree:</b>
 890  
      * <pre>
 891  
      * {@code |--JAVADOC_TAG[4x3] : [@param T The bar.]
 892  
      *        |--PARAM_LITERAL[4x3] : [@param]
 893  
      *        |--WS[4x9] : [ ]
 894  
      *        |--PARAMETER_NAME[4x10] : [T]
 895  
      *        |--WS[4x11] : [ ]
 896  
      *        |--DESCRIPTION[4x12] : [The bar.]
 897  
      *            |--TEXT[4x12] : [The bar.]
 898  
      * }
 899  
      * </pre>
 900  
      *
 901  
      * @see
 902  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHJECF">
 903  
      * Oracle Docs</a>
 904  
      * @see #PARAM_LITERAL
 905  
      */
 906  
     public static final int PARAMETER_NAME = JavadocParser.PARAMETER_NAME;
 907  
 
 908  
     /**
 909  
      * 'exclude' literal.
 910  
      * One of three possible {@link #SERIAL_LITERAL @serial} tag arguments.
 911  
      *
 912  
      * <p><b>Example:</b></p>
 913  
      * <pre>{@code @serial exclude}</pre>
 914  
      * <b>Tree:</b>
 915  
      * <pre>
 916  
      * {@code |--JAVADOC_TAG[1x0] : [@serial exclude]
 917  
      *        |--SERIAL_LITERAL[1x0] : [@serial]
 918  
      *        |--WS[1x7] : [ ]
 919  
      *        |--LITERAL_EXCLUDE[1x8] : [exclude]
 920  
      * }
 921  
      * </pre>
 922  
      *
 923  
      * @see
 924  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
 925  
      * Oracle Docs</a>
 926  
      * @see #SERIAL_LITERAL
 927  
      */
 928  
     public static final int LITERAL_EXCLUDE = JavadocParser.LITERAL_EXCLUDE;
 929  
 
 930  
     /**
 931  
      * 'include' literal.
 932  
      * One of three possible {@link #SERIAL_LITERAL @serial} tag arguments.
 933  
      *
 934  
      * <p><b>Example:</b></p>
 935  
      * <pre>{@code @serial include}</pre>
 936  
      * <b>Tree:</b>
 937  
      * <pre>
 938  
      * {@code |--JAVADOC_TAG[1x0] : [@serial include]
 939  
      *        |--SERIAL_LITERAL[1x0] : [@serial]
 940  
      *        |--WS[1x7] : [ ]
 941  
      *        |--LITERAL_INCLUDE[1x8] : [include]
 942  
      * }
 943  
      * </pre>
 944  
      *
 945  
      * @see
 946  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
 947  
      * Oracle Docs</a>
 948  
      * @see #SERIAL_LITERAL
 949  
      */
 950  
     public static final int LITERAL_INCLUDE = JavadocParser.LITERAL_INCLUDE;
 951  
 
 952  
     /**
 953  
      * Field name. First argument of {@link #SERIAL_FIELD_LITERAL @serialField} Javadoc tag.
 954  
      *
 955  
      * <p><b>Example:</b></p>
 956  
      * <pre>{@code @serialField counter Integer objects counter}</pre>
 957  
      * <b>Tree:</b>
 958  
      * <pre>
 959  
      * {@code |--JAVADOC_TAG[3x0] : [@serialField counter Integer objects counter]
 960  
      *        |--SERIAL_FIELD_LITERAL[3x0] : [@serialField]
 961  
      *        |--WS[3x12] : [ ]
 962  
      *        |--FIELD_NAME[3x13] : [counter]
 963  
      *        |--WS[3x20] : [ ]
 964  
      *        |--FIELD_TYPE[3x21] : [Integer]
 965  
      *        |--WS[3x28] : [ ]
 966  
      *        |--DESCRIPTION[3x29] : [objects counter]
 967  
      *            |--TEXT[3x29] : [objects counter]
 968  
      * }
 969  
      * </pre>
 970  
      *
 971  
      * @see
 972  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
 973  
      * Oracle Docs</a>
 974  
      * @see #SERIAL_FIELD_LITERAL
 975  
      */
 976  
     public static final int FIELD_NAME = JavadocParser.FIELD_NAME;
 977  
 
 978  
     /**
 979  
      * Field type. Second argument of {@link #SERIAL_FIELD_LITERAL @serialField} Javadoc tag.
 980  
      *
 981  
      * <p><b>Example:</b></p>
 982  
      * <pre>{@code @serialField counter Integer objects counter}</pre>
 983  
      * <b>Tree:</b>
 984  
      * <pre>
 985  
      * {@code |--JAVADOC_TAG[3x0] : [@serialField counter Integer objects counter]
 986  
      *        |--SERIAL_FIELD_LITERAL[3x0] : [@serialField]
 987  
      *        |--WS[3x12] : [ ]
 988  
      *        |--FIELD_NAME[3x13] : [counter]
 989  
      *        |--WS[3x20] : [ ]
 990  
      *        |--FIELD_TYPE[3x21] : [Integer]
 991  
      *        |--WS[3x28] : [ ]
 992  
      *        |--DESCRIPTION[3x29] : [objects counter]
 993  
      *            |--TEXT[3x29] : [objects counter]
 994  
      * }
 995  
      * </pre>
 996  
      *
 997  
      * @see
 998  
      * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDHDECF">
 999  
      * Oracle Docs</a>
 1000  
      * @see #SERIAL_FIELD_LITERAL
 1001  
      */
 1002  
     public static final int FIELD_TYPE = JavadocParser.FIELD_TYPE;
 1003  
 
 1004  
     //--------------------------------------------------------------------------------------------//
 1005  
     //------------------        HTML TAGS          -----------------------------------------------//
 1006  
     //--------------------------------------------------------------------------------------------//
 1007  
 
 1008  
     /**
 1009  
      * Identifier inside HTML tag: tag name or attribute name.
 1010  
      */
 1011  
     public static final int HTML_TAG_NAME = JavadocParser.HTML_TAG_NAME;
 1012  
 
 1013  
     // HTML tag components
 1014  
 
 1015  
     /**
 1016  
      * Start html tag component: {@code '<'}.
 1017  
      */
 1018  
     public static final int START = JavadocParser.START;
 1019  
 
 1020  
     /**
 1021  
      * Slash html tag component: {@code '/'}.
 1022  
      */
 1023  
     public static final int SLASH = JavadocParser.SLASH;
 1024  
 
 1025  
     /**
 1026  
      * End html tag component: {@code '>'}.
 1027  
      */
 1028  
     public static final int END = JavadocParser.END;
 1029  
 
 1030  
     /**
 1031  
      * Slash close html tag component: {@code '/>'}.
 1032  
      */
 1033  
     public static final int SLASH_END = JavadocParser.SLASH_END;
 1034  
 
 1035  
     /**
 1036  
      * Equals html tag component: {@code '='}.
 1037  
      */
 1038  
     public static final int EQUALS = JavadocParser.EQUALS;
 1039  
 
 1040  
     /**
 1041  
      * Attribute value html tag component.
 1042  
      */
 1043  
     public static final int ATTR_VALUE = JavadocParser.ATTR_VALUE;
 1044  
 
 1045  
     /////////////////////// HTML TAGS WITH OPTIONAL END TAG /////////////////////////////////////
 1046  
     /** Paragraph tag name. */
 1047  
     public static final int P_HTML_TAG_NAME = JavadocParser.P_HTML_TAG_NAME;
 1048  
 
 1049  
     /** List item tag name. */
 1050  
     public static final int LI_HTML_TAG_NAME = JavadocParser.LI_HTML_TAG_NAME;
 1051  
 
 1052  
     /** Table row tag name. */
 1053  
     public static final int TR_HTML_TAG_NAME = JavadocParser.TR_HTML_TAG_NAME;
 1054  
 
 1055  
     /** Table cell tag name. */
 1056  
     public static final int TD_HTML_TAG_NAME = JavadocParser.TD_HTML_TAG_NAME;
 1057  
 
 1058  
     /** Table header cell tag name. */
 1059  
     public static final int TH_HTML_TAG_NAME = JavadocParser.TH_HTML_TAG_NAME;
 1060  
 
 1061  
     /** Body tag name. */
 1062  
     public static final int BODY_HTML_TAG_NAME = JavadocParser.BODY_HTML_TAG_NAME;
 1063  
 
 1064  
     /** Colgroup tag name. */
 1065  
     public static final int COLGROUP_HTML_TAG_NAME = JavadocParser.COLGROUP_HTML_TAG_NAME;
 1066  
 
 1067  
     /** Description of a term tag name. */
 1068  
     public static final int DD_HTML_TAG_NAME = JavadocParser.DD_HTML_TAG_NAME;
 1069  
 
 1070  
     /** Description term tag name. */
 1071  
     public static final int DT_HTML_TAG_NAME = JavadocParser.DT_HTML_TAG_NAME;
 1072  
 
 1073  
     /** Head tag name. */
 1074  
     public static final int HEAD_HTML_TAG_NAME = JavadocParser.HEAD_HTML_TAG_NAME;
 1075  
 
 1076  
     /** Html tag name. */
 1077  
     public static final int HTML_HTML_TAG_NAME = JavadocParser.HTML_HTML_TAG_NAME;
 1078  
 
 1079  
     /** Option tag name. */
 1080  
     public static final int OPTION_HTML_TAG_NAME = JavadocParser.OPTION_HTML_TAG_NAME;
 1081  
 
 1082  
     /** Table body tag name. */
 1083  
     public static final int TBODY_HTML_TAG_NAME = JavadocParser.TBODY_HTML_TAG_NAME;
 1084  
 
 1085  
     /** Table foot tag name. */
 1086  
     public static final int TFOOT_HTML_TAG_NAME = JavadocParser.TFOOT_HTML_TAG_NAME;
 1087  
 
 1088  
     /** Table head tag name. */
 1089  
     public static final int THEAD_HTML_TAG_NAME = JavadocParser.THEAD_HTML_TAG_NAME;
 1090  
     ///////////////////////////////////////////////////////////////////////////////////////////////
 1091  
 
 1092  
     /////////////////////// SINGLETON HTML TAGS  //////////////////////////////////////////////////
 1093  
     /** Area tag name. */
 1094  
     public static final int AREA_HTML_TAG_NAME = JavadocParser.AREA_HTML_TAG_NAME;
 1095  
 
 1096  
     /** Base tag name. */
 1097  
     public static final int BASE_HTML_TAG_NAME = JavadocParser.BASE_HTML_TAG_NAME;
 1098  
 
 1099  
     /** Basefont tag name. */
 1100  
     public static final int BASEFONT_HTML_TAG_NAME = JavadocParser.BASEFONT_HTML_TAG_NAME;
 1101  
 
 1102  
     /** Br tag name. */
 1103  
     public static final int BR_HTML_TAG_NAME = JavadocParser.BR_HTML_TAG_NAME;
 1104  
 
 1105  
     /** Col tag name. */
 1106  
     public static final int COL_HTML_TAG_NAME = JavadocParser.COL_HTML_TAG_NAME;
 1107  
 
 1108  
     /** Frame tag name. */
 1109  
     public static final int FRAME_HTML_TAG_NAME = JavadocParser.FRAME_HTML_TAG_NAME;
 1110  
 
 1111  
     /** Hr tag name. */
 1112  
     public static final int HR_HTML_TAG_NAME = JavadocParser.HR_HTML_TAG_NAME;
 1113  
 
 1114  
     /** Img tag name. */
 1115  
     public static final int IMG_HTML_TAG_NAME = JavadocParser.IMG_HTML_TAG_NAME;
 1116  
 
 1117  
     /** Input tag name. */
 1118  
     public static final int INPUT_HTML_TAG_NAME = JavadocParser.INPUT_HTML_TAG_NAME;
 1119  
 
 1120  
     /** Isindex tag name. */
 1121  
     public static final int ISINDEX_HTML_TAG_NAME = JavadocParser.ISINDEX_HTML_TAG_NAME;
 1122  
 
 1123  
     /** Link tag name. */
 1124  
     public static final int LINK_HTML_TAG_NAME = JavadocParser.LINK_HTML_TAG_NAME;
 1125  
 
 1126  
     /** Meta tag name. */
 1127  
     public static final int META_HTML_TAG_NAME = JavadocParser.META_HTML_TAG_NAME;
 1128  
 
 1129  
     /** Param tag name. */
 1130  
     public static final int PARAM_HTML_TAG_NAME = JavadocParser.PARAM_HTML_TAG_NAME;
 1131  
     /** "embed" tag name. */
 1132  
     public static final int EMBED_HTML_TAG_NAME = JavadocParser.EMBED_HTML_TAG_NAME;
 1133  
     /** "keygen" tag name. */
 1134  
     public static final int KEYGEN_HTML_TAG_NAME = JavadocParser.KEYGEN_HTML_TAG_NAME;
 1135  
     /** "source" tag name. */
 1136  
     public static final int SOURCE_HTML_TAG_NAME = JavadocParser.SOURCE_HTML_TAG_NAME;
 1137  
     /** "track" tag name. */
 1138  
     public static final int TRACK_HTML_TAG_NAME = JavadocParser.TRACK_HTML_TAG_NAME;
 1139  
     /** "wbr" tag name. */
 1140  
     public static final int WBR_HTML_TAG_NAME = JavadocParser.WBR_HTML_TAG_NAME;
 1141  
     ///////////////////////////////////////////////////////////////////////////////////////////////
 1142  
 
 1143  
     /**
 1144  
      * HTML comment start symbol '&lt;!--'.
 1145  
      */
 1146  
     public static final int HTML_COMMENT_START = JavadocParser.HTML_COMMENT_START;
 1147  
 
 1148  
     /**
 1149  
      * HTML comment end symbol '--&gt;'.
 1150  
      */
 1151  
     public static final int HTML_COMMENT_END = JavadocParser.HTML_COMMENT_END;
 1152  
 
 1153  
     /**
 1154  
      * &lt;![CDATA[...]]&gt; block.
 1155  
      */
 1156  
     public static final int CDATA = JavadocParser.CDATA;
 1157  
 
 1158  
     //--------------------------------------------------------------------------------------------//
 1159  
     //------------------        OTHER          ---------------------------------------------------//
 1160  
     //--------------------------------------------------------------------------------------------//
 1161  
 
 1162  
     /** Leading asterisk. */
 1163  
     public static final int LEADING_ASTERISK = JavadocParser.LEADING_ASTERISK;
 1164  
 
 1165  
     /**
 1166  
      * Newline symbol - '\n'.
 1167  
      */
 1168  
     public static final int NEWLINE = JavadocParser.NEWLINE;
 1169  
 
 1170  
     /**
 1171  
      * Any other symbol.
 1172  
      */
 1173  
     public static final int CHAR = JavadocParser.CHAR;
 1174  
 
 1175  
     /**
 1176  
      * Whitespace or tab ('\t') symbol.
 1177  
      */
 1178  
     public static final int WS = JavadocParser.WS;
 1179  
 
 1180  
     /**
 1181  
      * End Of File symbol.
 1182  
      */
 1183  
     public static final int EOF = Recognizer.EOF;
 1184  
 
 1185  
     //--------------------------------------------------------------------------------------------//
 1186  
     //------- JAVADOC TAGS DEPENDING ON RULE TYPES OFFSET ----------------------------------------//
 1187  
     //--------------------------------------------------------------------------------------------//
 1188  
 
 1189  
     /** Rule types offset.
 1190  
      * RULE_TYPES_OFFSET constant is used to split lexer tokens types and parser rules types.
 1191  
      * We need unique numbers for all tokens,
 1192  
      * ANTLR do not need this and that is why this types are mixed by used values.
 1193  
      * All values we can take a look at
 1194  
      * target/generated-sources/antlr/com/puppycrawl/tools/checkstyle/grammars/javadoc/JavadocParser.java
 1195  
      * For example: LEADING_ASTERISK=1 and RULE_htmlElement = 1.
 1196  
      * RULE_TYPES_OFFSET required to shift parser rules,
 1197  
      * to let them not overlap with types that have prefix "RULE_".
 1198  
      */
 1199  
     private static final int RULE_TYPES_OFFSET = 10000;
 1200  
 
 1201  
     /**
 1202  
      * Root node of any Javadoc comment.
 1203  
      * Last child is always {@link #EOF}.
 1204  
      *
 1205  
      * <p><b>Tree for example:</b></p>
 1206  
      * <pre>{@code
 1207  
      * JAVADOC[3x0]
 1208  
      *   |--NEWLINE[3x0] : [\n]
 1209  
      *   |--LEADING_ASTERISK[4x0] : [ *]
 1210  
      *   |--WS[4x2] : [ ]
 1211  
      *   |--JAVADOC_TAG[4x3] : [@param T The bar.\n ]
 1212  
      *       |--PARAM_LITERAL[4x3] : [@param]
 1213  
      *       |--WS[4x9] : [ ]
 1214  
      *       |--PARAMETER_NAME[4x10] : [T]
 1215  
      *       |--WS[4x11] : [ ]
 1216  
      *       |--DESCRIPTION[4x12] : [The bar.\n ]
 1217  
      *           |--TEXT[4x12] : [The bar.]
 1218  
      *           |--NEWLINE[4x20] : [\n]
 1219  
      *           |--TEXT[5x0] : [ ]
 1220  
      *   |--EOF[5x1] : [<EOF>]
 1221  
      * }</pre>
 1222  
      */
 1223  
     public static final int JAVADOC = JavadocParser.RULE_javadoc + RULE_TYPES_OFFSET;
 1224  
 
 1225  
     /**
 1226  
      * Javadoc tag.
 1227  
      *
 1228  
      * <p>Type of Javadoc tag is resolved by literal node that is first child of this node.</p>
 1229  
      *
 1230  
      * <p>As literal could be:</p>
 1231  
      * <ul>
 1232  
      * <li>{@link #RETURN_LITERAL}</li>
 1233  
      * <li>{@link #DEPRECATED_LITERAL}</li>
 1234  
      * <li>{@link #SINCE_LITERAL}</li>
 1235  
      * <li>{@link #SERIAL_DATA_LITERAL}</li>
 1236  
      * <li>{@link #SERIAL_FIELD_LITERAL}</li>
 1237  
      * <li>{@link #PARAM_LITERAL}</li>
 1238  
      * <li>{@link #SEE_LITERAL}</li>
 1239  
      * <li>{@link #SERIAL_LITERAL}</li>
 1240  
      * <li>{@link #VERSION_LITERAL}</li>
 1241  
      * <li>{@link #EXCEPTION_LITERAL}</li>
 1242  
      * <li>{@link #THROWS_LITERAL}</li>
 1243  
      * <li>{@link #AUTHOR_LITERAL}</li>
 1244  
      * <li>or {@link #CUSTOM_NAME} if it is custom Javadoc tag.</li>
 1245  
      * </ul>
 1246  
      *
 1247  
      * <p><b>Example</b></p>
 1248  
      * <pre>{@code &#64;param T The bar.}</pre>
 1249  
      * <b>Tree</b>
 1250  
      * <pre>{@code
 1251  
      *   |--JAVADOC_TAG[4x3] : [@param T The bar.]
 1252  
      *       |--PARAM_LITERAL[4x3] : [@param]
 1253  
      *       |--WS[4x9] : [ ]
 1254  
      *       |--PARAMETER_NAME[4x10] : [T]
 1255  
      *       |--WS[4x11] : [ ]
 1256  
      *       |--DESCRIPTION[4x12] : [The bar.]
 1257  
      *           |--TEXT[4x12] : [The bar.]
 1258  
      * }</pre>
 1259  
      */
 1260  
 
 1261  
     public static final int JAVADOC_TAG = JavadocParser.RULE_javadocTag + RULE_TYPES_OFFSET;
 1262  
     /**
 1263  
      * Javadoc inline tag.
 1264  
      *
 1265  
      * <p>Type of Javadoc inline tag is resolved by literal node that is second child of this node.
 1266  
      * First child is always {@link #JAVADOC_INLINE_TAG_START} and last node is always
 1267  
      * {@link #JAVADOC_INLINE_TAG_END}.</p>
 1268  
      *
 1269  
      * <p>As literal could be:</p>
 1270  
      * <ul>
 1271  
      * <li>{@link #CODE_LITERAL}</li>
 1272  
      * <li>{@link #DOC_ROOT_LITERAL}</li>
 1273  
      * <li>{@link #LINK_LITERAL}</li>
 1274  
      * <li>{@link #INHERIT_DOC_LITERAL}</li>
 1275  
      * <li>{@link #LINKPLAIN_LITERAL}</li>
 1276  
      * <li>{@link #LITERAL_LITERAL}</li>
 1277  
      * <li>{@link #VALUE_LITERAL}</li>
 1278  
      * <li>or {@link #CUSTOM_NAME} if it is custom Javadoc inline tag.</li>
 1279  
      * </ul>
 1280  
      *
 1281  
      * <p><b>Example:</b></p>
 1282  
      * <pre>{@code {&#64;link String}}</pre>
 1283  
      * <b>Tree:</b>
 1284  
      * <pre>
 1285  
      * {@code |--JAVADOC_INLINE_TAG[4x3] : [{&#64;link String}]
 1286  
      *        |--JAVADOC_INLINE_TAG_START[4x3] : [{]
 1287  
      *        |--LINK_LITERAL[4x4] : [@link]
 1288  
      *        |--WS[4x9] : [ ]
 1289  
      *        |--REFERENCE[4x10] : [String]
 1290  
      *            |--CLASS[4x10] : [String]
 1291  
      *        |--JAVADOC_INLINE_TAG_END[4x16] : [}]
 1292  
      * }
 1293  
      * </pre>
 1294  
      */
 1295  
     public static final int JAVADOC_INLINE_TAG = JavadocParser.RULE_javadocInlineTag
 1296  
             + RULE_TYPES_OFFSET;
 1297  
 
 1298  
     /**
 1299  
      * Parameter of the Javadoc tags listed below.
 1300  
      * <ul>
 1301  
      * <li>{@link #SEE_LITERAL @see}</li>
 1302  
      * <li>{@link #LINK_LITERAL &#123;&#64;link&#125;}</li>
 1303  
      * <li>{@link #LINKPLAIN_LITERAL &#123;&#64;linkplain&#125;}</li>
 1304  
      * <li>{@link #VALUE_LITERAL &#123;&#64;value&#125;}</li>
 1305  
      * </ul>
 1306  
      */
 1307  
     public static final int REFERENCE = JavadocParser.RULE_reference + RULE_TYPES_OFFSET;
 1308  
 
 1309  
     /**
 1310  
      * Parameters part in {@link #REFERENCE}.
 1311  
      * It is used to specify parameters for {@link #MEMBER method}.
 1312  
      * Always contains {@link #LEFT_BRACE} as first child and {@link #RIGHT_BRACE} as last child.
 1313  
      * Each parameter is represented by {@link #ARGUMENT} node.
 1314  
      * Arguments in braces are separated by {@link #COMMA} (and optional {@link #WS}).
 1315  
      *
 1316  
      * <p><b>Example:</b></p>
 1317  
      * <pre>{@code @see #method(Processor, String)}</pre>
 1318  
      * <b>Tree:</b>
 1319  
      * <pre>
 1320  
      * {@code |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
 1321  
      *        |--SEE_LITERAL[1x0] : [@see]
 1322  
      *        |--WS[1x4] : [ ]
 1323  
      *        |--REFERENCE[1x5] : [#method(Processor, String)]
 1324  
      *            |--HASH[1x5] : [#]
 1325  
      *            |--MEMBER[1x6] : [method]
 1326  
      *            |--PARAMETERS[1x12] : [(Processor, String)]
 1327  
      *                |--LEFT_BRACE[1x12] : [(]
 1328  
      *                |--ARGUMENT[1x13] : [Processor]
 1329  
      *                |--COMMA[1x22] : [,]
 1330  
      *                |--WS[1x23] : [ ]
 1331  
      *                |--ARGUMENT[1x24] : [String]
 1332  
      *                |--RIGHT_BRACE[1x30] : [)]
 1333  
      * }
 1334  
      * </pre>
 1335  
      */
 1336  
     public static final int PARAMETERS = JavadocParser.RULE_parameters + RULE_TYPES_OFFSET;
 1337  
 
 1338  
     /**
 1339  
      * Description node. It contains:
 1340  
      * <ul>
 1341  
      * <li>{@link #TEXT}</li>
 1342  
      * <li>{@link #WS}</li>
 1343  
      * <li>{@link #NEWLINE}</li>
 1344  
      * <li>{@link #HTML_ELEMENT}</li>
 1345  
      * </ul>
 1346  
      *
 1347  
      * <p>It is argument for many Javadoc tags and inline tags.</p>
 1348  
      *
 1349  
      * <p><b>Example:</b></p>
 1350  
      * <pre>{@code @throws IOException if &lt;b&gt;connection&lt;/b&gt; problems occur}</pre>
 1351  
      * <b>Tree:</b>
 1352  
      * <pre>
 1353  
      * {@code |--JAVADOC_TAG[1x0] :
 1354  
      *               [@throws IOException if &lt;b&gt;connection&lt;/b&gt; problems occur]
 1355  
      *        |--THROWS_LITERAL[1x0] : [@throws]
 1356  
      *        |--WS[1x7] : [ ]
 1357  
      *        |--CLASS_NAME[1x8] : [IOException]
 1358  
      *        |--WS[1x19] : [ ]
 1359  
      *        |--DESCRIPTION[1x20] : [if &lt;b&gt;connection&lt;/b&gt; problems occur]
 1360  
      *            |--TEXT[1x20] : [if ]
 1361  
      *            |--HTML_ELEMENT[1x23] : [&lt;b&gt;connection&lt;/b&gt;]
 1362  
      *                |--HTML_TAG[1x23] : [&lt;b&gt;connection&lt;/b&gt;]
 1363  
      *                    |--HTML_ELEMENT_START[1x23] : [&lt;b&gt;]
 1364  
      *                        |--START[1x23] : [&lt;]
 1365  
      *                        |--HTML_TAG_NAME[1x24] : [b]
 1366  
      *                        |--END[1x25] : [&gt;]
 1367  
      *                    |--TEXT[1x26] : [connection]
 1368  
      *                    |--HTML_ELEMENT_END[1x36] : [&lt;/b&gt;]
 1369  
      *                        |--START[1x36] : [&lt;]
 1370  
      *                        |--SLASH[1x37] : [/]
 1371  
      *                        |--HTML_TAG_NAME[1x38] : [b]
 1372  
      *                        |--END[1x39] : [&gt;]
 1373  
      *            |--TEXT[1x40] : [ problems occur]
 1374  
      * }
 1375  
      * </pre>
 1376  
      */
 1377  
     public static final int DESCRIPTION = JavadocParser.RULE_description + RULE_TYPES_OFFSET;
 1378  
 
 1379  
     //--------------------------------------------------------------------------------------------//
 1380  
     //--------- HTML TAGS DEPENDING ON RULE TYPES OFFSET -----------------------------------------//
 1381  
     //--------------------------------------------------------------------------------------------//
 1382  
 
 1383  
     /**
 1384  
      * Parent node for all html tags.
 1385  
      */
 1386  
     public static final int HTML_ELEMENT = JavadocParser.RULE_htmlElement
 1387  
             + RULE_TYPES_OFFSET;
 1388  
 
 1389  
     /**
 1390  
      * Start html tag: &lt;XXX&gt;.
 1391  
      */
 1392  
     public static final int HTML_ELEMENT_START = JavadocParser.RULE_htmlElementStart
 1393  
             + RULE_TYPES_OFFSET;
 1394  
 
 1395  
     /**
 1396  
      * End html tag: &lt;XXX&gt;.
 1397  
      */
 1398  
     public static final int HTML_ELEMENT_END = JavadocParser.RULE_htmlElementEnd
 1399  
             + RULE_TYPES_OFFSET;
 1400  
 
 1401  
     /**
 1402  
      * Non-special HTML tag.
 1403  
      */
 1404  
     public static final int HTML_TAG = JavadocParser.RULE_htmlTag + RULE_TYPES_OFFSET;
 1405  
 
 1406  
     /**
 1407  
      * Html tag attribute. Parent node for: {@code HTML_TAG_IDENT, EQUALS, ATTR_VALUE}.
 1408  
      */
 1409  
     public static final int ATTRIBUTE = JavadocParser.RULE_attribute
 1410  
             + RULE_TYPES_OFFSET;
 1411  
 
 1412  
     /////////////////////// HTML TAGS WITH OPTIONAL END TAG /////////////////////////////////////
 1413  
     /** Paragraph html tag: {@code <p></p>}. */
 1414  
     public static final int PARAGRAPH = JavadocParser.RULE_paragraph + RULE_TYPES_OFFSET;
 1415  
     /** Start paragraph tag. */
 1416  
     public static final int P_TAG_START = JavadocParser.RULE_pTagStart + RULE_TYPES_OFFSET;
 1417  
     /** End paragraph tag. */
 1418  
     public static final int P_TAG_END = JavadocParser.RULE_pTagEnd + RULE_TYPES_OFFSET;
 1419  
     /** List item html tag: {@code <li></li>}. */
 1420  
 
 1421  
     public static final int LI = JavadocParser.RULE_li + RULE_TYPES_OFFSET;
 1422  
     /** Start list item tag. */
 1423  
     public static final int LI_TAG_START = JavadocParser.RULE_liTagStart + RULE_TYPES_OFFSET;
 1424  
     /** End list item tag. */
 1425  
     public static final int LI_TAG_END = JavadocParser.RULE_liTagEnd + RULE_TYPES_OFFSET;
 1426  
 
 1427  
     /** Table row html tag: {@code <tr></tr>}. */
 1428  
     public static final int TR = JavadocParser.RULE_tr + RULE_TYPES_OFFSET;
 1429  
     /** Start table row tag. */
 1430  
     public static final int TR_TAG_START = JavadocParser.RULE_trTagStart + RULE_TYPES_OFFSET;
 1431  
     /** End table row tag. */
 1432  
     public static final int TR_TAG_END = JavadocParser.RULE_trTagEnd + RULE_TYPES_OFFSET;
 1433  
 
 1434  
     /** Table cell html tag: {@code <td></td>}. */
 1435  
     public static final int TD = JavadocParser.RULE_td + RULE_TYPES_OFFSET;
 1436  
     /** Start table cell tag. */
 1437  
     public static final int TD_TAG_START = JavadocParser.RULE_tdTagStart + RULE_TYPES_OFFSET;
 1438  
     /** End table cell tag. */
 1439  
     public static final int TD_TAG_END = JavadocParser.RULE_tdTagEnd + RULE_TYPES_OFFSET;
 1440  
 
 1441  
     /** Table header cell html tag: {@code <th></th>}. */
 1442  
     public static final int TH = JavadocParser.RULE_th + RULE_TYPES_OFFSET;
 1443  
     /** Start table header cell tag. */
 1444  
     public static final int TH_TAG_START = JavadocParser.RULE_thTagStart + RULE_TYPES_OFFSET;
 1445  
     /** End table header cell tag. */
 1446  
     public static final int TH_TAG_END = JavadocParser.RULE_thTagEnd + RULE_TYPES_OFFSET;
 1447  
 
 1448  
     /** Body html tag. */
 1449  
     public static final int BODY = JavadocParser.RULE_body + RULE_TYPES_OFFSET;
 1450  
     /** Start body tag. */
 1451  
     public static final int BODY_TAG_START = JavadocParser.RULE_bodyTagStart + RULE_TYPES_OFFSET;
 1452  
     /** End body tag. */
 1453  
     public static final int BODY_TAG_END = JavadocParser.RULE_bodyTagEnd + RULE_TYPES_OFFSET;
 1454  
 
 1455  
     /** Colgroup html tag. */
 1456  
     public static final int COLGROUP = JavadocParser.RULE_colgroup + RULE_TYPES_OFFSET;
 1457  
     /** Start colgroup tag. */
 1458  
     public static final int COLGROUP_TAG_START = JavadocParser.RULE_colgroupTagStart
 1459  
             + RULE_TYPES_OFFSET;
 1460  
     /** End colgroup tag. */
 1461  
     public static final int COLGROUP_TAG_END = JavadocParser.RULE_colgroupTagEnd
 1462  
             + RULE_TYPES_OFFSET;
 1463  
 
 1464  
     /** Description of a term html tag: {@code <dd></dd>}. */
 1465  
     public static final int DD = JavadocParser.RULE_dd + RULE_TYPES_OFFSET;
 1466  
     /** Start description of a term tag. */
 1467  
     public static final int DD_TAG_START = JavadocParser.RULE_ddTagStart + RULE_TYPES_OFFSET;
 1468  
     /** End description of a term tag. */
 1469  
     public static final int DD_TAG_END = JavadocParser.RULE_ddTagEnd + RULE_TYPES_OFFSET;
 1470  
 
 1471  
     /** Description term html tag: {@code <dt></dt>}. */
 1472  
     public static final int DT = JavadocParser.RULE_dt + RULE_TYPES_OFFSET;
 1473  
     /** Start description term tag. */
 1474  
     public static final int DT_TAG_START = JavadocParser.RULE_dtTagStart + RULE_TYPES_OFFSET;
 1475  
     /** End description term tag. */
 1476  
     public static final int DT_TAG_END = JavadocParser.RULE_dtTagEnd + RULE_TYPES_OFFSET;
 1477  
 
 1478  
     /** Head html tag. */
 1479  
     public static final int HEAD = JavadocParser.RULE_head + RULE_TYPES_OFFSET;
 1480  
     /** Start head tag. */
 1481  
     public static final int HEAD_TAG_START = JavadocParser.RULE_headTagStart + RULE_TYPES_OFFSET;
 1482  
     /** End head tag. */
 1483  
     public static final int HEAD_TAG_END = JavadocParser.RULE_headTagEnd + RULE_TYPES_OFFSET;
 1484  
 
 1485  
     /** Html html tag. */
 1486  
     public static final int HTML = JavadocParser.RULE_html + RULE_TYPES_OFFSET;
 1487  
     /** Start html tag. */
 1488  
     public static final int HTML_TAG_START = JavadocParser.RULE_htmlTagStart + RULE_TYPES_OFFSET;
 1489  
     /** End html tag. */
 1490  
     public static final int HTML_TAG_END = JavadocParser.RULE_htmlTagEnd + RULE_TYPES_OFFSET;
 1491  
 
 1492  
     /** Option html tag. */
 1493  
     public static final int OPTION = JavadocParser.RULE_option + RULE_TYPES_OFFSET;
 1494  
     /** Start option tag. */
 1495  
     public static final int OPTION_TAG_START =
 1496  
             JavadocParser.RULE_optionTagStart + RULE_TYPES_OFFSET;
 1497  
     /** End option tag. */
 1498  
     public static final int OPTION_TAG_END = JavadocParser.RULE_optionTagEnd
 1499  
             + RULE_TYPES_OFFSET;
 1500  
 
 1501  
     /** Table body html tag. */
 1502  
     public static final int TBODY = JavadocParser.RULE_tbody + RULE_TYPES_OFFSET;
 1503  
     /** Start table body tag. */
 1504  
     public static final int TBODY_TAG_START = JavadocParser.RULE_tbodyTagStart + RULE_TYPES_OFFSET;
 1505  
     /** End table body tag. */
 1506  
     public static final int TBODY_TAG_END = JavadocParser.RULE_tbodyTagEnd + RULE_TYPES_OFFSET;
 1507  
 
 1508  
     /** Table foot html tag. */
 1509  
     public static final int TFOOT = JavadocParser.RULE_tfoot + RULE_TYPES_OFFSET;
 1510  
     /** Start table foot tag. */
 1511  
     public static final int TFOOT_TAG_START = JavadocParser.RULE_tfootTagStart + RULE_TYPES_OFFSET;
 1512  
     /** End table foot tag. */
 1513  
     public static final int TFOOT_TAG_END = JavadocParser.RULE_tfootTagEnd + RULE_TYPES_OFFSET;
 1514  
 
 1515  
     /** Table head html tag. */
 1516  
     public static final int THEAD = JavadocParser.RULE_thead + RULE_TYPES_OFFSET;
 1517  
     /** Start table head tag. */
 1518  
     public static final int THEAD_TAG_START = JavadocParser.RULE_theadTagStart + RULE_TYPES_OFFSET;
 1519  
     /** End table head tag. */
 1520  
     public static final int THEAD_TAG_END = JavadocParser.RULE_theadTagEnd + RULE_TYPES_OFFSET;
 1521  
 
 1522  
     /////////////////////// SINGLETON HTML TAGS  //////////////////////////////////////////////////
 1523  
     /**
 1524  
      * Parent node for all singleton html tags.
 1525  
      */
 1526  
     public static final int SINGLETON_ELEMENT = JavadocParser.RULE_singletonElement
 1527  
             + RULE_TYPES_OFFSET;
 1528  
 
 1529  
     /**
 1530  
      * Non-special empty html tag.
 1531  
      */
 1532  
     public static final int EMPTY_TAG = JavadocParser.RULE_emptyTag
 1533  
             + RULE_TYPES_OFFSET;
 1534  
 
 1535  
     /** Area html tag. */
 1536  
     public static final int AREA_TAG = JavadocParser.RULE_areaTag + RULE_TYPES_OFFSET;
 1537  
 
 1538  
     /** Base html tag. */
 1539  
     public static final int BASE_TAG = JavadocParser.RULE_baseTag + RULE_TYPES_OFFSET;
 1540  
 
 1541  
     /** Basefont html tag. */
 1542  
     public static final int BASEFONT_TAG = JavadocParser.RULE_basefontTag + RULE_TYPES_OFFSET;
 1543  
 
 1544  
     /** Br html tag. */
 1545  
     public static final int BR_TAG = JavadocParser.RULE_brTag + RULE_TYPES_OFFSET;
 1546  
 
 1547  
     /** Col html tag. */
 1548  
     public static final int COL_TAG = JavadocParser.RULE_colTag + RULE_TYPES_OFFSET;
 1549  
 
 1550  
     /** Frame html tag. */
 1551  
     public static final int FRAME_TAG = JavadocParser.RULE_frameTag + RULE_TYPES_OFFSET;
 1552  
 
 1553  
     /** Hr html tag. */
 1554  
     public static final int HR_TAG = JavadocParser.RULE_hrTag + RULE_TYPES_OFFSET;
 1555  
 
 1556  
     /** Img html tag. */
 1557  
     public static final int IMG_TAG = JavadocParser.RULE_imgTag + RULE_TYPES_OFFSET;
 1558  
 
 1559  
     /** Input html tag. */
 1560  
     public static final int INPUT_TAG = JavadocParser.RULE_inputTag + RULE_TYPES_OFFSET;
 1561  
 
 1562  
     /** Isindex html tag. */
 1563  
     public static final int ISINDEX_TAG = JavadocParser.RULE_isindexTag + RULE_TYPES_OFFSET;
 1564  
 
 1565  
     /** Link html tag. */
 1566  
     public static final int LINK_TAG = JavadocParser.RULE_linkTag + RULE_TYPES_OFFSET;
 1567  
 
 1568  
     /** Meta html tag. */
 1569  
     public static final int META_TAG = JavadocParser.RULE_metaTag + RULE_TYPES_OFFSET;
 1570  
 
 1571  
     /** Param html tag. */
 1572  
     public static final int PARAM_TAG = JavadocParser.RULE_paramTag + RULE_TYPES_OFFSET;
 1573  
 
 1574  
     /**
 1575  
      * HTML void element {@code <embed>}.
 1576  
      * @see #SINGLETON_ELEMENT
 1577  
      * @see <a href="https://www.w3.org/TR/html51/semantics-embedded-content.html#elementdef-embed">
 1578  
      *     W3 docs</a>
 1579  
      */
 1580  
     public static final int EMBED_TAG = JavadocParser.RULE_embedTag + RULE_TYPES_OFFSET;
 1581  
 
 1582  
     /**
 1583  
      * HTML void element {@code <keygen>}.
 1584  
      * @see #SINGLETON_ELEMENT
 1585  
      * @see <a href="https://www.w3.org/TR/html51/sec-forms.html#elementdef-keygen">
 1586  
      *     W3 docs</a>
 1587  
      */
 1588  
     public static final int KEYGEN_TAG = JavadocParser.RULE_keygenTag + RULE_TYPES_OFFSET;
 1589  
 
 1590  
     /**
 1591  
      * HTML void element {@code <source>}.
 1592  
      * @see #SINGLETON_ELEMENT
 1593  
      * @see "https://www.w3.org/TR/html51/semantics-embedded-content.html#elementdef-media-source"
 1594  
      */
 1595  
     public static final int SOURCE_TAG = JavadocParser.RULE_sourceTag + RULE_TYPES_OFFSET;
 1596  
 
 1597  
     /**
 1598  
      * HTML void element {@code <track>}.
 1599  
      * @see #SINGLETON_ELEMENT
 1600  
      * @see <a
 1601  
      *     href="https://www.w3.org/TR/html51/semantics-embedded-content.html#elementdef-track">
 1602  
      *     W3 docs</a>
 1603  
      */
 1604  
     public static final int TRACK_TAG = JavadocParser.RULE_trackTag + RULE_TYPES_OFFSET;
 1605  
 
 1606  
     /**
 1607  
      * HTML void element {@code <wbr>}.
 1608  
      * @see #SINGLETON_ELEMENT
 1609  
      * @see <a href="https://www.w3.org/TR/html51/textlevel-semantics.html#elementdef-wbr">
 1610  
      *     W3 docs</a>
 1611  
      */
 1612  
     public static final int WBR_TAG = JavadocParser.RULE_wbrTag + RULE_TYPES_OFFSET;
 1613  
 
 1614  
     ///////////////////////////////////////////////////////////////////////////////////////////////
 1615  
 
 1616  
     /** Html comment: {@code <!-- -->}. */
 1617  
     public static final int HTML_COMMENT = JavadocParser.RULE_htmlComment
 1618  
             + RULE_TYPES_OFFSET;
 1619  
     /**
 1620  
      * CHAR and WS sequence.
 1621  
      */
 1622  
     public static final int TEXT = JavadocParser.RULE_text + RULE_TYPES_OFFSET;
 1623  
 
 1624  
     /** Empty private constructor of the current class. */
 1625  1
     private JavadocTokenTypes() {
 1626  1
     }
 1627  
 
 1628  
 }