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

[Jonathan Gibbons]

On Wed, 8 Nov 2023 10:31:14 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> Jonathan Gibbons has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Fix whitespace
>
> test/langtools/tools/javac/doctree/MDPrinter.java line 67:
> 
>> 65:  * Conceptually based on javac's {@code DPrinter}.
>> 66:  */
>> 67: public class MDPrinter {
> 
> While DPrinter is used, MDPrinter isn't. (At least, I could't find any usages of it.) If you feel like MDPrinter is important, we should at least add a compile test for it, to protect it from bitrot.

👍

> test/langtools/tools/javac/lexer/CommentTest.java line 24:
> 
>> 22:  */
>> 23: 
>> 24: /**
> 
> Suggestion:
> 
> /*
> 
> Otherwise, some IDEs confuse this jtreg comment for a javadoc comment.

👍

> test/langtools/tools/javac/lexer/CommentTest.java line 37:
> 
>> 35: import java.util.Objects;
>> 36: 
>> 37: import com.sun.tools.javac.parser.JavadocTokenizer;
> 
> Unused import:
> Suggestion:

👍

> test/langtools/tools/javac/lexer/CommentTest.java line 73:
> 
>> 71: 
>> 72:     /**
>> 73:      * Whitespace before the commennt is completely ignored.
> 
> Typo:
> Suggestion:
> 
>      * Whitespace before the comment is completely ignored.

👍

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

PR Review Comment: https://git.openjdk.org/jdk/pull/16388#discussion_r1393430926
PR Review Comment: https://git.openjdk.org/jdk/pull/16388#discussion_r1393432411
PR Review Comment: https://git.openjdk.org/jdk/pull/16388#discussion_r1393432778
PR Review Comment: https://git.openjdk.org/jdk/pull/16388#discussion_r1393433550