[jfx18] RFR: 8279345: Realign class docs of LightBase and subclasses [v2]
Kevin Rushforth
kcr at openjdk.java.net
Thu Jan 27 19:29:21 UTC 2022
On Thu, 27 Jan 2022 17:28:15 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.
>
> Nir Lisker has updated the pull request incrementally with one additional commit since the last revision:
>
> Addressed review comments
I added an additional comment about the accessibility of the table.
modules/javafx.graphics/src/main/java/javafx/scene/LightBase.java line 77:
> 75: * </tr>
> 76: * <tr>
> 77: * <td>{@link AmbientLight}</td>
In addition to `scope="col"` for the first row, the first column in each other row needs a `scope="row:` (and should use a `<th>` element for that column). For example, see [javafx/scene/media/package.html#L92](https://github.com/openjdk/jfx/blob/3f62718b0ce00c1cab7f23cbd67c26887b4f50ad/modules/javafx.media/src/main/java/javafx/scene/media/package.html#L92).
-------------
PR: https://git.openjdk.java.net/jfx/pull/717
More information about the openjfx-dev
mailing list