New candidate JEP: 467: Markdown Documentation Comments

[Doležal, Petr]

Hello,

I'd like to point out that making simple links could use the same 
approach as Rust where a simple link uses backticks, like 
[`fmt::Display`], which produces a link with fixed-width font. One would 
expect backticks to set fixed-width font, right? So this looks 
consistent to me. Moreover, the backticks pairing takes precedence, so 
the text within the backticks needs no escaping of square brackets, 
which the JEP discusses as necessary in some cases.

Hence I think that the backticks-in-a-simple-link convention should be 
endorsed by the JEP as /the/ way to make simple links.

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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/jdk-dev/attachments/20240229/b2eb55d6/attachment.htm>