-
Notifications
You must be signed in to change notification settings - Fork 58
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
Use checkstyle for javadoc checks #551
Conversation
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Codecov Report
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more @@ Coverage Diff @@
## main #551 +/- ##
=========================================
Coverage 67.67% 67.67%
Complexity 200 200
=========================================
Files 36 36
Lines 863 863
Branches 26 26
=========================================
Hits 584 584
Misses 269 269
Partials 10 10
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
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.
Overall LGTM! One suggestion. Thanks @dbwiddis for bringing this in. I really think Spotless should consider having these checks though. 😉
* Use checkstyle for javadoc checks Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add missing javadoc tags Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com> (cherry picked from commit 711b2ba) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Use checkstyle for javadoc checks * Add missing javadoc tags --------- (cherry picked from commit 711b2ba) Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Use checkstyle for javadoc checks Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add missing javadoc tags Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: Nurym <nurym0807@gmail.com>
* Use checkstyle for javadoc checks Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add missing javadoc tags Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: Nurym <nurym0807@gmail.com>
* Use checkstyle for javadoc checks Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add missing javadoc tags Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com>
* Use checkstyle for javadoc checks Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add missing javadoc tags Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: Kuanysh <kuanysh4646@gmail.com>
* Use checkstyle for javadoc checks Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add missing javadoc tags Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: Nurym <nurym0807@gmail.com>
Description
Replaces the existing combination of RequireJavadoc and the JDK's doclint with much more configurable javadoc checking using Gradle's checkstyle plugin. RequireJavadoc lost a lot of its usefulness with doclint changes in JDK 18.
Changes:
@param
and@return
for all methods. Allows excluding@return
for the various extension interfaces where we've copied the plugin documentation.Initial commit intentionally failing checks to demonstrate the failures it caught. Second commit fixes those.
Issues Resolved
Fixes #496
Re-implements fix for #3 and #27
See comment thread on #18 starting here regarding use of checkstyle. The removal from OpenSearch was due to conflicts in formatting configurations, but has no impact on the additional capabilities checkstyle brings to fill gaps where spotless (and any other tools we have tried) have failed.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.