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
Simplify JavadocStyleCheck: remove functionality for missing package-info Javadoc #12520
Labels
Milestone
Comments
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 12, 2022
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 12, 2022
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 12, 2022
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 13, 2022
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 13, 2022
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 13, 2022
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 19, 2022
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 20, 2022
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 20, 2022
rnveach
added a commit
to rnveach/checkstyle
that referenced
this issue
Dec 22, 2022
nrmancuso
pushed a commit
to rnveach/checkstyle
that referenced
this issue
Dec 29, 2022
nrmancuso
pushed a commit
that referenced
this issue
Dec 30, 2022
Closed via #12521 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Identified at #7416 item 1,
https://checkstyle.org/config_javadoc.html#JavadocStyle
We are attempting to trim back JavadocStyleCheck to help with a conversion to AbstractJavadocCheck. The first thing is to remove functionality that is identified as already being available in other checks.
This will remove this functionality and guide users on how to migrate their check.
https://www.baeldung.com/java-package-info
https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful
========
Migration Notes
Users will have to add
MissingJavadocPackage
to their configuration, if it is not there already. No other options are needed.Old Config Example:
Migrated Config Example:
attention:
javadoc.missing
is removed from JavadocStyle module.The text was updated successfully, but these errors were encountered: