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