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