docs(bench): escape the ampersand that fails the benchmarks javadoc build - #599
Merged
Conversation
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.
Why
ComparativeBenchmark's class Javadoc carries a raw&("CPU & RAM"), whichjavadocrejects as a bad HTML entity — so a full-reactor./mvnw -B -ntp javadoc:javadocfails on the benchmarks module. Nothing ever went red for it because the CI javadoc gate excludes benchmarks; the break only surfaces when someone runs the gate across the whole reactor locally.What changed
benchmarks/src/main/java/com/demcha/compose/ComparativeBenchmark.java—&→&in the class Javadoc. A sweep of the module's Javadoc found no other raw&/</>; the remaining doclint output is missing-comment warnings, which don't fail the build.Verification
./mvnw -B -ntp javadoc:javadoc -pl :graph-compose-benchmarks -am→ BUILD SUCCESS (exit 0, zeroerror:lines). No runtime code touched.Lane: docs — one Javadoc literal in the benchmarks module.