Javadoc: preserve multi-line HTML comments inside block tags#7500
Merged
Javadoc: preserve multi-line HTML comments inside block tags#7500
Conversation
`convertMultiline` already routed `DCText` through `visitText` so that each newline consumes the corresponding `LineBreak` (with its `*` margin) from the lineBreaks map. `DCComment` fell through to `scan`/`visitComment`, which bumped the cursor by the body length in one shot and wrapped the multi-line body in a single `Javadoc.Text`. The result was that interior `*` margins were dropped and orphan `LineBreak`s were appended at the end of the doc as extra blank `*` lines. Mirror the `DCText` handling for `DCComment` across all version-specific visitors.
greg-at-moderne
approved these changes
Apr 28, 2026
This was referenced May 1, 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
<!-- ... -->HTML comment inside a Javadoc block tag (e.g.@version,@param,@return) was printed back with the leading*margin missing on interior lines and with orphan*lines appended after the comment.convertMultilinealready routedDCTextthroughvisitText(which consumes aLineBreakper newline).DCCommentfell through toscan->visitComment, which bumped the cursor by the body length in one shot and wrapped the multi-line body in a singleJavadoc.Text— so interior margins were dropped and the unconsumedLineBreaks spilled out at the end of the doc.DCTexthandling forDCCommentinconvertMultilineacrossrewrite-java-{8,11,17,21,25}and add a regression test.Test plan
./gradlew :rewrite-java-21:compatibilityTest --tests "*JavadocTest*"./gradlew :rewrite-java-{8,11,17,25}:compatibilityTest