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

[Nir Lisker]

On Tue, 25 Jan 2022 01:17:51 GMT, Kevin Rushforth <kcr at openjdk.org> wrote:

>> Now that the standard concrete light types were added, there is an opportunity to rearrange and rewrite some of the class docs. Here is a summary of the changes:
>> 
>> * Moved the explanations of attenuation and direction up to `LightBase` since different light types share characteristics. `LightBase` now contains a summary of its subtypes and all the explanations of the properties/characteristics of the lights divided into sections: Color, Scope, Direction, Attenuation.
>> * Each light type links to the relevant section in `LightBase` when it mentioned the properties it has.
>> * Added examples of real-world applications for each light type.
>> * Consolidated the writing style for all the subclasses.
>
> 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?

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

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