[23] JEP 467: Render markdown doc comments

eclipse-jdt / eclipse.jdt.ui

Eclipse Public License 2.0

37 stars 90 forks source link

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

Closed stephan-herrmann closed 2 months ago

stephan-herrmann commented 2 months ago

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 https://github.com/eclipse-jdt/eclipse.jdt.ui/issues/1472

stephan-herrmann commented 2 months ago

For this to work it needs https://github.com/eclipse-jdt/eclipse.jdt.core/pull/2807 and possibly more.

stephan-herrmann commented 2 months ago

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 https://github.com/eclipse-jdt/eclipse.jdt.ui/issues/1579 - which is a bug also in traditional javadoc.