> Support for Markdown comments in the standard doclet.
> 
> To enable Markdown in a comment, start the comment with `/**md` followed by 
> whitespace.  The syntax is as defined for CommonMark.
> 
> The work is in 3 parts:
> 
> 1. Update the Compiler Tree API to support Markdown tree nodes, containing 
> strings of (uninterpreted) Markdown source code.
> 2. Import commonmark-java into the `jdk.javadoc` module, to be able to 
> convert Markdown strings to HTML.
> 3. Update the standard doclet, to leverage the preceding two parts, to 
> translate Markdown in documentation comments to `Content` nodes.
> 
> There are new tests both for the low level work in the Compiler Tree API, and 
> for the overall high-level work in the doclet.
> 
> Background info: 
> https://mail.openjdk.org/pipermail/javadoc-dev/2023-January/005563.html

Jonathan Gibbons has updated the pull request incrementally with one additional 
commit since the last revision:

  Rename MarkdownTree to RawTextTree

-------------

Changes:
  - all: https://git.openjdk.org/jdk/pull/11701/files
  - new: https://git.openjdk.org/jdk/pull/11701/files/3f45c988..432ae0b9

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=11701&range=03
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=11701&range=02-03

  Stats: 408 lines in 17 files changed: 172 ins; 144 del; 92 mod
  Patch: https://git.openjdk.org/jdk/pull/11701.diff
  Fetch: git fetch https://git.openjdk.org/jdk pull/11701/head:pull/11701

PR: https://git.openjdk.org/jdk/pull/11701

Reply via email to