Skip to content

Issue #18571: New Check BlockCommentEndPositionCheck#19039

Open
Praveen7294 wants to merge 1 commit into
checkstyle:masterfrom
Praveen7294:javadoc
Open

Issue #18571: New Check BlockCommentEndPositionCheck#19039
Praveen7294 wants to merge 1 commit into
checkstyle:masterfrom
Praveen7294:javadoc

Conversation

@Praveen7294

@Praveen7294 Praveen7294 commented Feb 26, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Issue #18571

Implemented a new check, BlockCommentEndPositionCheck, that verifies that */ is either alone on its own line or on the same line as /**.

Contirbution repo PR: checkstyle/contribution#1034

New module config: https://gist.githubusercontent.com/Praveen7294/c6fd73abb4cfc532c5f9f14822d3ca58/raw/da5c048293c4009580a506bb41ca00e8dea77aab/config.xml

@Praveen7294 Praveen7294 marked this pull request as draft February 26, 2026 19:20
@Praveen7294 Praveen7294 force-pushed the javadoc branch 5 times, most recently from e8d71a1 to 69d11d2 Compare February 27, 2026 14:42
@Praveen7294 Praveen7294 mentioned this pull request Feb 27, 2026
Merged
@Praveen7294 Praveen7294 marked this pull request as ready for review February 27, 2026 16:22
@Praveen7294

Praveen7294 commented Feb 27, 2026

Copy link
Copy Markdown
Contributor Author

created a PR to fix ci/semaphore failure. sevntu-checkstyle/sevntu.checkstyle#1157

@Praveen7294

Praveen7294 commented Feb 27, 2026

Copy link
Copy Markdown
Contributor Author

GitHub, generate website

@Praveen7294

Praveen7294 commented Feb 27, 2026

Copy link
Copy Markdown
Contributor Author

GitHub, generate report

@github-actions

github-actions Bot commented Feb 27, 2026

Copy link
Copy Markdown
Contributor

Report generation failed on phase "make_report",
step "Generate report".
Link: https://github.com/checkstyle/checkstyle/actions/runs/22494727472

@github-actions

github-actions Bot commented Feb 27, 2026

Copy link
Copy Markdown
Contributor

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/69d11d2_20260227164112/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/69d11d2_20260227164112/checks.html#Standard_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/69d11d2_20260227164112/checks/javadoc/blockcommentendposition.html#

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/69d11d2_20260227164112/checks/javadoc/index.html#Javadoc_Comments_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/69d11d2_20260227164112/property_types.html#BlockOption

@Praveen7294

Praveen7294 commented Feb 27, 2026

Copy link
Copy Markdown
Contributor Author

GitHub, generate report

@github-actions

github-actions Bot commented Feb 27, 2026

Copy link
Copy Markdown
Contributor

Report generation failed on phase "make_report",
step "Generate report".
Link: https://github.com/checkstyle/checkstyle/actions/runs/22497014031

@Praveen7294

Praveen7294 commented Feb 27, 2026

Copy link
Copy Markdown
Contributor Author 
Error:  Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.12.1:site (default-site) on project sample: Error generating maven-checkstyle-plugin:3.1.1:checkstyle report: Failed during checkstyle configuration: Exception was thrown while processing /home/runner/work/checkstyle/checkstyle/.ci-temp/contribution/checkstyle-tester/src/main/java/checkstyle/src/xdocs-examples/resources-noncompilable/com/puppycrawl/tools/checkstyle/filefilters/beforeexecutionexclusionfilefilter/module-info.java: IllegalStateException occurred while parsing file /home/runner/work/checkstyle/checkstyle/.ci-temp/contribution/checkstyle-tester/src/main/java/checkstyle/src/xdocs-examples/resources-noncompilable/com/puppycrawl/tools/checkstyle/filefilters/beforeexecutionexclusionfilefilter/module-info.java. 1:0: no viable alternative at input 'module': NoViableAltException -> [Help 1]

@romani I am getting the above error while generating the diff report. Can you help me fix this?

@vivek-0509

vivek-0509 commented Feb 27, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Add proper exception handling in new module config like this https://gist.githubusercontent.com/vivek-0509/36cbe7f3789730951f15e7b6d551c6f3/raw/7ac2050528756f02e9952ae546a9c1e8cfed29c0/base_config.xml

@Praveen7294

Praveen7294 commented Feb 27, 2026

Copy link
Copy Markdown
Contributor Author

@vivek-0509 Thanks

@Praveen7294

Praveen7294 commented Feb 27, 2026

Copy link
Copy Markdown
Contributor Author

GitHub, generate report

@github-actions

github-actions Bot commented Feb 27, 2026

Copy link
Copy Markdown
Contributor

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/69d11d2_2026190807/reports/diff/index.html

@Praveen7294

Praveen7294 commented Feb 27, 2026

Copy link
Copy Markdown
Contributor Author

i reviewed diff report and found ambiguous case.

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/69d11d2_2026190807/reports/diff/openjdk25/index.html#A4

/*****************************************************************
 * CPUSet Subsystem.
 *****************************************************************/

It is hard to determine whether it is a block comment or a Javadoc, especially when it is written above a method, class, or any valid Javadoc position. Therefore, it cannot be classified unambiguously as either a block comment or a Javadoc.

@Praveen7294

Praveen7294 commented Mar 5, 2026

Copy link
Copy Markdown
Contributor Author

@romani please review, i am going to participate in gsoc so working on new check will be very helpful for me.

@Praveen7294 Praveen7294 force-pushed the javadoc branch 6 times, most recently from 7016b5e to 889d830 Compare March 20, 2026 06:32
@Praveen7294 Praveen7294 mentioned this pull request Mar 21, 2026
Merged
aclfe
aclfe reviewed Mar 21, 2026
View reviewed changes
Comment thread config/suppressions.xml
<!-- suppressed BlockCommentEndPosition in some files -->
<suppress checks="BlockCommentEndPosition"
files="[\\/]src[\\/]main[\\/]java[\\/]com[\\/]puppycrawl[\\/]tools[\\/]checkstyle[\\/]DefaultLogger.java"/>
<suppress checks="BlockCommentEndPosition"

@aclfe aclfe Mar 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You might also need to add suppression to pass CI

@Praveen7294 Praveen7294 Mar 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

i already created a PR sevntu-checkstyle/sevntu.checkstyle#1157. Do i need to suppress here?

@aclfe aclfe Mar 22, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I didn't know you had a PR up, that should be fine then! The violations seem minimal and I assume main files should be compliant rather than surpressed

@Praveen7294 Praveen7294 Mar 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

no problem

@romani

romani commented Mar 24, 2026

Copy link
Copy Markdown
Member

sevntu PR is merged, and this PR is rebased in web

@romani

romani commented Mar 24, 2026

Copy link
Copy Markdown
Member

GitHub, generate website

@github-actions

github-actions Bot commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/66945d6_20260324113705/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/66945d6_20260324113705/checks.html#Standard_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/66945d6_20260324113705/checks/javadoc/blockcommentendposition.html#

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/66945d6_20260324113705/checks/javadoc/index.html#Javadoc_Comments_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/66945d6_20260324113705/property_types.html#BlockOption

@Praveen7294 Praveen7294 force-pushed the javadoc branch 3 times, most recently from 416c53d to 550c129 Compare March 24, 2026 14:01
@Praveen7294

Praveen7294 commented Mar 24, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

due to small changes in docs i am generating site again.

@Praveen7294

Praveen7294 commented Mar 24, 2026

Copy link
Copy Markdown
Contributor Author

GitHub, generate website

@github-actions

github-actions Bot commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/550c129_20260324150108/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/550c129_20260324150108/checks.html#Standard_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/550c129_20260324150108/checks/javadoc/blockcommentendposition.html#

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/550c129_20260324150108/checks/javadoc/index.html#Javadoc_Comments_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/550c129_20260324150108/property_types.html#BlockOption

@Praveen7294

Praveen7294 commented Mar 24, 2026

Copy link
Copy Markdown
Contributor Author

@romani resolved all error and most of the ci is green, please review

@Praveen7294

Praveen7294 commented Mar 24, 2026

Copy link
Copy Markdown
Contributor Author

GitHub, generate report

@github-actions

github-actions Bot commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/550c129_2026202035/reports/diff/index.html

@Praveen7294 Praveen7294 force-pushed the javadoc branch 3 times, most recently from eb48ea5 to e83301b Compare March 31, 2026 16:01
@Praveen7294

Praveen7294 commented Apr 1, 2026

Copy link
Copy Markdown
Contributor Author

@romani please review

@Praveen7294

Praveen7294 commented Apr 29, 2026

Copy link
Copy Markdown
Contributor Author

@romani I have rebased this PR, please review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@aclfe aclfe aclfe left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Praveen7294 @vivek-0509 @romani @aclfe