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

[Jonathan Gibbons]

On Fri, 12 Jan 2024 16:49: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 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/source/util/DocTrees.java line 157:
> 
>> 155:      * @param fileObject the content container
>> 156:      * @return the doc comment tree
>> 157:      * @throws IllegalArgumentException if the file type is not supported
> 
> It seems like this exception could've been thrown before, it's just that you have documented it for the first time. This might be important for CSR.

It's effectively a new exception, since before this work, we simply assumed that any file being read was in HTML format. Now, we check the file type, as described in the modified doc comment.   The entire doc comment is subject to CSR.

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

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