Issue checkstyle#14631: Updated BR_HTML_TAG_NAME in JavadocTokenTypes…

….java to new AST format
romani · Jan 19, 2025 · eda8303 · eda8303
1 parent cf08cd7
commit eda8303
Showing 1 changed file with 25 additions and 1 deletion.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java
@@ -1157,7 +1157,31 @@ public final class JavadocTokenTypes {
     /** Basefont tag name. */
     public static final int BASEFONT_HTML_TAG_NAME = JavadocParser.BASEFONT_HTML_TAG_NAME;
 
-    /** Br tag name. */
+    /**
+     * Br tag name.
+     *
+     * <p><b>Example:</b></p>
+     * <pre>{@code text before break &lt br &gt text after break}</pre>
+     * <b>Tree:</b>
+     * <pre>
+     * {@code
+     *   JAVADOC -&gt; JAVADOC
+     *        |--NEWLINE -&gt; \r\n
+     *        |--LEADING_ASTERISK -&gt;  *
+     *        |--TEXT -&gt;  text before break
+     *        |--HTML_ELEMENT -&gt; HTML_ELEMENT
+     *        |   `--SINGLETON_ELEMENT -&gt; SINGLETON_ELEMENT
+     *        |       `--BR_TAG -&gt; BR_TAG
+     *        |           |--START -&gt; -&lt;
+     *        |           |--BR_HTML_TAG_NAME -&gt; br
+     *        |           `--END -&gt; &gt;
+     *        |--TEXT -&gt;  text after break
+     *        |--NEWLINE -&gt; \r\n
+     *        |--TEXT -&gt;
+     * }
+     * </pre>
+     */
+
     public static final int BR_HTML_TAG_NAME = JavadocParser.BR_HTML_TAG_NAME;
 
     /** Col tag name. */