JDK-8163385 : Fix doclint errors and warnings in javafx.controls module
Type:Bug
Component:javafx
Sub-Component:controls
Affected Version:8,9
Priority:P3
Status:Resolved
Resolution:Fixed
Submitted:2016-08-08
Updated:2017-03-10
Resolved:2017-03-10
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.
Thanks for the valuable feedback. Here is the revised webrev.01 and the delta between 00 and 01:
http://cr.openjdk.java.net/~ckyang/JDK-8163385/webrev.01
http://cr.openjdk.java.net/~ckyang/JDK-8163385/webrev.0001.diff/
10-03-2017
Comments:
1) XYChart has had "@param c The series that has been changed" added to seriesChanged. This is a little unclear, as the 'c' is not a series, but a Change object consisting of the changes made.
2) Cell has "@param value the data value to this item" - it might be clearer to say "@param value the new data value to set in this cell"
3) CheckBoxTreeItem has a typo: ���@param selectionChanged the selectioonChanged���. This should probably say ���@param selectionChanged Represents whether the selection has changed���.
4) DatePicker: ���@return the calendar system��� should probably be ���@return A property representing the Chronology being used���
5) DatePicker: ���@return the string converter of type LocalDate��� should probably be ���@return the property representing the current LocalDate string converter���
6) Label: ���@return the label for this node��� isn���t a great description. This should probably say ���@return the Node that this label is to be associated with.���
7) ListView: ���@param value ell factory to use in this ListView��� typo - s/ell/cell
8) In MultipleSelectionModel, there is this change:
+ * @param index the selected index
+ * @param indices the selected indices
I would probably instead say the following:
* @param index The first index to select
* @param indices Zero or more additional indices to select
9) In ProgressBar: ���@param progress the progress��� should probably be ���@param progress the progress, represented as a value between 0 and 1���
10) Same as ProgressBar, but for ProgressIndicator
11) TitledPane typo: ���@param value if flag indicating the animated state��� s/if/a ?
12) TreeCell: Extra space ���@return the TreeItem property representing this TreeCell���
13) TreeItem: typo ���@return The base EventType when an event has occurred a within a TreeItem���
14) TreeTableCell ���@param <S> The type of the TableView generic type��� - this should say ���TreeTableView���, not ���TableView���
15) Same as above, TreeTableColumn references TableView in a number of places where it should be TreeTableView
16) Similarly, TreeTableColumn references TableColumn, where it should be TreeTableColumn
17) TreeTableRow has a typo (that wasn���t done by you): ���the TreeItem currently set in this TreeCell��� - TreeCell should be TreeTableRow
18) In TreeView, there are multiple additions of ���@param <T> the type of edit event���. This should probably be changed to ���@param <T> the type of the TreeItem instances used in this TreeView���
19) CheckBoxTreeTableCell: ���@param <S> The type of the TableView generic type��� should be TreeTableView in a number of places
20) Same as 19, but for ChoiceBoxTreeTableCell
21) Same as 19, but for ComboBoxTreeTableCell
22) Same as 19, but for ProgressBarTreeTableCell
23) Same as 19, but for TextFieldTreeTableCell
24) Something weird happened in MenuBarSkin: ���@param menuBar the menu bar��� was added to a section divider
09-03-2017
Please review the proposed fix.
In the interest of time, I'm sending this is a huge webrev for review while I do a second pass to do further code cleanup. At this point the webrev has achieved its objective of doclint clean (no warnings and error in control). No effort is spent to improve the clarity of the javadoc which is beyond the scope of this task.
http://cr.openjdk.java.net/~ckyang/JDK-8163385/webrev.00/