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

[Jonathan Gibbons]

On Tue, 23 Jan 2024 12:01:38 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 225:
> 
>> 223:         while (ch == ' ' && bp < buflen) {
>> 224:             nextChar();
>> 225:         }
> 
> Why do we specifically care about `\s` symbols here rather than about broader whitespace?

Good catch and a tricky question. It's a conflict between typically skipping whitespace after a tag name (in traditional comments) and leading whitespace being significant in Markdown text.

Resolved in a compromise by using `isHorizontalWhiteSpace(c)` and adding an explanatory comment.

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

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