On Tue, 24 Jan 2023 21:43:04 GMT, Jonathan Gibbons <j...@openjdk.org> wrote:
>> 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 with a new target base due to a > merge or a rebase. The pull request now contains eight commits: > > - Merge with upstream/master > - Update copyright years > - Rename FFFC variable > Share Markdown parser and renderer in instance of MarkdownHandler > - Move CommonMark to new internal module. > Add legal header to imported CommonMark source files > Always use Text nodes inside AttributeTree values > Unwrap <p> from "simple" paragraphs > - Always use Text nodes inside AttributeTree values > - Update to CommonMark 0.21. > - fix whitespace > - JDK-8298405: Markdown support in the standard doclet There should probably be an option to make **Markdown** the default. ------------- PR: https://git.openjdk.org/jdk/pull/11701
