Skip to content

Incorrect Javadoc rendering when inline @ tokens appear in block tags #3649

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

Open
subyssurendran666 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Incorrect Javadoc rendering when inline @ tokens appear in block tags #3649

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
41 changes: 27 additions & 14 deletions ...se.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/javadoc/AbstractJavaDocConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,30 +189,43 @@ protected void print(StringBuilder buffer, String tag, String content) {
@Override
protected void printRest(StringBuilder buffer, List<Pair> rest) {
if (!rest.isEmpty()) {
Iterator<Pair> e = rest.iterator();
while (e.hasNext()) {
Pair p = e.next();
buffer.append("<li>"); //$NON-NLS-1$
if (p.fTag() != null) {
if (rest.size() == 1) {
Iterator<Pair> e = rest.iterator();
if (e.hasNext()) {
Pair p = e.next();
buffer.append(p.fTag());
}
if (p.fContent() != null) {
buffer.append("<ul><li>"); //$NON-NLS-1$
buffer.append(p.fContent());
buffer.append("</li></ul>"); //$NON-NLS-1$
} else {
Iterator<Pair> e = rest.iterator();
while (e.hasNext()) {
Pair p = e.next();
buffer.append("<li>"); //$NON-NLS-1$
if (p.fTag() != null) {
buffer.append(p.fTag());
}
if (p.fContent() != null) {
buffer.append("<ul><li>"); //$NON-NLS-1$
buffer.append(p.fContent());
buffer.append("</li></ul>"); //$NON-NLS-1$
}
buffer.append("</li>"); //$NON-NLS-1$
}
buffer.append("</li>"); //$NON-NLS-1$
}
}
}

@Override
protected String printSimpleTag(List<Pair> rest) {
StringBuilder buffer = new StringBuilder();
buffer.append("<ul>"); //$NON-NLS-1$
printTagAttributes(buffer);
printRest(buffer, rest);
buffer.append("</ul>"); //$NON-NLS-1$
if (rest.size() == 1) {
printTagAttributes(buffer);
printRest(buffer, rest);
} else {
buffer.append("<ul>"); //$NON-NLS-1$
printTagAttributes(buffer);
printRest(buffer, rest);
buffer.append("</ul>"); //$NON-NLS-1$
}
return buffer.toString();
}
}
Expand Down
26 changes: 26 additions & 0 deletions org.eclipse.jdt.ls.tests/src/org/eclipse/jdt/ls/core/internal/handlers/HoverHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1050,4 +1050,30 @@ public class Meh {}
actual = ResourceUtils.dos2Unix(actual);
assertEquals(expectedJavadoc, actual, "Unexpected hover ");
}

@Test
public void testIncorrectJavadocRendering_3649() throws Exception {
IPackageFragment pack1 = sourceFolder.createPackageFragment("test1", false, null);
String content = """
package test1;
/**
* Some javadoc and then ...
* @jls 9.6.4.1 @Target
*/
public class Hover {}
""";
ICompilationUnit cu = pack1.createCompilationUnit("Hover.java", content, false, null);
Hover hover = getHover(cu, 5, 14);
assertNotNull(hover);
assertEquals(2, hover.getContents().getLeft().size());

//@formatter:off
String expectedJavadoc = "Some javadoc and then ...\n"
+ "\n"
+ "* **@jls**\n"
+ " * 9.6.4.1 @Target";
String actual = hover.getContents().getLeft().get(1).getLeft();
actual = ResourceUtils.dos2Unix(actual);
assertEquals(expectedJavadoc, actual, "Unexpected hover ");
}
}