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

[Ambarish Rapte]

On Sun, 16 Jan 2022 22:54:22 GMT, Nir Lisker <nlisker 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/DirectionalLight.java line 46:

> 44:  * {@code DirectionalLight}s can represent strong light sources that are far enough from the objects they illuminate
> 45:  * that their light rays appear to be parallel. Because these light sources are considered to be infinitely far, they
> 46:  * cannot be attenuated. The sun's light on Earth is a common light source that can be simulated with this light type.

The previous statement seems more suitable here:
`The Sun is a common light source that can be simulated with this light type.`
or little modified version of this new statement:
`The Sun light on Earth is a common type of light that can be simulated with this light type.`

modules/javafx.graphics/src/main/java/javafx/scene/LightBase.java line 133:

> 131:  *
> 132:  * <h2><a id="Direction">Direction</a></h2>
> 133:  * The direction the light is facing, defined by the {@code direction} vector property of the light. The light's

The direction of the light is defined by the {@code direction} vector property of the light

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

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