Fix all Javadoc generation warnings#5
Merged
Conversation
Resolve the Javadoc generation warnings for genuinely undocumented API: * Add @param for each IndexDefinition record component and @return on hasExpressionColumn(). * Add @return on DatabasePlatform.fromDataSource/fromProductName and on every audit's audit(...) method. * Document the CapturedSqlPlanAuditTemplate template and abstract methods (@return and @param) and the WHERE/ORDER BY/JOIN plan-audit constructors. * Comment the serialized `captured` field on the Serializable SqlCapturingStatementInspector. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AUPjqVyqjReDQqn3sefVkK
…tors The Javadoc tool reads the raw source before Lombok generates the @AllArgsConstructor constructors and so reports a phantom default constructor ("use of default constructor, which does not provide a comment") on each annotated class. Configure maven-javadoc-plugin with <doclint>all,-missing</doclint> to silence those false positives; the reference, syntax, html, and accessibility doclint checks stay on. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AUPjqVyqjReDQqn3sefVkK
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (15)
📝 WalkthroughWalkthroughAdds ChangesJavadoc Coverage and Doclint Enforcement
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
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
mvnw javadoc:javadocemitted 39 warnings. This branch takes it to 0 (BUILD SUCCESS), split into two atomic commits.Changes
docs(core)— 28 genuine doc gaps, fixed by writing the docs:@paramfor eachIndexDefinitionrecord component +@returnonhasExpressionColumn()@returnonDatabasePlatform.fromDataSource/fromProductNameand on every audit'saudit(...)method@return/@paramacrossCapturedSqlPlanAuditTemplate's template and abstract methods, plus constructor Javadoc on the WHERE/ORDER BY/JOIN plan auditscapturedfield of theSerializableSqlCapturingStatementInspector(that one was a serialized-form warning)build(pom)— 11 Lombok false-positives, suppressed:@AllArgsConstructorconstructors, so it reports a phantom default constructor on each annotated class. Configuredmaven-javadoc-pluginwith<doclint>all,-missing</doclint>. Thereference,syntax,html, andaccessibilitydoclint checks stay on.Verification
mvnw clean javadoc:javadoc→ 0 warnings, BUILD SUCCESS.Notes
database-audits-spring-boot'sDatabaseAuditTestConfigurationneeds no update.🤖 Generated with Claude Code
https://claude.ai/code/session_01AUPjqVyqjReDQqn3sefVkK
Summary by CodeRabbit