
<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">

</head>

<body>

<div dir="ltr" style="font-family: "Iosevka Fixed SS16", Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">

I think it's a good idea, the new markdown style is more readable and compact.</div>

<div dir="ltr" style="font-family: "Iosevka Fixed SS16", Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">

<br>

</div>

<div dir="ltr" style="font-family: "Iosevka Fixed SS16", Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">

The only downside I found so far is that the latest Eclipse does not refresh the javadoc tab when editing (someone said it's already fixed in the mainline).</div>

<div dir="ltr" style="font-family: "Iosevka Fixed SS16", Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">

<br>

</div>

<div dir="ltr" style="font-family: "Iosevka Fixed SS16", Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">

-andy</div>

<div dir="ltr" style="font-family: "Iosevka Fixed SS16", Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">

<br>

</div>

<div id="mail-editor-reference-message-container">

<div class="ms-outlook-mobile-reference-message skipProofing">

<meta name="Generator" content="Microsoft Exchange Server">

</div>

<div class="ms-outlook-mobile-reference-message skipProofing" style="text-align: left; padding: 3pt 0in 0in; border-width: 1pt medium medium; border-style: solid none none; border-color: rgb(181, 196, 223) currentcolor currentcolor; font-family: Aptos; font-size: 12pt; color: black;">

<b>From: </b>openjfx-dev <openjfx-dev-retn@openjdk.org> on behalf of Kevin Rushforth <kevin.rushforth@oracle.com><br>

<b>Date: </b>Thursday, October 2, 2025 at 09:59<br>

<b>To: </b>openjfx-dev <openjfx-dev@openjdk.org><br>

<b>Subject: </b>Using markdown-style javadoc comments (JEP 467)<br>

<br>

</div>

<div class="PlainText" style="font-size: 11pt;">Now that JavaFX requires JDK 24 to build, we can use features from JDK<br>

23 and 24 like markdown javadoc comments from JEP 467 [0], which was<br>

delivered in JDK 23.<br>

<br>

Two outstanding pull requests, PR 1873 [1] and PR 1880 [2], have<br>

proposed changes that do just that.<br>

<br>

As was pointed out in a review comment on PR 1873 [3], we should make a<br>

deliberate decision to start using them and have some guidelines around<br>

doing so.<br>

<br>

To that end, I would propose that developers can start using markdown<br>

javadoc comments in new APIs and in APIs that are modified such that<br>

markdown comments would be helpful.<br>

<br>

This is not an invitation to do wholesale changing of existing javadoc<br>

comments to markdown-style comments for docs that otherwise aren't being<br>

modified.<br>

<br>

Comments are welcome.<br>

<br>

-- Kevin<br>

<br>

[0] <a href="https://openjdk.org/jeps/467" data-outlook-id="c0b42066-f6a2-4649-84ff-29c9044e746b">

https://openjdk.org/jeps/467</a><br>

[1] <a href="https://github.com/openjdk/jfx/pull/1873" data-outlook-id="94529ef9-7d3a-4cf3-85b0-4c186c295da4">

https://github.com/openjdk/jfx/pull/1873</a><br>

[2] <a href="https://github.com/openjdk/jfx/pull/1880" data-outlook-id="f4745d8a-9d84-4a3b-9f27-ec3748608c19">

https://github.com/openjdk/jfx/pull/1880</a><br>

[3] <a href="https://github.com/openjdk/jfx/pull/1873#discussion_r2283161713" data-outlook-id="55c6b01d-bcab-4c6a-a8f1-ac7d98a78be7">

https://github.com/openjdk/jfx/pull/1873#discussion_r2283161713</a><br>

<br>

</div>

</div>

</body>

</html>