@strkkk @romani we should add some details about what we mean by "support".

Here is what current Javadoc AST looks like with snippet tag:

➜  java cat Test.java                                          
/**
 * {@snippet:
 *    public static void main(String... args) {
 *        System.out.println("Hello, World!");
 *    }
 * }
 * {@code
 *    public static void main(String... args) {
 *        System.out.println("Hello, World!");
 *    }
 * }
 */
public class Test {
}
➜  java java -jar checkstyle-10.1-SNAPSHOT-all.jar -J Test.java
COMPILATION_UNIT -> COMPILATION_UNIT [13:0]
`--CLASS_DEF -> CLASS_DEF [13:0]
    |--MODIFIERS -> MODIFIERS [13:0]
    |   |--BLOCK_COMMENT_BEGIN -> /* [1:0]
    |   |   |--COMMENT_CONTENT -> *\n * {@snippet:\n *    public static void main(String... args) {\n *        System.out.println("Hello, World!");\n *    }\n * }\n * {@code\n *    public static void main(String... args) {\n *        System.out.println("Hello, World!");\n *    }\n * }\n  [1:2]
    |   |   |   `--JAVADOC -> JAVADOC [1:3]
    |   |   |       |--NEWLINE -> \n [1:3]
    |   |   |       |--LEADING_ASTERISK ->  * [2:0]
    |   |   |       |--TEXT ->   [2:2]
    |   |   |       |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG [2:3]
    |   |   |       |   |--JAVADOC_INLINE_TAG_START -> { [2:3]
    |   |   |       |   |--CUSTOM_NAME -> @snippet: [2:4]
    |   |   |       |   |--NEWLINE -> \n [2:13]
    |   |   |       |   |--LEADING_ASTERISK ->  * [3:0]
    |   |   |       |   |--WS ->      [3:2]
    |   |   |       |   |--DESCRIPTION -> DESCRIPTION [3:6]
    |   |   |       |   |   |--TEXT -> public static void main(String... args) { [3:6]
    |   |   |       |   |   |--NEWLINE -> \n [3:47]
    |   |   |       |   |   |--LEADING_ASTERISK ->  * [4:0]
    |   |   |       |   |   |--TEXT ->         System.out.println("Hello, World!"); [4:2]
    |   |   |       |   |   |--NEWLINE -> \n [4:46]
    |   |   |       |   |   |--LEADING_ASTERISK ->  * [5:0]
    |   |   |       |   |   `--TEXT ->      [5:2]
    |   |   |       |   `--JAVADOC_INLINE_TAG_END -> } [5:6]
    |   |   |       |--NEWLINE -> \n [5:7]
    |   |   |       |--LEADING_ASTERISK ->  * [6:0]
    |   |   |       |--TEXT ->  } [6:2]
    |   |   |       |--NEWLINE -> \n [6:4]
    |   |   |       |--LEADING_ASTERISK ->  * [7:0]
    |   |   |       |--TEXT ->   [7:2]
    |   |   |       |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG [7:3]
    |   |   |       |   |--JAVADOC_INLINE_TAG_START -> { [7:3]
    |   |   |       |   |--CODE_LITERAL -> @code [7:4]
    |   |   |       |   |--NEWLINE -> \n [7:9]
    |   |   |       |   |--LEADING_ASTERISK ->  * [8:0]
    |   |   |       |   |--TEXT ->     public static void main(String... args) {\n *        System.out.println("Hello, World!");\n *    }\n [8:2]
    |   |   |       |   |--LEADING_ASTERISK ->  * [11:0]
    |   |   |       |   |--TEXT ->   [11:2]
    |   |   |       |   `--JAVADOC_INLINE_TAG_END -> } [11:4]
    |   |   |       |--NEWLINE -> \n [11:5]
    |   |   |       |--TEXT ->   [12:0]
    |   |   |       `--EOF -> <EOF> [12:1]
    |   |   `--BLOCK_COMMENT_END -> */ [12:1]
    |   `--LITERAL_PUBLIC -> public [13:0]
    |--LITERAL_CLASS -> class [13:7]
    |--IDENT -> Test [13:13]
    `--OBJBLOCK -> OBJBLOCK [13:18]
        |--LCURLY -> { [13:18]
        `--RCURLY -> } [14:0]

By "support", do we mean that CUSTOM_NAME -> @snippet: should be something like SNIPPET_LITERAL -> @snippet: ?

Also what existing checks would benefit from adding support for the snippet tag?

Uh oh!

Add support for @snippet javadoc tags #11455

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions