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