Should we document Styleable properties?

[Eric Bresie]

A little off topic but…

There is a pending JEP for allowing markup to be included in javadocs
https://openjdk.org/jeps/467

Eric Bresie
ebresie at gmail.com


On Mon, Jul 1, 2024 at 4:35 PM Michael Strauß <michaelstrau2 at gmail.com>
wrote:

> Further testing shows that while the javadoc tool does support custom
> tags, it doesn’t lift custom tags defined on JavaFX property fields to the
> property method documentation.
>
> Lifting documentation from the property field to property methods is a
> JavaFX-specific feature of Javadoc. At first glance, there seems to be no
> particular reason why custom tags are ignored in this situation; probably
> it just wasn’t implemented.
>
> So if we add this custom tag, it won’t show up on the generated HTML. We
> could start using a custom tag, and then file an enhancement request for
> Javadoc to lift custom tags to methods just as it does with other tags.
> What’s your opinion on that?
>
>
> Andy Goryachev <andy.goryachev at oracle.com> schrieb am Mo. 1. Juli 2024 um
> 23:20:
>
>> Would even work with Eclipse out of the box:
>>
>>
>>
>>
>>
>> I also like the fact that we won't need to maintain links manually as
>> there would not be any.
>>
>>
>>
>> -andy
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/openjfx-dev/attachments/20240702/7b86135f/attachment.htm>