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

Jonathan Gibbons jjg at openjdk.org
Mon Jan 29 22:45:44 UTC 2024


On Wed, 17 Jan 2024 00:13:40 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Understood. FWIW, here are a few examples of headings in user-defined tags in JDK:
>> 
>> https://github.com/openjdk/jdk/blob/a6785e4d633908596ddb6de6d2eeab1c9ebdf2c3/src/java.base/share/classes/java/math/BigDecimal.java#L229-L239
>> 
>> https://github.com/openjdk/jdk/blob/ddbbd36e4b064b9e7433f0a55973d72cd6dbc0d3/src/java.xml/share/classes/module-info.java#L402-L420
>> 
>> https://github.com/openjdk/jdk/blob/6f6486e97743eadfb20b4175e1b4b2b05b59a17a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/Vector.java#L1089-L1093
>
> Thanks for the examples.
> 
> Stylistically, they are maybe questionable.  But we can make sure that something sensible happens, and deal with stylistic issues later.

Filed [JDK-8324876](https://bugs.openjdk.org/browse/JDK-8324876) to reconsider these tags.

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

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


More information about the build-dev mailing list