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

[Pavel Rappo]

On Tue, 23 Jan 2024 12:22:19 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> Jonathan Gibbons has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains eight commits:
>> 
>>  - Merge with upstream/master
>>  - Merge with upstream/master
>>  - Merge remote-tracking branch 'upstream/master' into 8298405.doclet-markdown-v3
>>  - Address review comments
>>  - Fix whitespace
>>  - Improve handling of embedded inline taglets
>>  - Customize support for Markdown headings
>>  - JDK-8298405: Support Markdown in Documentation Comments
>
> src/jdk.compiler/share/classes/com/sun/tools/javac/parser/DocCommentParser.java line 1388:
> 
>> 1386:          * @see <a href="https://spec.commonmark.org/0.30/#thematic-breaks">Thematic Break</a>
>> 1387:          */
>> 1388:         THEMATIC_BREAK(Pattern.compile("((\\+[ \t]*+){3,})|((-[ \t]*+){3,})|((_[ \t]*+){3,})")),
> 
> Suggestion:
> 
>         /**
>          * Thematic break: a line of * - _ interspersed with optional spaces and tabs
>          * @see <a href="https://spec.commonmark.org/0.30/#thematic-breaks">Thematic Break</a>
>          */
>         THEMATIC_BREAK(Pattern.compile("((\*[ \t]*+){3,})|((-[ \t]*+){3,})|((_[ \t]*+){3,})")),

To add to my earlier [comment], DocCommentParser recognises THEMATIC_BREAK consisting of `-` as SETEXT_UNDERLINE. While it's inaccurate, it doesn't seem important, as DCP's goal is to recognise and avoid Markdown, not process it.

[comment]: https://github.com/openjdk/jdk/pull/16388/files#r1462148038

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

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