Fix javadoc errors blocking the release build#6015
Merged
Conversation
The Release workflow attaches `maven-javadoc-plugin:jar` and fails the
build on any javadoc `error:`. Run 27341204859 broke on two errors in
api-modules-java:
- TemplateEngines.java:28 — "unterminated inline tag". The phrase
`{@code {{}} for Mustache` contained an inline tag whose argument
itself started with `{`, which javadoc parsed as the start of another
inline tag and never found a matching `}`. Replaced with
`<code>{{ }}</code>` so the braces render
literally without entering the javadoc tag grammar.
- Assert.java:21 — "reference not found". `{@link
org.junit.jupiter.api.Assertions}` only resolves when JUnit Jupiter
is on the javadoc tool's classpath, which api-modules-java is not.
Replaced with `{@code …}` since the mention is purely documentation.
CLAUDE.md now carries the rule under the Conventions section: javadoc
must compile clean on every release-participating module; verify with
`mvn -P release -Dgpg.skip=true -DskipTests -Dlicense.skip=true
-Dformatter.skip=true install` before pushing javadoc-changing code.
The bullet enumerates the three recurring failure modes (unterminated
inline tag from `{@code {…}}`, `@link` to non-classpath types, missing
public-member comments) with the workaround for each.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
The Release run 27341204859 failed in
maven-javadoc-plugin:3.12.0:jar (attach-javadocs)onapi-modules-java:TemplateEngines.java:28— unterminated inline tag.{@code {{}} for Mustacheparsed the inner{{as the start of another inline tag and could not find a matching}before the paragraph ended. Replaced with<code>{{ }}</code>so the braces render literally without entering the javadoc tag grammar.Assert.java:21—@linkreference not found.{@link org.junit.jupiter.api.Assertions}only resolves when JUnit Jupiter is on the javadoc tool's classpath, whichapi-modules-javais not. Replaced with{@code …}— the mention is purely documentation, no link wanted.CLAUDE.mdnow carries the rule that javadoc must compile clean on every release-participating module, plus the verification command and the three recurring failure modes (braces inside{@code},@linkto non-classpath types, missing public-member comments).Verified locally
Same goal that broke in CI.
🤖 Generated with Claude Code