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

Kevin Rushforth kcr at openjdk.java.net
Wed Jul 28 21:56:37 UTC 2021


On Wed, 28 Jul 2021 09:34:33 GMT, Nir Lisker <nlisker at openjdk.org> wrote:

> I have spotted some missing docs:
> 
> * `CompoundSelector` missing docs for methods overriden from `Object`.

I'm not too worried about the missing docs for overridden methods. Unless we are overriding it in a way that needs to be documented, we don't want or need to add any explicit documentation. We could add `/** {@inheritDoc} */` for those (and it seems a good idea), but it turns out that when overriding JDK methods such as `toString()`, the generated docs are the same with or without `{@inheritDoc}`. We could consider a follow-on issue (not limited to `javafx.css`) to address this, which might involve changes to options that we pass to the `javadoc` tool.

> * `CssMetaData` is missing docs for methods `hashCode()`, `getConverter()` and `getProperty()`.

I think `getProperty()` and `getConverter()` should be fixed in this PR.

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

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


More information about the openjfx-dev mailing list