Issue #9450: update example of AST for TokenTypes.IDENT

checkstyle · Nov 27, 2021 · 73c5d47 · 73c5d47
1 parent 4bd9856
commit 73c5d47
Showing 1 changed file with 18 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
@@ -1720,6 +1720,24 @@ public final class TokenTypes {
     /**
      * An identifier.  These can be names of types, subpackages,
      * fields, methods, parameters, and local variables.
+     *
+     * <p>For example:</p>
+     * <pre>
+     * int a = 10;
+     * </pre>
+     * <p>parses as:</p>
+     * <pre>
+     * VARIABLE_DEF -&gt; VARIABLE_DEF
+     *  |--MODIFIERS -&gt; MODIFIERS
+     *  |--TYPE -&gt; TYPE
+     *  |   `--LITERAL_INT -&gt; int
+     *  |--IDENT -&gt; a
+     *  |   `--ASSIGN -&gt; =
+     *  |       `--EXPR -&gt; EXPR
+     *  |           `--NUM_INT -&gt; 10
+     *  `--SEMI -&gt; ;
+     * </pre>
+     *
      **/
     public static final int IDENT = JavaLanguageLexer.IDENT;
     /**