Clean up Javadoc warnings and fail the build on new ones#271
Merged
vharseko merged 2 commits intoJul 12, 2026
Conversation
- Remove the deprecated <footer> config that only emitted the JDK "-footer option is no longer supported" warning; the header already carries the same title. - Drop the empty <p></p> in the launcher overview that produced an "empty <p> tag" Javadoc warning. - HTML-escape '&', '<' and '>' in the message text embedded into the Javadoc of the i18n-generated message classes so generated sources stay warning-free. - Enable failOnWarnings in maven-javadoc-plugin so any future Javadoc warning (html, syntax, reference, accessibility) fails the build. - Bump maven-javadoc-plugin to 3.12.0 and align the two modules that pinned older versions (2.9, 2.6.1) to the shared property.
JDK 11's doclint reports "no description for @param/@throws/@return" for block tags whose description is empty; JDK 17+ does not. With failOnWarnings enabled this failed the JDK 11 CI jobs. Fill in concise, accurate descriptions for all such tags across the reactor (mostly persistit/core) so the Javadoc build is warning-free on every JDK. Comment-only changes; no code behavior affected.
maximthomas
approved these changes
Jul 11, 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
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
Makes the Javadoc build produce 0 warnings and turns warnings into hard build errors so regressions cannot slip back in — enforced across the whole JDK matrix (11, 17, 21, 25, 26).
Changes
Warning cleanup + enforcement
<footer>config in the parentmaven-javadoc-pluginsetup — it only emitted the JDK-footer option is no longer supported and will be ignoredwarning (once per module). The<header>already carries the same title, so rendered docs are unchanged.<p></p>inlauncheroverview.htmlthat produced anempty <p> tagwarning.&,<,>in the message text that the i18nAbstractGenerateMessagesMojoembeds into the Javadoc of generated message classes (LDAP filters / HTML fragments would otherwise emit invalid Javadoc in generated sources). The runtime message is still loaded by key from the property bundle, so escaping the doc comment is harmless.failOnWarningsinmaven-javadoc-pluginso any remaining Javadoc warning (html, syntax, reference, accessibility) fails the build. Themissingdoclint group stays suppressed viadoclint=all,-missing, so documentation-completeness gaps do not fail the build — only real markup/reference problems do.maven-javadoc-pluginto 3.12.0 (from 3.10.1) and align the two modules that pinned older versions (launcher2.9,maven-external-dependency-plugin2.6.1) to the shared${javadocPluginVersion}property.JDK 11 doclint: fill in empty block-tag descriptions
no description for @param/@throws/@returnfor block tags whose description is empty; JDK 17+ does not report this at all. WithfailOnWarningson, that failed the JDK 11 CI jobs while JDK 17+ stayed green.persistit/coremodule (plusscript,audit,json-schema,selfservice,launcher,maven-external-dependency-plugin). Descriptions are derived from each method's signature/body and reuse the module's house wording (e.g.PersistitException-> "if a persistence error occurs").Verification
mvn javadoc:javadocon JDK 11 (failOnWarnings=true) ->BUILD SUCCESS, 0 warnings.mvn javadoc:jar(the goal that failed CI) on JDK 11 ->BUILD SUCCESS.mvn javadoc:javadocon JDK 26 ->BUILD SUCCESS, 0 warnings (confirms the new descriptions introduced no bad HTML/markup).failOnWarningsactually bites: injecting an empty<p>/ empty tag makes the build fail withProject contains Javadoc Warnings, then reverted.