Issue #9463: update example of AST for TokenTypes.LITERAL_BOOLEAN

checkstyle · Nov 27, 2021 · 3895bde · 3895bde
1 parent 66b7b00
commit 3895bde
Showing 1 changed file with 15 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
@@ -1536,6 +1536,21 @@ public final class TokenTypes {
     /**
      * The {@code boolean} keyword.
      *
+     * <p>For example:</p>
+     * <pre>
+     * public boolean flag;
+     * </pre>
+     * <p>parses as:</p>
+     * <pre>
+     * VARIABLE_DEF -&gt; VARIABLE_DEF
+     *  |--MODIFIERS -&gt; MODIFIERS
+     *  |   `--LITERAL_PUBLIC -&gt; public
+     *  |--TYPE -&gt; TYPE
+     *  |   `--LITERAL_BOOLEAN -&gt; boolean
+     *  |--IDENT -&gt; flag
+     *  `--SEMI -&gt; ;
+     * </pre>
+     *
      * @see #TYPE
      **/
     public static final int LITERAL_BOOLEAN =