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

Jonathan Gibbons jjg at openjdk.org
Sat Jan 7 00:38:51 UTC 2023


On Wed, 4 Jan 2023 18:38:23 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> 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.

Line wrapped.

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

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


More information about the javadoc-dev mailing list