Enable Javadoc doclint (all,-missing) with failOnWarnings on JDK 11 and JDK 26#1070
Open
vharseko wants to merge 3 commits into
Open
Enable Javadoc doclint (all,-missing) with failOnWarnings on JDK 11 and JDK 26#1070vharseko wants to merge 3 commits into
vharseko wants to merge 3 commits into
Conversation
…nd JDK 26 - pom: doclint=all,-missing via inherited property; failOnWarnings=true; maven-javadoc-plugin 3.11.2 -> 3.12.0; source 8 -> 11 with --add-exports for the sun.* internal APIs a few legacy classes use (keeps JDK 26 free of [removal] warnings without touching AccessController usages) - Remove per-module javadoc skips so docs build everywhere; keep openam-mcp-server skipped (Java 17 records cannot be processed on the JDK 11 doc baseline) - .gitattributes: check out *.html with LF so JDK 25/26 doclint does not treat CR as part of a multi-line tag name - Fix every doclint error/warning across all modules: authored real @param/@return/ @throws descriptions, HTML/entity/self-closing/{@link} fixes, JAXB schema sanitize
…lonwarnings # Conflicts: # openam-test/pom.xml
…om master) SampleAuth.init: author the three empty @param descriptions so the newly merged openam-samples module passes failOnWarnings.
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
Enables Javadoc doclint (
all,-missing) withfailOnWarnings=true, and fixes every resulting error and warning across all modules somvn javadoc:javadocis green on both JDK 11 and JDK 26.Configuration
pom.xml:doclint=all,-missing(inherited property),failOnWarnings=true, maven-javadoc-plugin3.11.2 → 3.12.0.<source>8</source>→<source>11</source>(matches the compiler) plus--add-exportsfor the four JDK-internalsun.*packages a few legacy classes use. Together these keep JDK 26 free of[removal]platform-deprecation warnings (e.g.AccessController) without touching any of the ~350 usages.<skip>overrides so docs build everywhere. openam-mcp-server stays skipped (Java 17 records can't be processed by the Javadoc tool on the JDK 11 doc baseline)..gitattributes:*.html text eol=lfso JDK 25/26 doclint doesn't treat CR (from CRLF) as part of a multi-line tag name.Fixes
Javadoc-comment-only changes across ~60 modules (no runtime logic changed): authored real
@param/@return/@throwsdescriptions, fixed HTML (<tt>→<code>, empty/self-closing<p>, escaped</>/&or{@code}), resolved or{@code}-converted unreachable{@link}, removed@inheritDocon non-overriding methods, correctedexception not thrown, and sanitized the frozen JAXB schema modules. Two SNMP.mibDESCRIPTIONs had a raw&(copied verbatim into generated Javadoc) reworded toand. All modified files carry aPortions Copyrighted 2026 3A Systems, LLCline.Verification
Full-reactor
mvn javadoc:javadocwithfailOnWarnings=true(-fae): BUILD SUCCESS on JDK 11 and JDK 26, zero doclint findings, zero[removal]warnings.