Repository navigation
style: document public API and fail the build on javadoc warnings - #2470
Merged
Merged
Conversation
Add the missing Javadoc flagged by the javadoc task (1563 "no comment" warnings) and fix the JavadocParagraph checkstyle warnings. To prevent regressions, JavadocParagraph is now an error, and the javadoc tasks run with -Xwerror so any javadoc warning fails the build. One-line enums were split into one constant per line so that each constant can carry its own comment. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
mykola-mokhnach
requested review from
SrinivasanTarget,
saikrishna321 and
valfirst
as code owners
October 7, 2026 10:20
JDK 18+ warns about implicit default constructors and about missing @PARAM tags for the type parameters of classes. Add the missing type parameter tags and explicit documented constructors. For the Lombok classes (@Data/@value), the constructors are written by hand with the same signature Lombok generated, because javadoc cannot see the generated ones. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
valfirst
approved these changes
Oct 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add the missing Javadoc flagged by the javadoc task (1563 "no comment" warnings) and fix the JavadocParagraph checkstyle warnings.
To prevent regressions, JavadocParagraph is now an error, and the javadoc tasks run with -Xwerror so any javadoc warning fails the build.
One-line enums were split into one constant per line so that each constant can carry its own comment.