Enforce Javadoc doclint via inherited property and failOnWarnings#166
Merged
vharseko merged 1 commit intoJul 16, 2026
Merged
Conversation
Replace the blanket <doclint>none</doclint> with an inherited
<doclint>all,-missing</doclint> property (referenced as ${doclint}),
bump maven-javadoc-plugin to 3.12.0, and enable <failOnWarnings>true</failOnWarnings>
so Javadoc problems break the build.
Fix every doclint error and warning surfaced across modules on both
JDK 11 and JDK 26:
- ConditionalFilter: escape the <pre> code sample (nested-brace {@code} broke on JDK 11)
- GenericHeaplet: drop {@link} to non-existent GenericHeapObject
- RouterHandler, MCPServerFeaturesFilter: <br/> -> <br>
- MCPServerFeaturesFilter: escape bare & as &
- ExpressionRequestAsyncFunction: add description for @param <V>
- OpenApiValidationFilter: remove orphan </p>
- Keys: drop type arguments from {@link Factory}
- JsonValues: <tt> -> <code>
- PasswordReplayFilterHeaplet: fix heading-level sequence (JDK 26)
vharseko
added
ci
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.
Summary
<doclint>none</doclint>with a single inherited<doclint>all,-missing</doclint>property, referenced as<doclint>${doclint}</doclint>in the javadoc plugin config (there were no per-module duplicates to drop).
maven-javadoc-pluginto 3.12.0 and enable<failOnWarnings>true</failOnWarnings>so Javadoc problems break the build.
Doclint fixes (Javadoc comments only — no behavior change)
ConditionalFilter<pre>code sample (nested-brace{@code}broke on JDK 11)GenericHeaplet{@link}to non-existentGenericHeapObjectRouterHandler,MCPServerFeaturesFilter<br/>→<br>MCPServerFeaturesFilter&as&ExpressionRequestAsyncFunction@param <V>OpenApiValidationFilter</p>Keys{@link Factory}JsonValues<tt>→<code>PasswordReplayFilterHeapletVerification
mvn package(the CI command — runs theattach-javadocsjar goal withfailOnWarnings=true): BUILD SUCCESS on both JDK 11 and JDK 26.javadoc:javadoc: 0 errors / 0 warnings on both JDKs.javadoc:aggregate -pl '!openig-war' -pl '!openig-ui'(deploy workflow): BUILD SUCCESS.maven.javadoc.skip; the only javadoc<skip>isfalse).