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

Andrey Turbanov aturbanov at openjdk.org
Wed Nov 22 09:40:10 UTC 2023


On Wed, 15 Nov 2023 18:58: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:
> 
>   Address review comments

src/jdk.compiler/share/classes/com/sun/tools/javac/parser/DocCommentParser.java line 178:

> 176:         List<DCTree> postamble = isHtmlFile ? content(Phase.POSTAMBLE) : List.nil();
> 177: 
> 178:         int pos = textKind == DocTree.Kind.MARKDOWN  ? 0

Suggestion:

        int pos = textKind == DocTree.Kind.MARKDOWN ? 0

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

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


More information about the build-dev mailing list