Should we document Styleable properties?

Andy Goryachev andy.goryachev at oracle.com
Fri Jun 28 21:04:43 UTC 2024


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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/openjfx-dev/attachments/20240628/9794ba9a/attachment-0001.htm>


More information about the openjfx-dev mailing list