RFR: 8298405: Implement JEP 467: Markdown Documentation Comments [v69]

Chen Liang liach at openjdk.org
Thu May 16 13:08:20 UTC 2024


On Wed, 15 May 2024 21:04:36 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:
> 
>   update tests for dangling doc comments, per review feedback

A meta question about the JEP: Why don't Javadoc features (like snippets and markdown comments) don't go through preview, while Compiler features mostly do? Is there any bar for previews?

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

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


More information about the build-dev mailing list