RFR: JDK-8298405: Support Markdown in Documentation Comments [v27]

Jonathan Gibbons jjg at openjdk.org
Thu Feb 8 23:57:09 UTC 2024


On Thu, 8 Feb 2024 23:02:18 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Please review a patch to add support for Markdown syntax in documentation comments, as described in the associated JEP.
>> 
>> Notable features:
>> 
>> * support for `///` documentation comments in `JavaTokenizer`
>> * new module `jdk.internal.md` -- a private copy of the `commonmark-java` library
>> * updates to `DocCommentParser` to treat `///` comments as Markdown
>> * updates to the standard doclet to render Markdown comments in HTML
>
> Jonathan Gibbons has updated the pull request incrementally with one additional commit since the last revision:
> 
>   added test case in TestMarkdown.java for handling of `@deprecated` tag

Re: https://github.com/openjdk/jdk/pull/16388#discussion_r1483182361
See https://github.com/openjdk/jdk/pull/17782

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

PR Comment: https://git.openjdk.org/jdk/pull/16388#issuecomment-1935112305


More information about the build-dev mailing list