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

Jonathan Gibbons jjg at openjdk.org
Fri Feb 9 18:31:14 UTC 2024


On Mon, 15 Jan 2024 12:26:34 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 201:
> 
>> 199:                 }
>> 200:                 newline = true;
>> 201:             }
> 
> I can see clean LF and CRLF, but no FF; was the latter intentional?
> 
> In any case, we should double-check the generated test output to see if there's anything unexpected.

We've been here, with `\f` before, noting the different handling of `\f` in `javac` and `javadoc`.

My recollection is that it was intentional to drop support for `\f`, thus aligning `javac` and `javadoc` behavior, and to normalize handling of the newline sequences, translating them to `\n`.

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

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


More information about the build-dev mailing list