Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update JavadocTokenTypes.java to new format of AST print #14631

Open
romani opened this issue Mar 9, 2024 · 6 comments
Open

update JavadocTokenTypes.java to new format of AST print #14631

romani opened this issue Mar 9, 2024 · 6 comments

Comments

@romani
Copy link
Member

romani commented Mar 9, 2024

Same as #14516 but for javadoc

https://github.com/checkstyle/checkstyle/blob/master/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java

https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html

https://checkstyle.org/cmdline.html , see -j or -J .

To generate AST, use cmd : java -jar checkstyle-10.13.0-all.jar -J Test.java | sed "s/\[[0-9]\+:[0-9]\+\]//g"
The sed command removes the line:column numbers for our documentation.

Each token update should be in its own Pull Request.
Share whole cli output for javadoc chunk in PR description.

Good example of update: #14632 please provide all details as provided in description of this PR

MANISH-K-07 added a commit to MANISH-K-07/checkstyle that referenced this issue Mar 9, 2024
@github-actions github-actions bot added this to the 10.14.1 milestone Mar 9, 2024
SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 10, 2024
SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 10, 2024
SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 11, 2024
SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 11, 2024
SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 11, 2024
SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 11, 2024
MANISH-K-07 added a commit to MANISH-K-07/checkstyle that referenced this issue Mar 12, 2024
@github-actions github-actions bot modified the milestones: 10.14.1, 10.14.2 Mar 12, 2024
@MANISH-K-07
Copy link
Contributor

To generate AST, use cmd : java -jar checkstyle-10.13.0-all.jar -J Test.java | sed "s/\[[0-9]\+:[0-9]\+\]//g"
The sed command removes the line:column numbers for our documentation.

SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 13, 2024
SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 13, 2024
SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 13, 2024
SteLeo1602 added a commit to SteLeo1602/checkstyle that referenced this issue Mar 13, 2024
@rnveach
Copy link
Member

rnveach commented Mar 18, 2024

@romani @nrmancuso If we don't create a UT to enforce this and ensure ANTLR updates are updated appropriately in this file and regular TokenTypes, then things like #14615 (comment) will break everything trying to be done in this issue.

Pinti0001 added a commit to Pinti0001/checkstyle that referenced this issue Mar 22, 2024
@nrmancuso
Copy link
Member

@romani @nrmancuso If we don't create a UT to enforce this and ensure ANTLR updates are updated appropriately in this file and regular TokenTypes, then things like #14615 (comment) will break everything trying to be done in this issue.

I don't disagree that this would be nice to have, but I think this issue concerns the actual format that the AST is printed with.

@Prathamesh-007
Copy link
Contributor

I am on SERIAL_FIELD_LITERAL

Prathamesh-007 added a commit to Prathamesh-007/checkstyle that referenced this issue Mar 31, 2024
Prathamesh-007 added a commit to Prathamesh-007/checkstyle that referenced this issue Apr 1, 2024
Prathamesh-007 added a commit to Prathamesh-007/checkstyle that referenced this issue Apr 3, 2024
Prathamesh-007 added a commit to Prathamesh-007/checkstyle that referenced this issue Apr 3, 2024
@github-actions github-actions bot modified the milestones: 10.15.0, 10.15.1 Apr 15, 2024
SteLeo1603 added a commit to SteLeo1603/checkstyle_tutorial that referenced this issue Apr 20, 2024
SteLeo1603 added a commit to SteLeo1603/checkstyle_tutorial that referenced this issue Apr 20, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 21, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 21, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 21, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 21, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 21, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 21, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 21, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 21, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 22, 2024
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 22, 2024
prathm3 pushed a commit to prathm3/checkstyle that referenced this issue Apr 23, 2024
Bumps [org.apache.maven.plugins:maven-jar-plugin](https://github.com/apache/maven-jar-plugin) from 3.4.0 to 3.4.1.
- [Release notes](https://github.com/apache/maven-jar-plugin/releases)
- [Commits](apache/maven-jar-plugin@maven-jar-plugin-3.4.0...maven-jar-plugin-3.4.1)

---
updated-dependencies:
- dependency-name: org.apache.maven.plugins:maven-jar-plugin
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Issue checkstyle#14631: Updated Commit
prathm3 added a commit to prathm3/checkstyle that referenced this issue Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants