Should we document Styleable properties?

[Michael Strauß]

If we do this, I suggest to add a custom tag for this purpose instead
of repeating prose for every property.
The javadoc tool will then render the content of this tag in the
specification list section of the documentation (where tags such as
@defaultValue will also appear).


On Fri, Jun 28, 2024 at 11:21 PM Andy Goryachev
<andy.goryachev at oracle.com> wrote:
>
> Dear fellow developers:
>
>
>
> Should we document which properties are styleable with CSS in javadoc?  Would that be useful?
>
>
>
> Example:
>
>
>
>     /**
>
>      * Determines the caret blink period.  This property cannot be set to {@code null}.
>
>      * <p>
>
>      * This is a {@link StyleableProperty} with the name {@code -fx-caret-blink-period}.
>
>      * <p>
>
>
>
> alternative:
>
>
>
>      * This property can be styled with CSS using {@code -fx-caret-blink-period} name.
>
>      * @implNote The property object implements {@link StyleableProperty} interface.
>
>
>
>
>
> Other ideas are also welcome.
>
>
>
> -andy