904 javadoc param return gaps - #906
Merged
Merged
Conversation
Iterated "mvnw javadoc:aggregate-no-fork" across 17 rounds (doclint caps displayed warnings at ~100 per invocation) until it reported zero warnings: missing one-sentence summaries on tag-only doc blocks, missing or description-less @param/@return/@throws tags, explicit default constructors for classes relying on an undocumented implicit one, and missing field/method comments including on Serializable classes' private members that doclint checks regardless of visibility. Test source warnings, never previously held to any doclint standard, are tracked separately. Refs: 904
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @jeffjensen, your pull request is larger than the review limit of 500000 diff characters
|
Important Review skippedToo many files! This PR contains 287 files, which is 187 over the limit of 100. To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch. Upgrade to a paid plan to raise the limit. This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (287)
You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Reviewer's GuideAdds and enriches Javadoc across assertion, dataset, XML/CSV/excel, concurrency, and database-related classes, and wires doclint configuration into the Maven Javadoc plugin, improving documentation quality without changing runtime behavior. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Adding a no-arg constructor purely to give doclint's default-constructor check something to attach a comment to adds no real information. Regretfully, disabling the check also disables the useful missing-Javadoc checks on real methods, since doclint has no way to suppress only the default-constructor case. Refs: 904
jeffjensen
force-pushed
the
904-javadoc-param-return-gaps
branch
from
August 4, 2026 02:31
14e42f0 to
40b58ea
Compare
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
1 participant
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.
Summary by Sourcery
Complete and standardize Javadoc across the main source tree, adding missing descriptions and tags and aligning documentation with behavior, while updating build configuration to run stricter Javadoc checks and recording the change in the changelog.
Enhancements:
Build:
Documentation: