[jfx18] RFR: 8271085: TabPane: Redundant API docs

Kevin Rushforth kcr at openjdk.java.net
Mon Feb 7 16:36:11 UTC 2022


On Mon, 7 Feb 2022 10:53:00 GMT, Ajit Ghaisas <aghaisas at openjdk.org> wrote:

> This is a Javadoc cleanup and correction fix for the TabPane as described in the JBS.
> 
> Changes done for all the Properties of the TabPane -
> - Moved the property description to be over the property field.
> - Removed the unnecessary docs on property setter/getter and Property method.

I looked at the first two properties, and they look fine. I'll do a detailed review of the rest, but I wanted to point out one thing first. See below.

modules/javafx.controls/src/main/java/javafx/scene/control/TabPane.java line 188:

> 186:      * the TabPane will immediately update the location of the tabs to reflect
> 187:      * this.</p>
> 188:      * The default position for the tabs is {@code Side.Top}.

Ordinarily we would use a `@defaultValue` tag here. In this case, you are just moving existing docs from one method to another, so it could be done in a follow-up bug. Can you file a follow-up bug?

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

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


More information about the openjfx-dev mailing list