Skip to content

Fix dangling-doc-comments warnings#8559

Merged
mbien merged 7 commits intoapache:masterfrom
mbien:tripple-slash-fixes
Jun 5, 2025
Merged

Fix dangling-doc-comments warnings#8559
mbien merged 7 commits intoapache:masterfrom
mbien:tripple-slash-fixes

Conversation

@mbien
Copy link
Member

@mbien mbien commented Jun 5, 2025

fixes hundreds thousands of javac warnings (dangling-doc-comments) and avoids situations when comments wrongly show up as javadoc.

  • unintended line comment ('///')
  • some dead (and commented out) code removal
  • some removal of decorative comments
  • fixed wrong annotation/doc ordering
  • fixed package comments meant for classes
  • various other dangling comment warnings

project wide, split into 7 commits across cluster boundaries (enterprise commit is the largest)

the remaining warnings are from generated code.

closes #8392

@mbien mbien added this to the NB27 milestone Jun 5, 2025
@mbien mbien added Code cleanup Label for cleanup done on the Netbeans IDE ci:all-tests [ci] enable all tests JavaDoc [ci] enable java/javadoc tests and build-javadoc target DO NOT squash labels Jun 5, 2025
Copy link
Contributor

@lkishalmi lkishalmi left a comment

Choose a reason for hiding this comment

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

OMG! This one kills my Firefox!

Copy link
Contributor

@ebarboni ebarboni left a comment

Choose a reason for hiding this comment

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

Huge tanks for doing this

Copy link
Member

@neilcsmith-net neilcsmith-net left a comment

Choose a reason for hiding this comment

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

Thanks, looks good from what I can see.

My Firefox just about coping! 🤣

@mbien
Copy link
Member Author

mbien commented Jun 5, 2025

reviewing this via github is no fun, but one way of going through huge diffs is to look at the patch files of the individual commits

example: https://github.com/apache/netbeans/pull/8559/commits/01ef19cf8d5031d0836d3f230b22c852f343f5ce.patch

I use also a browser plugin called Enlight, it can provide syntax highlighting for code in general, but I use it only for patch/diff files, so that the patch link above will show up in the familiar colors.

I looked through it in NB, the vertical split button is very useful for that and I have prev/next mapped to mouse buttons.

Details

image

thanks for the reviews. Will merge once github resolved the problem with actions.

mbien added 7 commits June 5, 2025 21:58
fixes hundreds of javac warnings and avoids situations when comments
wrongly show up as javadoc.

 - unintentional '///'
 - some dead (and commented out) code removal
 - some removal of decorative comments
 - fixed wrong annotation/doc ordering
 - various other dangling comment situations
fixes hundreds of javac warnings and avoids situations when comments
wrongly show up as javadoc.

 - unintentional '///'
 - some dead (and commented out) code removal
 - some removal of decorative comments
 - fixed wrong annotation/doc ordering
 - various other dangling comment situations
fixes hundreds of javac warnings and avoids situations when comments
wrongly show up as javadoc.

 - unintentional '///'
 - some dead (and commented out) code removal
 - some removal of decorative comments
 - fixed wrong annotation/doc ordering
 - various other dangling comment situations
fixes hundreds of javac warnings and avoids situations when comments
wrongly show up as javadoc.

 - unintentional '///'
 - some dead (and commented out) code removal
 - some removal of decorative comments
 - fixed wrong annotation/doc ordering
 - various other dangling comment situations
fixes hundreds of javac warnings and avoids situations when comments
wrongly show up as javadoc.

 - unintentional '///'
 - some dead (and commented out) code removal
 - some removal of decorative comments
 - fixed wrong annotation/doc ordering
 - various other dangling comment situations
fixes hundreds of javac warnings and avoids situations when comments
wrongly show up as javadoc.

 - unintentional '///'
 - some dead (and commented out) code removal
 - some removal of decorative comments
 - fixed wrong annotation/doc ordering
 - various other dangling comment situations
fixes hundreds of javac warnings and avoids situations when comments
wrongly show up as javadoc.

 - unintentional '///'
 - some dead (and commented out) code removal
 - some removal of decorative comments
 - fixed wrong annotation/doc ordering
 - various other dangling comment situations
@mbien mbien removed the ci:all-tests [ci] enable all tests label Jun 5, 2025
@mbien
Copy link
Member Author

mbien commented Jun 5, 2025

will rebase and merge, github works again

@mbien mbien force-pushed the tripple-slash-fixes branch from d4d1baf to 2a0acf0 Compare June 5, 2025 20:00
@mbien mbien merged commit a2953e8 into apache:master Jun 5, 2025
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Code cleanup Label for cleanup done on the Netbeans IDE JavaDoc [ci] enable java/javadoc tests and build-javadoc target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cleanup '///' comment occurences which were not meant to be javadoc comments

5 participants

Comments