JDK-8271085 : TabPane: Redundant API docs
  • Type: Bug
  • Component: javafx
  • Sub-Component: controls
  • Affected Version: openjfx17
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2021-07-21
  • Updated: 2022-02-11
  • Resolved: 2022-02-11
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
Other
openjfx18Fixed
Related Reports
Blocks :  
Description
See JDK-8271083 for a general description.

The TabPane class has redundant documentation on several elements. Specifically, there are two properties that have javadoc comments on both the field and the Property method, and there are several properties (including those two) that have javadoc comments on the setter or getter.

The two things that need to be done for this bug are:

* Docs should be only on the field or the Property method (not both)
    tabMaxWidth, tabMaxWidthProperty() : remove docs on Property method
    tabMaxHeight, tabMaxHeightProperty() : remove docs on Property method

* Remove unnecessary docs on setters and getters

For each property, the most complete information should be taken. For example, tabClosingPolicy should take most of its documentation from the setter (which should be moved to either the field or the Property method).

Comments
Changeset: 8b879eef Author: Ajit Ghaisas <aghaisas@openjdk.org> Date: 2022-02-11 05:16:22 +0000 URL: https://git.openjdk.java.net/jfx/commit/8b879eef96c9635a9ed16599344fa90568be2845
11-02-2022

A pull request was submitted for review. URL: https://git.openjdk.java.net/jfx/pull/728 Date: 2022-02-07 10:53:00 +0000
07-02-2022