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

vinayak-gaikwad · Jul 27, 2021 · f10aeb5 · f10aeb5
1 parent e6eb140
commit f10aeb5
Showing 1 changed file with 12 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
@@ -4896,6 +4896,18 @@ public final class TokenTypes {
      * to the interface literal signifying the definition of an annotation
      * declaration.
      *
+     * <p>For example:</p>
+     * <pre> @Override </pre>
+     *
+     * <p>parses as:</p>
+     * <pre>
+     * --MODIFIERS -&gt; MODIFIERS
+     *      |   |   |--ANNOTATION -&gt; ANNOTATION
+     *      |   |   |   |--AT -&gt; @
+     *      |   |   |   `--IDENT -&gt; Override
+     *      |   |   `--LITERAL_PUBLIC -&gt; public
+     * </pre>
+     *
      * @see <a href="https://www.jcp.org/en/jsr/detail?id=201">
      * JSR201</a>
      */