fix(intent): escape '<-' in ExpansionIntent javadoc - malformed HTML fails the release javadoc build#6261
Merged
Merged
Conversation
…fails the release javadoc build The class-level <pre> example in ExpansionIntent.java used bare '<-' arrows, which javadoc's doclint parses as a malformed HTML tag start. The attach-javadocs goal runs only in the release profile, so PR CI stayed green while the master release failed at maven-javadoc-plugin:jar on dirigible-components-engine-intent. Escaped as '<-'. Verified: javadoc:jar on the module now builds the javadoc jar with no errors (only pre-existing non-fatal @param warnings). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…horing rules The CLAUDE.md javadoc section already mandates the release-profile javadoc check before pushing javadoc changes, but its failure-mode list was missing the one that broke the 2026-07-10 release: a bare '<' (e.g. an ASCII '<-' arrow) in javadoc prose or <pre> blocks is parsed by doclint as a malformed HTML tag start. Co-Authored-By: Claude Fable 5 <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.
What
The class-level
<pre>example inExpansionIntent.javaused bare<-arrows in two comment lines; javadoc's doclint parses<-as a malformed HTML tag start. Escaped as<-.Why
The master Release run failed at
maven-javadoc-plugin:jar (attach-javadocs)ondirigible-components-engine-intent:https://github.com/eclipse-dirigible/dirigible/actions/runs/29115413235/job/86437470200
attach-javadocsruns only in the release profile, so PR CI stayed green while the release broke.engine-intentwas the last module in the reactor - nothing was skipped after it, so this one-file fix unblocks the release.Verified
mvn javadoc:jar -Dmaven.javadoc.skip=falseon the module now produces the javadoc jar with no errors (only pre-existing non-fatalno @paramrecord warnings, same as before).A repo-wide sweep found no other unescaped
<-in javadoc comment lines.🤖 Generated with Claude Code