On Thu, 2 Oct 2025 17:33:05 GMT, Kevin Rushforth <[email protected]> wrote:

>>> Eclipse does not refresh its javadoc pane with markdown as it does with the 
>>> usual style
>> 
>> Was fixed months ago in 
>> https://github.com/eclipse-jdt/eclipse.jdt.ui/pull/2051. Not sure if a 
>> stable version was released yet.
>
> I started a (belated) [discussion on this on the mailing 
> list](https://mail.openjdk.org/pipermail/openjfx-dev/2025-October/056578.html).
>  As mentioned in that message, I think using markdown comments is fine for 
> new APIs and docs that are modified in a way that markdown would be helpful.

After reading Michael and John's comments, I informally polled a few folks on 
the core libs team. I amend my proposal to include a recommendation to avoid 
mixing styles in a class like Node where there are already a lot of existing 
properties and you are adding a new one.

For this PR, there doesn't seem to be a good reason to use markdown-style doc 
comments. I recommend using old-style `/**` block comments for consistency.

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

PR Review Comment: https://git.openjdk.org/jfx/pull/1873#discussion_r2421873451

Reply via email to