Eliminate all Javadoc warnings across the reactor#30
Merged
Conversation
The -Pfull-build javadoc jar goal (attach-javadocs) emitted ~260 doclint warnings across all modules — missing @param/@return, undocumented members, enum constants, record components, and uncommented default constructors. Documents every affected public/protected API element with meaningful Javadoc. Purely additive documentation: the only non-comment changes are behaviour-neutral explicit constructors (identical to the previously implicit ones) added to @Configuration/@autoConfiguration classes, entities, and the ImageUtilities utility class, so the "use of default constructor" warnings can carry a comment. No method signatures, field types, annotations, or logic changed; no test code touched. Verified with `./mvnw -o -Pfull-build clean verify`: 0 javadoc warnings, all tests green across the 9-module reactor. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
build.yml previously ran `./mvnw clean verify`, which does not run the Javadoc jar goal — so doclint warnings only surfaced in the tag-triggered release build. Switch CI to the release-equivalent `-Pfull-build clean verify` and set `-Dmaven.javadoc.failOnWarnings=true`, so any Javadoc warning fails the PR build and cannot regress silently. Also validates the sources jar and CycloneDX SBOM in CI. Verified locally: green at 0 warnings, and a single undocumented member fails the build with "Project contains Javadoc Warnings". Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Summary
The
-Pfull-buildjavadoc-jar goal (attach-javadocs) emitted ~260 doclint warnings across all nine modules — missing@param/@return, undocumented members, enum constants, record components, and uncommented default constructors. This documents every affected public/protected API element with meaningful Javadoc so the build is warning-free.Changes
core,slack,search,dbbackup,email,mcp(116 files).@Configuration/@AutoConfigurationclasses, entities, and theImageUtilitiesutility class (private), so the "use of default constructor" doclint warnings can carry a comment..javafiles.Verification
./mvnw -o -Pfull-build clean verify: 0 javadoc warnings,BUILD SUCCESS, all tests green across the 9-module reactor.Note
Two verification passes were needed because the plain
javadoc:javadocgoal uses laxer doclint than the build'sattach-javadocsexecution; the final count is verified against the strict full-build goal that CI/release use.🤖 Generated with Claude Code