[jfx18] RFR: 8279345: Realign class docs of LightBase and subclasses [v2]

Kevin Rushforth kcr at openjdk.java.net
Thu Jan 27 19:11:41 UTC 2022


On Thu, 27 Jan 2022 17:14:51 GMT, Nir Lisker <nlisker at openjdk.org> wrote:

>> modules/javafx.graphics/src/main/java/javafx/scene/LightBase.java line 119:
>> 
>>> 117:  *   <li> The transparency (alpha) component of a light is ignored.
>>> 118:  * </ol>
>>> 119:  * There are no guarantee that these behaviors will not change.
>> 
>> This is a new specification of behavior rather than a doc reorganization or clarification of an existing note. As such, I think it should be done separately and with a CSR.
>
> Even if this just clarifies the current behavior and doesn't make a guarantee?

We will sometimes clarify existing behavior in JavaFX without a CSR. If that's what you intend with this, then I might suggest moving it to an `@implNote`. Also, I prefer something more like the following for the last sentence:


 * These behaviors are not specified and could change in the future.

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

PR: https://git.openjdk.java.net/jfx/pull/717


More information about the openjfx-dev mailing list