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

Include MissingDeprecated in the default checks #420

Closed
wilkinsona opened this issue Jul 26, 2024 · 0 comments
Closed

Include MissingDeprecated in the default checks #420

wilkinsona opened this issue Jul 26, 2024 · 0 comments
Assignees
Milestone

Comments

@wilkinsona
Copy link
Contributor

wilkinsona commented Jul 26, 2024

https://checkstyle.sourceforge.io/checks/annotation/missingdeprecated.html

Having @deprecated in the javadoc without @Deprecated on the element can lead to an inconsistent view of whether or not something is deprecated. The JLS requires compilers to warn when someone uses code that is annotated with @Deprecated. It does not require them to warn when code is documented with @deprecated, but javac does so. It would be good to always use @deprecated and @Deprecated together so that our code avoids this potential inconsistency.

If we do this, it would also make sense to change this setting in Eclipse:

This would also align with the cleanup settings where @Deprecated is added automatically when the javadoc contains @deprecated:

@wilkinsona wilkinsona added this to the 0.0.x milestone Jul 26, 2024
@wilkinsona wilkinsona self-assigned this Jul 26, 2024
@wilkinsona wilkinsona modified the milestones: 0.0.x, 0.0.43 Jul 26, 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

1 participant