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

[Nir Lisker]

On Wed, 9 Feb 2022 07:32:20 GMT, Ajit Ghaisas <aghaisas at openjdk.org> wrote:

>> modules/javafx.controls/src/main/java/javafx/scene/control/TabPane.java line 295:
>> 
>>> 293:      *
>>> 294:      * This value can also be set via CSS using {@code -fx-tab-min-width}.
>>> 295:      * </p>
>> 
>> I would write
>> 
>> The minimum width of a tab in the TabPane. This can be used to limit
>> the length of text in tabs to prevent truncation.  Setting the same minimum
>> and maximum widths will fix the width of the tab.
>> 
>> It makes it clear that it applies to each tab individually (and not the total width of the tabs). The same applies for the other min/max height/width properties.
>> 
>> The sentence "By default the min equals to the max." seems wrong. The `DEFAULT_TAB_MIN_WIDTH` constant is set to 0. It should also be in a `@defaultValue`.
>> 
>> The CSS mention is good, but I never saw it mentioned for properties before. Makes me wonder if we should add the CSS property as part of a property's description in general via the automated javadoc tool.
>
> Good suggestion. Fixed.
> 
> Regarding CSS mention for properties, I am not sure whether that can be automated. If there is a way to achieve it, I can file a separate bug to address it.

The CSS remark was me thinking out loud. I'll write about it in the mailing list since it's a whole new capability of the doc tool.

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

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