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

[Jonathan Gibbons]

On Tue, 23 Jan 2024 12:50:45 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 1396:
> 
>> 1394:          * @see <a href="https://spec.commonmark.org/0.30/#code-fence">Code Fence</a>
>> 1395:          */
>> 1396:         CODE_FENCE(Pattern.compile("(`{3,}[^`]*+)|(~{3,}.*+)")),
> 
> Why are this and the previous patterns possessive (`+`), while others aren't?

Trying to avoid the runaway performance problem, such as described here:
https://www.regular-expressions.info/catastrophic.html

> src/jdk.compiler/share/classes/com/sun/tools/javac/parser/JavaTokenizer.java line 1065:
> 
>> 1063: 
>> 1064:                     if (accept('/')) { // (Spec. 3.7)
>> 1065:                         if (accept('/')) { // Markdown comment
> 
> Here and elsewhere in this file: do we need to mention Markdown?

The "M" word appears 10 times in this file. I'll work to convert them to an alternate nomenclature, such as "line comment".

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

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