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

Nir Lisker nlisker at openjdk.java.net
Thu Jan 27 17:28:15 UTC 2022


> 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.

Nir Lisker has updated the pull request incrementally with one additional commit since the last revision:

  Addressed review comments

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

Changes:
  - all: https://git.openjdk.java.net/jfx/pull/717/files
  - new: https://git.openjdk.java.net/jfx/pull/717/files/dd2c99f5..3f62718b

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jfx&pr=717&range=01
 - incr: https://webrevs.openjdk.java.net/?repo=jfx&pr=717&range=00-01

  Stats: 10 lines in 3 files changed: 0 ins; 2 del; 8 mod
  Patch: https://git.openjdk.java.net/jfx/pull/717.diff
  Fetch: git fetch https://git.openjdk.java.net/jfx pull/717/head:pull/717

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


More information about the openjfx-dev mailing list