RFR: 8325073: javadoc warnings: missing @param tags and other issues [v2]

[Kevin Rushforth]

On Fri, 1 Mar 2024 00:22:05 GMT, Andy Goryachev <angorya at openjdk.org> wrote:

>> This change brings the number of javadoc warnings back to 91 (to be fixed in [JDK-8270996](https://bugs.openjdk.org/browse/JDK-8270996))
>> 
>> - adds missing information in `@param` tags
>>  - adds `@SuppressWarnings("doclint:missing")` to `Skinnable` to silence the warning due to [JDK-8325071](https://bugs.openjdk.org/browse/JDK-8325071)
>>  - fixed an empty `<p>` in `Subscription`
>>  - cleaned up unnecessary `@throws` in Filtered/SortedList
>> 
>> This PR does not need a CSR: most of the changes are clarifications or documenting of missing parameters.
>
> Andy Goryachev has updated the pull request incrementally with one additional commit since the last revision:
> 
>   review comments

Looks good with two minor comments. I'll reapprove if you make the changes.

modules/javafx.controls/src/main/java/javafx/scene/control/ResizeFeaturesBase.java line 34:

> 32:  * A wrapper class for use by the column resize policies offered by
> 33:  * controls such as {@link TableView} and {@link TreeTableView}.
> 34:  * @param <S> the type of the objects contained within the TableView items list

Minor: This class isn't limited to TableView, so I recommend changing it to something like "the control's items list"

modules/javafx.controls/src/main/java/javafx/scene/control/skin/ComboBoxListViewSkin.java line 66:

> 64:  * Default skin implementation for the {@link ComboBox} control.
> 65:  *
> 66:  * @param <T> the type of the ComboBox-like control

Minor: should this be just "ComboBox" rather than "ComboBox-like"?

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

Marked as reviewed by kcr (Lead).

PR Review: https://git.openjdk.org/jfx/pull/1384#pullrequestreview-1911409755
PR Review Comment: https://git.openjdk.org/jfx/pull/1384#discussion_r1509151841
PR Review Comment: https://git.openjdk.org/jfx/pull/1384#discussion_r1509163073