Enable doclint all,-missing with failOnWarnings; bump javadoc plugin to 3.12.0#99
Merged
vharseko merged 1 commit intoJul 16, 2026
Conversation
…to 3.12.0
Replace the repo-wide <doclint>none</doclint> with a single inherited
<doclint>all,-missing</doclint> property referenced as ${doclint}, enable
<failOnWarnings>true</failOnWarnings>, and pin maven-javadoc-plugin 3.12.0
once in root pluginManagement (dropping the stale 3.10.1 pins in
OpenICF-java-framework). Remove the javadoc <skip> in testbundlev1/v2 so
javadoc runs everywhere.
Fix all resulting doclint errors and warnings across every module on both
JDK 11 and JDK 26 (docs-only changes): real @param/@return/@throws
descriptions, self-closing <p/> -> <p>, <tt> -> <code>, class-level
{@inheritdoc} misuse, unknown/malformed tags, bogus @throws, and broken
{@link}/@see references.
vharseko
added
documentation
maximthomas
approved these changes
Jul 16, 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.
Replaces the repo-wide
<doclint>none</doclint>with a single inherited<doclint>all,-missing</doclint>property (referenced as${doclint}), enables<failOnWarnings>true</failOnWarnings>, and bumps maven-javadoc-plugin 3.11.2 → 3.12.0.POM changes
pom.xml: new<doclint>all,-missing</doclint>property; plugin config uses<doclint>${doclint}</doclint>+<failOnWarnings>true</failOnWarnings>; version 3.12.0 pinned once in root<pluginManagement>.OpenICF-java-framework/pom.xml: dropped two stale3.10.1javadoc pins (buildpluginManagement+<reporting>) that were overriding the bump for the whole framework tree.testbundlev1/testbundlev2: removed<skip>true</skip>on javadoc so javadoc now runs for every module (24 javadoc jars produced).Doclint fixes (docs-only)
Fixed every doclint error and warning across all modules — real
@param/@return/@throwsdescriptions, self-closing<p/>→<p>,<tt>→<code>, class-level{@inheritDoc}misuse, unknown/malformed tags, bogus@throws, and broken{@link}/@seereferences. No code semantics, signatures, or annotations were touched.Verification
mvn clean package(the CIverifyjavadoc path —javadoc:jarwithfailOnWarnings=true) builds green with 0 errors / 0 warnings and all 24 javadoc jars produced on JDK 11, 17, 21, and 26.Note:
-Xdoclint's-missinggroup differs by JDK — on JDK 11 empty@param/@returntags fall undersyntax, notmissing, so they are fixed with real descriptions rather than suppressed.