ci(javadoc): validate public testing.* helpers under strict doclint (Track N N5)#128
Merged
Merged
Conversation
…Track N N5) Widen the maven-javadoc-plugin validation <subpackages> from com.demcha.compose.document to also include com.demcha.compose.testing, so the public testing-support helpers (testing.layout + testing.visual, @SInCE 1.6.9) get the same doclint=all / failOnError gate as the canonical document API. javadoc:javadoc BUILD SUCCESS; testing.* now documented and doclint-clean (pre-existing document.* template warnings unchanged). No artifact or behaviour change.
DemchaAV
added a commit
that referenced
this pull request
Jun 3, 2026
Clear every doclint warning on the public canonical surface (com.demcha.compose.document.*) so `mvn javadoc:javadoc` (doclint=all) runs warning-free. Scope was far larger than first visible: javadoc's default -Xmaxwarns=100 cap surfaced only ~100 warnings, but the true count was 929 across 142 files / 28 packages (raised the cap to enumerate the full set, then reverted). Mix: 471 no-@param, 191 no-@return, 205 no-comment, 35 no-main-description, 16 use-of-default-constructor, 9 @deprecated-in- package-info, 2 no-@throws. Additive Javadoc only, with two sanctioned, behaviour-neutral exceptions: - 16 explicit no-arg constructors in layout/definitions/* — documents the otherwise-synthesised public default constructor (identical behaviour); the repo-idiomatic fix for doclint's "use of default constructor". - removal of the @deprecated block-tags doclint forbids in 9 package-info files (the @deprecated annotation + prose body already carry the notice). No public or runtime behaviour change. Verified: javadoc:javadoc is warning-clean under doclint=all (real CI config) and the full suite is green (1060 tests, 0 failures, 0 errors). Follows cycle 1.6.9 Track N (PR #128 widened javadoc validation to testing.*); these document.* gaps predate that work.
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.
Track N / N5 — strict doclint for public testing helpers (cycle 1.6.9)
Small build-lane follow-up to #126 / #127. The CI Javadoc validation (
maven-javadoc-plugin,doclint=all,failOnError=true) only coveredcom.demcha.compose.document. This widens it to also includecom.demcha.compose.testing, so the public testing-support helpers —testing.layout.*(semantic snapshots) andtesting.visual.*(pixel regression, new in #126) — get the same strict-doclint gate.Why
The release-profile javadoc jar is lenient (
doclint=none,failOnError=false) and already ships these packages, so a Javadoc mistake intesting.*would slip through unnoticed. This closes that gap for the public testing surface.Verification
./mvnw javadoc:javadoc -pl .→ BUILD SUCCESS;testing.layout+testing.visualnow generate apidocs and are doclint-clean (no warnings on them).document.*template doclint warnings (e.g.CvThememissing@return) are unchanged — they predate this PR, remain warnings (not errors), so the build stays green. Out of scope here; candidate for a separate template-Javadoc cleanup.No artifact or runtime behaviour change.