[jfx17] RFR: 8250590: Classes and methods in the javafx.css package are missing documentation [v5]

[Kevin Rushforth]

On Thu, 29 Jul 2021 14:38:02 GMT, Ajit Ghaisas <aghaisas at openjdk.org> wrote:

>> This PR corrects/adds missing documentation for classes in javafx.css package.
>
> Ajit Ghaisas has updated the pull request incrementally with one additional commit since the last revision:
> 
>   8250590 - fix review comments

Two remaining comments. I looked through all the generated docs and everything else looks good.

modules/javafx.graphics/src/main/java/javafx/css/PseudoClass.java line 90:

> 88:      * @param pseudoClass the name of the pseudo class
> 89:      * @return the {@code PseudoClass} instance for a given pseudo class name
> 90:      * It will not return null.

Since this is two sentences, you either need to restore the period after `name` or else add a semicolon there, and also remove the period after `null`. Either way, as long as you are add it, you might want to use code style for `null`.

modules/javafx.graphics/src/main/java/javafx/css/Selector.java line 102:

> 100:     /**
> 101:      * Gets whether this {@code Selector} applies to the given {@code Styleable}.
> 102:      * It is the same as the {@link createMatch} method except it returns a boolean rather than a {@code Match}.

I see you changed this from `matches` to `createMatches`, since there is no `matches` method. However, I now wonder if this comment is correct in the first place. The `createMatch` method doesn't take a `Styleable` so it seems unlikely that it would be semantically equivalent to calling `createMatches`. Unless you can figure out what was meant by the original comment, it might best to just remove it.

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

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