RFR: JDK-8298405: Markdown support in the standard doclet

[Pavel Rappo]

On Tue, 3 Jan 2023 20:01:48 GMT, Pavel Rappo <prappo 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.
>
> src/jdk.compiler/share/classes/com/sun/source/doctree/InheritDocTree.java line 31:
> 
>> 29:  * A tree node for an {@code @inheritDoc} inline tag.
>> 30:  *
>> 31:  * @apiNote
> 
> 1. Consider wrapping that long line.
> 2. While it's good to have that fact noted here, it's more important to note it in "Documentation Comment Specification for the Standard Doclet".

Ah, I can see that you added such a note before in CSR (sorry for the noise):

+_Note:_ When using [Markdown comments](#markdown-content), there is no requirement
+that the comment containing the tag and the comment containing the inherited documentation
+should either be both Markdown comments or both normal (not Markdown) comments.

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

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