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
Issue #11736: Support qualified annotation names for MissingJavadocTypeCheck #11827
Issue #11736: Support qualified annotation names for MissingJavadocTypeCheck #11827
Conversation
7ede563
to
66c557a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please generate check regression report for all checks that use this method (See https://github.com/checkstyle/contribution/tree/master/checkstyle-tester#report-generation):
➜ checkstyle git:(master) grep -lR "AnnotationUtil.containsAnnotation(" | grep -iv "Test" | uniq
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocTypeCheck.java
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocMethodCheck.java
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTypeCheck.java
src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java
src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/PackageAnnotationCheck.java
Few items to start with:
src/main/java/com/puppycrawl/tools/checkstyle/utils/AnnotationUtil.java
Outdated
Show resolved
Hide resolved
src/main/java/com/puppycrawl/tools/checkstyle/utils/AnnotationUtil.java
Outdated
Show resolved
Hide resolved
...ckstyle/checks/javadoc/missingjavadocmethod/InputMissingJavadocMethodAllowedAnnotations.java
Outdated
Show resolved
Hide resolved
Please look at failed CI they will guide you on what to improve. |
66c557a
to
cbb051d
Compare
No need to re-request review, please reply “done” to each item as you complete it and confirm that changes are pushed. Please generate check regression reports before we proceed. |
Github, generate report |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Items
src/main/java/com/puppycrawl/tools/checkstyle/utils/AnnotationUtil.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Items
src/test/java/com/puppycrawl/tools/checkstyle/utils/AnnotationUtilTest.java
Outdated
Show resolved
Hide resolved
c8e666b
to
8aa65e4
Compare
8aa65e4
to
71d7c0c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Item for whole PR:
...ckstyle/checks/javadoc/missingjavadocmethod/InputMissingJavadocMethodAllowedAnnotations.java
Outdated
Show resolved
Hide resolved
71d7c0c
to
d152226
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok to merge
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add test cases:
- With multiple, qualified
skipAnnotations
, i.e. MissingJavadocType: Support qualified annotation names #11736 (comment) - With multiple (3+) annotations on a given type, with a few variations of number of skipAnnotations.
...tyle/checks/javadoc/missingjavadoctype/InputMissingJavadocTypeFullyQualifiedAnnotation4.java
Outdated
Show resolved
Hide resolved
d152226
to
e5cad07
Compare
Done!
|
Addresses #11736
Adds support for qualified annotation names in
MissingJavadocTypeCheck
.Diff Regression config: https://gist.githubusercontent.com/stoyanK7/37de7a689373daea1df3ec5f4e16efbb/raw/4f28948a768d7cf7fb3a59f6f1faf9e6152d28fa/config.xml