Issue checkstyle#9396: Add example of AST for TokenTypes.AT

vinayak-gaikwad · Sep 28, 2021 · b1eaf64 · b1eaf64
1 parent b19d203
commit b1eaf64
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java
@@ -4999,6 +4999,26 @@ public final class TokenTypes {
      * to the interface literal signifying the definition of an annotation
      * declaration.
      *
+     * <p>For example:</p>
+     * <pre>
+     * &#64;Deprecated
+     * private int value;
+     * </pre>
+     *
+     * <p>parses as:</p>
+     * <pre>
+     * VARIABLE_DEF -> VARIABLE_DEF
+     * |--MODIFIERS -> MODIFIERS
+     * |  |--ANNOTATION -> ANNOTATION
+     * |  |  |--AT -> &#64;
+     * |  |  `--IDENT -> Deprecated
+     * |  `--LITERAL_PRIVATE -> private
+     * |--TYPE -> TYPE
+     * |  `--LITERAL_INT -> int
+     * |--IDENT -> value
+     * `--SEMI -> ;
+     * </pre>
+     *
      * @see <a href="https://www.jcp.org/en/jsr/detail?id=201">
      * JSR201</a>
      */