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

Hannes Wallnöfer hannesw at openjdk.org
Wed Feb 28 15:28:04 UTC 2024


On Fri, 23 Feb 2024 22:27:43 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:
> 
>   Refactor most of TestMarkdown.java into separate tests, grouped by functionality

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

> 1731:             return false;
> 1732:         }
> 1733: 

The two methods below and some other methods in this class have too much indentation.

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

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


More information about the build-dev mailing list