Skip to content

Javadoc: preserve multi-line HTML comments inside block tags #7500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timtebeek merged 1 commit into from
Apr 28, 2026
Merged

Javadoc: preserve multi-line HTML comments inside block tags #7500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...e-java-11/src/main/java/org/openrewrite/java/isolated/ReloadableJava11JavadocVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1158,6 +1158,8 @@ private List<Javadoc> convertMultiline(List<? extends DocTree> dts) {
js.addAll(whitespaceBefore());
if (dt instanceof DCTree.DCText) {
js.addAll(visitText(((DCTree.DCText) dt).getBody()));
} else if (dt instanceof DCTree.DCComment) {
js.addAll(visitText(((DCTree.DCComment) dt).getBody()));
} else {
js.add((Javadoc) scan(dt, emptyList()));
}
Expand Down
2 changes: 2 additions & 0 deletions ...e-java-17/src/main/java/org/openrewrite/java/isolated/ReloadableJava17JavadocVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1161,6 +1161,8 @@ private List<Javadoc> convertMultiline(List<? extends DocTree> dts) {
js.addAll(whitespaceBefore());
if (dt instanceof DCTree.DCText) {
js.addAll(visitText(((DCTree.DCText) dt).getBody()));
} else if (dt instanceof DCTree.DCComment) {
js.addAll(visitText(((DCTree.DCComment) dt).getBody()));
} else {
js.add((Javadoc) scan(dt, emptyList()));
}
Expand Down
2 changes: 2 additions & 0 deletions ...e-java-21/src/main/java/org/openrewrite/java/isolated/ReloadableJava21JavadocVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1196,6 +1196,8 @@ private List<Javadoc> convertMultiline(List<? extends DocTree> dts) {
js.addAll(whitespaceBefore());
if (dt instanceof DCTree.DCText) {
js.addAll(visitText(((DCTree.DCText) dt).getBody()));
} else if (dt instanceof DCTree.DCComment) {
js.addAll(visitText(((DCTree.DCComment) dt).getBody()));
} else {
js.add((Javadoc) scan(dt, emptyList()));
}
Expand Down
2 changes: 2 additions & 0 deletions ...e-java-25/src/main/java/org/openrewrite/java/isolated/ReloadableJava25JavadocVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1339,6 +1339,8 @@ private List<Javadoc> convertMultiline(List<? extends DocTree> dts) {
js.addAll(visitText(textNode.getBody()));
} else if (dt instanceof DCTree.DCRawText rawTextNode) {
js.addAll(visitText(rawTextNode.getContent()));
} else if (dt instanceof DCTree.DCComment commentNode) {
js.addAll(visitText(commentNode.getBody()));
} else {
js.add((Javadoc) scan(dt, emptyList()));
}
Expand Down
2 changes: 2 additions & 0 deletions rewrite-java-8/src/main/java/org/openrewrite/java/ReloadableJava8JavadocVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1086,6 +1086,8 @@ private List<Javadoc> convertMultiline(List<? extends DocTree> dts) {
js.addAll(whitespaceBefore());
if (dt instanceof DCTree.DCText) {
js.addAll(visitText(((DCTree.DCText) dt).getBody()));
} else if (dt instanceof DCTree.DCComment) {
js.addAll(visitText(((DCTree.DCComment) dt).getBody()));
} else {
js.add((Javadoc) scan(dt, emptyList()));
}
Expand Down
17 changes: 17 additions & 0 deletions rewrite-java-tck/src/main/java/org/openrewrite/java/tree/JavadocTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2214,6 +2214,23 @@ class Test {
);
}

@Test
void multilineHtmlCommentInBlockTag() {
rewriteRun(
java(
"""
/**
* @version 0.1
* <!-- xml comment nested
* * [someAuthor] fixed something
* -->
**/
class Test {}
"""
)
);
}

@Issue("https://github.com/openrewrite/rewrite/issues/5443")
@Test
void parsingIncorrectJavadocValueReference() {
Expand Down
⚡