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

[Hannes Wallnöfer]

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

src/jdk.internal.md/share/classes/jdk/internal/markdown/MarkdownTransformer.java line 276:

> 274:         // The following {@code transform} methods invoke {@code transform} on
> 275:         // any children that may contain Markdown. If the transformations on
> 276:         // the children are all identify transformations (that is the result

Typo: identify -> identity

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java line 1465:

> 1463:         private final HtmlRenderer renderer = HtmlRenderer.builder()
> 1464:                 .nodeRendererFactory(headingRendererFactory)
> 1465:                 .extensions(List.of(tablesExtn/*, headingIdsExtn*/))

Is there a reason to keep the commented argument?

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

PR Review Comment: https://git.openjdk.org/jdk/pull/16388#discussion_r1603439954
PR Review Comment: https://git.openjdk.org/jdk/pull/16388#discussion_r1603716675