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

[Jonathan Gibbons]

On Wed, 24 Jan 2024 22:35:31 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.internal.md/share/classes/jdk/internal/markdown/MarkdownTransformer.java line 543:
> 
>> 541:                 @Override
>> 542:                 public LinkReferenceDefinition getLinkReferenceDefinition(String label) {
>> 543:                     var l = label.replace("\\[\\]", "[]");
> 
> That `String.replace` looks suspicious. FWIW, when I removed that `replace`, no tests failed.

My recollection is that you have to escape square brackets in a reference label.  I will investigate, and if necessary, add a test case.

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

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