New candidate JEP: 467: Markdown Documentation Comments

[Doležal, Petr]

Hello,

regarding links, Rust combines conventionally backticks with square 
brackes to make simple links, for instance [`fmt::Display`]. This 
effectively avoids the need of escaping square brackets naturally as 
backticks do not appear in the identifiers and are nested more than 
square brackets.

For this reason, I'd propose this as the conventional way to write such 
links, which as a side-effect prevents the need of escaping square 
brackets. It produces also nicer and more consistent formatting, IMO, 
because the link text becomes unproportional naturally thanks to the 
backticks.

P.

On 27.02.2024 21:31, Mark Reinhold wrote:
> https://openjdk.org/jeps/467
>
>    Summary: Enable JavaDoc documentation comments to be written in
>    Markdown rather than solely in a mixture of HTML and JavaDoc @-tags.
>
> - Mark