RFR: JDK-8298405: Support Markdown in the standard doclet [v7]

Jonathan Gibbons jjg at openjdk.org
Tue Feb 21 17:10:00 UTC 2023


On Wed, 8 Feb 2023 23:32:27 GMT, Jonathan Gibbons <jjg at 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 incrementally with one additional commit since the last revision:
> 
>   Revert changes to Object.hashCode

FYI, the PR has been withdrawn for now, pending additional design discussions.

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

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


More information about the compiler-dev mailing list