Skip to content

docs: Add DESCRIPTION token example with AST tree#18902

Merged
romani merged 1 commit intocheckstyle:masterfrom
vivek-bandi:javaDocUpdate
Feb 9, 2026
Merged

docs: Add DESCRIPTION token example with AST tree#18902
romani merged 1 commit intocheckstyle:masterfrom
vivek-bandi:javaDocUpdate

Conversation

@vivek-bandi
Copy link
Copy Markdown
Contributor

Issue: #17882

Command used

java -jar checkstyle-13.2.0-all.jar -j src/Test.java | sed "s/\[[0-9]\+:[0-9]\+\]//g"

Test.java

:Test % cat src/Test.java 

/**
 * @param value The parameter description goes here.
 */
  public void Test(String value) {

  }

AST

Test % java -jar checkstyle-13.2.0-all.jar -j src/Test.java | sed "s/\[[0-9]\+:[0-9]\+\]//g"
JAVADOC_CONTENT -> JAVADOC_CONTENT [0:1]
|--TEXT -> /** [0:1]
|--NEWLINE -> \n [0:4]
|--LEADING_ASTERISK ->  * [1:1]
|--TEXT ->   [1:3]
`--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG [1:4]
    `--PARAM_BLOCK_TAG -> PARAM_BLOCK_TAG [1:4]
        |--AT_SIGN -> @ [1:4]
        |--TAG_NAME -> param [1:5]
        |--TEXT ->   [1:10]
        |--PARAMETER_NAME -> value [1:11]
        `--DESCRIPTION -> DESCRIPTION [1:16]
            |--TEXT ->  The parameter description goes here. [1:16]
            |--NEWLINE -> \n [1:53]
            |--LEADING_ASTERISK ->  * [2:1]
            |--TEXT -> / [2:3]
            |--NEWLINE -> \n [2:4]
            |--TEXT -> public void Test(String value) { [3:1]
            |--NEWLINE -> \n [3:33]
            |--NEWLINE -> \n [4:1]
            `--TEXT -> } [5:1]

Copy link
Copy Markdown
Member

@romani romani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot

@romani
Copy link
Copy Markdown
Member

romani commented Feb 9, 2026

Please remove \n from commit message, to let CI pass

@vivek-bandi
Copy link
Copy Markdown
Contributor Author

there is no \n in my commit message but still I've changed the commit message but some are failing can you please mention how can I pass them.

@vivek-0509
Copy link
Copy Markdown
Contributor

Screenshot 2026-02-09 at 11 53 04 PM

@vivek-bandi the prefix should be doc not docs ,please change

@vivek-bandi vivek-bandi force-pushed the javaDocUpdate branch 2 times, most recently from 7f61284 to c230b5a Compare February 9, 2026 19:29
@vivek-bandi
Copy link
Copy Markdown
Contributor Author

vivek-bandi commented Feb 9, 2026

sorry for multiple force pushes just trying to figure out how things are working.

Copy link
Copy Markdown
Member

@romani romani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better to have prefix as issue

@romani romani merged commit 523f3e9 into checkstyle:master Feb 9, 2026
53 checks passed
@vivek-bandi vivek-bandi deleted the javaDocUpdate branch February 9, 2026 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants