Skip to content
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.

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

[23] JEP 467: Render markdown doc comments #1587

Merged

Conversation

stephan-herrmann
Copy link
Contributor

  • dependency org.commonmark incl. extension for tables
  • new CoreMarkdownAccessImpl renders javadoc with markdown to HTML
    • individual rendering of content within block structures (tag descriptions)
    • global rendering of entire javadoc
  • skip insignificant whitespace assuming DOM contains all relevant whitespace

fixes #1472

+ dependency org.commonmark incl. extension for tables
+ new CoreMarkdownAccessImpl renders javadoc with markdown to HTML
+ skip insignificant whitespace
  assuming DOM contains all relevant whitespace

fixes eclipse-jdt#1472
@stephan-herrmann
Copy link
Contributor Author

For this to work it needs eclipse-jdt/eclipse.jdt.core#2807 and possibly more.

@stephan-herrmann
Copy link
Contributor Author

Test expectations are a bit complex where hyperlinks are involved. I confirmed manually in a runtime IDE that all links in test examples actually work as expected, except for #1579 - which is a bug also in traditional javadoc.

+ test for code block at start and end of comment (bugs in javadoc tool)

fixes eclipse-jdt#1472
@stephan-herrmann stephan-herrmann merged commit b6d6514 into eclipse-jdt:BETA_JAVA23 Aug 14, 2024
6 checks passed
@stephan-herrmann stephan-herrmann deleted the issue1472_markdown_2 branch August 14, 2024 19:29
stephan-herrmann added a commit to stephan-herrmann/eclipse.jdt.ui that referenced this pull request Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant