Skip to content

{@code} / {@literal} inline tag is not rendered correctly in Markdown hover #3681

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 2 commits into
base: main
Choose a base branch
from
Open

{@code} / {@literal} inline tag is not rendered correctly in Markdown hover #3681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dac1622
{@code} inline tag is not rendered correctly in Markdown hover
subyssurendran666 Jan 18, 2026
2440bbb
incorporated code-review comments
subyssurendran666 Jan 20, 2026
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
39 changes: 38 additions & 1 deletion ...lipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/javadoc/JavadocContentAccess2.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,10 @@ private static void collectTagElements(String content, IJavaElement element, Tag
while (!queue.isEmpty()) {
ASTNode e = queue.pop();
if (e instanceof TagElement t) {
if ("@link".equals(t.getTagName()) || "@linkplain".equals(t.getTagName())) {
if (TagElement.TAG_LINK.equals(t.getTagName()) || TagElement.TAG_LINKPLAIN.equals(t.getTagName())) {
collectLinkedTag(element, t, buf);
} else if (TagElement.TAG_CODE.equals(t.getTagName()) || TagElement.TAG_LITERAL.equals(t.getTagName())) {
collectCodeAndLiteralTag(element, t, buf);
} else {
collectTagElements(content, element, t, buf);
}
Expand Down Expand Up @@ -195,6 +197,41 @@ private static void collectTagElements(String content, IJavaElement element, Tag
}
}

private static void collectCodeAndLiteralTag(IJavaElement element, TagElement t, StringBuilder buf) {
if (t.fragments().size() > 0) {
try {
if (t.fragments().size() > 0) {
if (TagElement.TAG_CODE.equals(t.getTagName())) {
if (t.fragments().size() == 1) {
buf.append("`" + ((TextElement) t.fragments().get(0)).getText().strip() + "`");
} else {
String code;
for (int i = 0; i < t.fragments().size(); i++) {
code = ((TextElement) t.fragments().get(i)).getText().strip();
if (i == 0) {
buf.append("`" + code);
} else if (i == (t.fragments().size() - 1)) {
buf.append(code + "`");
} else {
buf.append(code);
}
}
}
} else if (TagElement.TAG_LITERAL.equals(t.getTagName())) {
String code;
for (int i = 0; i < t.fragments().size(); i++) {
code = ((TextElement) t.fragments().get(i)).getText().strip();
code = code.replaceAll("([<>*^&\\\\`\\[\\]])", "\\\\$1");
buf.append(code);
}
}
}
} catch (Exception e) {
JavaManipulationPlugin.log(e);
}
}
}

private static void collectLinkedTag(IJavaElement element, TagElement t, StringBuilder buf) {
@SuppressWarnings("unchecked")
List<IDocElement> children = t.fragments();
Expand Down
114 changes: 114 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,118 @@ public class Meh {}
actual = ResourceUtils.dos2Unix(actual);
assertEquals(expectedJavadoc, actual, "Unexpected hover ");
}

@Test
public void testHoverMarkdownWithCodeTag_01() throws Exception {
String name = "java25";
importProjects("eclipse/" + name);
IProject project = getProject(name);
IJavaProject javaProject = JavaCore.create(project);
IPackageFragmentRoot packageFragmentRoot = javaProject.getPackageFragmentRoot(project.getFolder("src/main/java"));
IPackageFragment pack1 = packageFragmentRoot.createPackageFragment("test", false, null);
StringBuilder buf = new StringBuilder();
//@formatter:off
buf.append("package test;\n"
+ "/// {@code List<String>}\n"
+ "public class Markdown{}\n");
//@formatter:on
ICompilationUnit cu = pack1.createCompilationUnit("Test.java", buf.toString(), false, null);
Hover hover = getHover(cu, 2, 14);
assertNotNull(hover);
assertEquals(2, hover.getContents().getLeft().size());
StringBuilder expectedJavadoc = new StringBuilder();
//@formatter:off
expectedJavadoc.append("`List<String>` ");
//@formatter:on
String actual = hover.getContents().getLeft().get(1).getLeft();
actual = ResourceUtils.dos2Unix(actual);
assertEquals(expectedJavadoc.toString(), actual, "Unexpected hover ");
}

@Test
public void testHoverMarkdownWithCodeTag_02() throws Exception {
String name = "java25";
importProjects("eclipse/" + name);
IProject project = getProject(name);
IJavaProject javaProject = JavaCore.create(project);
IPackageFragmentRoot packageFragmentRoot = javaProject.getPackageFragmentRoot(project.getFolder("src/main/java"));
IPackageFragment pack1 = packageFragmentRoot.createPackageFragment("test", false, null);
StringBuilder buf = new StringBuilder();
//@formatter:off
buf.append("package test;\n"
+ "/// {@literal List<String> <>*^&`[]}\n"
+ "public class Markdown{}\n");
//@formatter:on
ICompilationUnit cu = pack1.createCompilationUnit("Test.java", buf.toString(), false, null);
Hover hover = getHover(cu, 2, 14);
assertNotNull(hover);
assertEquals(2, hover.getContents().getLeft().size());
StringBuilder expectedJavadoc = new StringBuilder();
//@formatter:off
expectedJavadoc.append("List\\<String\\> \\<\\>\\*\\^\\&\\`\\[\\] ");
//@formatter:on
String actual = hover.getContents().getLeft().get(1).getLeft();
actual = ResourceUtils.dos2Unix(actual);
assertEquals(expectedJavadoc.toString(), actual, "Unexpected hover ");
}

@Test
public void testHoverMarkdownWithCodeTag_03() throws Exception {
String name = "java25";
importProjects("eclipse/" + name);
IProject project = getProject(name);
IJavaProject javaProject = JavaCore.create(project);
IPackageFragmentRoot packageFragmentRoot = javaProject.getPackageFragmentRoot(project.getFolder("src/main/java"));
IPackageFragment pack1 = packageFragmentRoot.createPackageFragment("test", false, null);
StringBuilder buf = new StringBuilder();
//@formatter:off
buf.append("package test;\n"
+ "/// Here's some code {@code \n"
+ "/// List<String> list = List.of(\"Hello World!\");\n"
+ "/// } \n"
+ "/// that does something.\n"
+ "public class Markdown{}\n");
//@formatter:on
ICompilationUnit cu = pack1.createCompilationUnit("Test.java", buf.toString(), false, null);
Hover hover = getHover(cu, 5, 14);
assertNotNull(hover);
assertEquals(2, hover.getContents().getLeft().size());
//@formatter:off
StringBuilder expectedJavadoc = new StringBuilder();
expectedJavadoc.append("Here's some code `List<String> list = List.of(\"Hello World!\");` that does something.");
//@formatter:on
String actual = hover.getContents().getLeft().get(1).getLeft();
actual = ResourceUtils.dos2Unix(actual);
assertEquals(expectedJavadoc.toString(), actual, "Unexpected hover ");
}

@Test
public void testHoverMarkdownWithCodeTag_04() throws Exception {
String name = "java25";
importProjects("eclipse/" + name);
IProject project = getProject(name);
IJavaProject javaProject = JavaCore.create(project);
IPackageFragmentRoot packageFragmentRoot = javaProject.getPackageFragmentRoot(project.getFolder("src/main/java"));
IPackageFragment pack1 = packageFragmentRoot.createPackageFragment("test", false, null);
StringBuilder buf = new StringBuilder();
//@formatter:off
buf.append("package test;\n"
+ "/// Here's some code {@literal \n"
+ "/// List<String> list = List.of(\"Hello World!\");\n"
+ "/// } \n"
+ "/// that does something.\n"
+ "public class Markdown{}\n");
//@formatter:on
ICompilationUnit cu = pack1.createCompilationUnit("Test.java", buf.toString(), false, null);
Hover hover = getHover(cu, 5, 14);
assertNotNull(hover);
assertEquals(2, hover.getContents().getLeft().size());
//@formatter:off
StringBuilder expectedJavadoc = new StringBuilder();
expectedJavadoc.append("Here's some code List\\<String\\> list = List.of(\"Hello World!\");} that does something.");
//@formatter:on
String actual = hover.getContents().getLeft().get(1).getLeft();
actual = ResourceUtils.dos2Unix(actual);
assertEquals(expectedJavadoc.toString(), actual, "Unexpected hover ");
}
}