RFR: JDK-8298405: Support Markdown in Documentation Comments

Pavel Rappo prappo at openjdk.org
Wed Nov 8 17:41:14 UTC 2023


On Wed, 8 Nov 2023 17:25:36 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> Please review a patch to add support for Markdown syntax in documentation comments, as described in the associated JEP.
>> 
>> Notable features:
>> 
>> * support for `///` documentation comments in `JavaTokenizer`
>> * new module `jdk.internal.md` -- a private copy of the `commonmark-java` library
>> * updates to `DocCommentParser` to treat `///` comments as Markdown
>> * updates to the standard doclet to render Markdown comments in HTML
>
> test/langtools/jdk/javadoc/tool/testTransformer/TestTransformer.java line 64:
> 
>> 62: 
>> 63:     @Test
>> 64:     public void testFindStandardTransformer_raw() throws Exception {
> 
> Checked exceptions are not thrown:
> Suggestion:
> 
>     public void testFindStandardTransformer_raw() {

I might be mistaken, but this and the testFindStandardTransformer_stream methods look like we are testing ServiceLoader API. I would leave just the stream version.

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

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


More information about the build-dev mailing list