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

[Jonathan Gibbons]

On Mon, 15 Jan 2024 17:35:00 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 incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains seven additional commits since the last revision:
>> 
>>  - 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 1377:
> 
>> 1375:          * @see <a href="https://spec.commonmark.org/0.30/#atx-headings">ATX Headings</a>
>> 1376:          */
>> 1377:         ATX_HEADER(Pattern.compile("#{1,6}( .*|$)")),
> 
> Nothing wrong here, I just didn't know that an ATX header "opening sequence of # characters" can be followed by the end of line". Interesting.

:-) I think this comes in the general category of the _principle of least surprise and no errors_.  The only other possibility would be to treat it as an ordinary line starting with `#` characters.

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

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