RFR: JDK-8298405: Support Markdown in the standard doclet [v2]
Jonathan Gibbons
jjg at openjdk.org
Mon Jan 9 17:44:35 UTC 2023
> 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.
Jonathan Gibbons has updated the pull request incrementally with five additional commits since the last revision:
- 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.
-------------
Changes:
- all: https://git.openjdk.org/jdk/pull/11701/files
- new: https://git.openjdk.org/jdk/pull/11701/files/f9e24538..82e363ad
Webrevs:
- full: https://webrevs.openjdk.org/?repo=jdk&pr=11701&range=01
- incr: https://webrevs.openjdk.org/?repo=jdk&pr=11701&range=00-01
Stats: 19920 lines in 262 files changed: 12929 ins; 6918 del; 73 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
More information about the javadoc-dev
mailing list