Skip to content

Commit 8ffb662

Browse files
YuktiNandwanaromani
authored andcommitted
Issue #17882: Add STRING_LITERAL token Javadoc with AST example
1 parent d0dcddf commit 8ffb662

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocCommentsTokenTypes.java

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1934,6 +1934,23 @@ public final class JavadocCommentsTokenTypes {
19341934

19351935
/**
19361936
* String literal inside Javadoc.
1937+
*
1938+
* <p>Example in Javadoc:</p>
1939+
*
1940+
* <pre>{@code
1941+
* {@see "foo"}
1942+
* }</pre>
1943+
*
1944+
* <p>Tree:</p>
1945+
*
1946+
* <pre>{@code
1947+
* JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
1948+
* `--SEE_BLOCK_TAG -> SEE_BLOCK_TAG
1949+
* |--AT_SIGN -> @
1950+
* |--TAG_NAME -> see
1951+
* |--TEXT ->
1952+
* `--STRING_LITERAL -> "foo"
1953+
* }</pre>
19371954
*/
19381955
public static final int STRING_LITERAL = JavadocCommentsLexer.STRING_LITERAL;
19391956

0 commit comments

Comments
 (0)