-
Bug
-
Resolution: Duplicate
-
P3
-
7
-
generic
-
generic
This is an umbrella CR that identifies the problem with absence of method specification in javax.swing.plaf area and shows the scale of it.
When specification for a method appears in JavaDoc it means that:
- it is attached to the method itself in the source of the class
- it is inhereted if method overrides or implements some other method
The attached quick-n-dirty program searched through java.swing.plaf sources for JDK7 b109 and prints out all the public/protected methods that don't override/implement anything and have no specification at all.
(it contains some simplifications, but the actual number could be only higher)
Total number of "unique" public/protected methods without any spec is 675.
Detailed report is attached. Extract from it is below:
-----------------------------------------------------
...
no doc comment for method "<init>"
no doc comment for method "getDirectories"
no doc comment for method "getFiles"
no doc comment for method "validateFileCache"
no doc comment for method "contains"
no doc comment for method "indexOf"
no doc comment for method "sort"
no doc comment for method "lt"
in class BasicDirectoryModel
in file work\javax\swing\plaf\basic\BasicDirectoryModel.java
------------------------------------
no doc comment for method "<init>"
no doc comment for method "installComponents"
no doc comment for method "uninstallComponents"
no doc comment for method "installListeners"
no doc comment for method "uninstallListeners"
no doc comment for method "installDefaults"
no doc comment for method "installIcons"
no doc comment for method "installStrings"
no doc comment for method "uninstallDefaults"
no doc comment for method "uninstallIcons"
no doc comment for method "uninstallStrings"
no doc comment for method "createModel"
no doc comment for method "getModel"
no doc comment for method "createPropertyChangeListener"
no doc comment for method "getFileName"
no doc comment for method "getDirectoryName"
no doc comment for method "setFileName"
no doc comment for method "setDirectoryName"
no doc comment for method "getFileChooser"
no doc comment for method "getAccessoryPanel"
no doc comment for method "getApproveButton"
no doc comment for method "getApproveButtonToolTipText"
no doc comment for method "clearIconCache"
no doc comment for method "createDoubleClickListener"
no doc comment for method "createListSelectionListener"
no doc comment for method "<init>"
in class DoubleClickListener
no doc comment for method "getApproveButtonMnemonic"
no doc comment for method "getNewFolderAction"
no doc comment for method "getGoHomeAction"
no doc comment for method "getChangeToParentDirectoryAction"
no doc comment for method "getApproveSelectionAction"
no doc comment for method "getCancelSelectionAction"
no doc comment for method "getUpdateAction"
no doc comment for method "<init>"
in class NewFolderAction
no doc comment for method "<init>"
in class GoHomeAction
no doc comment for method "<init>"
in class ChangeToParentDirectoryAction
no doc comment for method "<init>"
in class ApproveSelectionAction
no doc comment for method "<init>"
in class AcceptAllFileFilter
no doc comment for method "<init>"
no doc comment for method "clearIconCache"
no doc comment for method "getCachedIcon"
no doc comment for method "cacheIcon"
no doc comment for method "isHidden"
in class BasicFileView
in class BasicFileChooserUI
in file work\javax\swing\plaf\basic\BasicFileChooserUI.java
------------------------------------
no doc comment for method "drawEtchedRect"
no doc comment for method "drawGroove"
no doc comment for method "drawBezel"
no doc comment for method "drawLoweredBezel"
no doc comment for method "drawDashedRect"
no doc comment for method "getPreferredButtonSize"
in class BasicGraphicsUtils
in file work\javax\swing\plaf\basic\BasicGraphicsUtils.java
------------------------------------
no doc comment for method "getMenuItemCheckIcon"
no doc comment for method "getMenuItemArrowIcon"
no doc comment for method "getMenuArrowIcon"
no doc comment for method "getCheckBoxIcon"
no doc comment for method "getRadioButtonIcon"
no doc comment for method "getCheckBoxMenuItemIcon"
no doc comment for method "getRadioButtonMenuItemIcon"
no doc comment for method "createEmptyFrameIcon"
in class BasicIconFactory
in file work\javax\swing\plaf\basic\BasicIconFactory.java
------------------------------------
no doc comment for method "<init>"
no doc comment for method "installTitlePane"
no doc comment for method "addSubComponents"
no doc comment for method "createActions"
no doc comment for method "installListeners"
no doc comment for method "uninstallListeners"
no doc comment for method "installDefaults"
no doc comment for method "uninstallDefaults"
no doc comment for method "createButtons"
no doc comment for method "setButtonIcons"
no doc comment for method "assembleSystemMenu"
no doc comment for method "addSystemMenuItems"
no doc comment for method "createSystemMenu"
no doc comment for method "createSystemMenuBar"
no doc comment for method "showSystemMenu"
no doc comment for method "getTitle"
no doc comment for method "enableActions"
no doc comment for method "createPropertyChangeListener"
no doc comment for method "createLayout"
no doc comment for method "<init>"
in class CloseAction
no doc comment for method "<init>"
in class MaximizeAction
no doc comment for method "<init>"
in class IconifyAction
no doc comment for method "<init>"
in class RestoreAction
no doc comment for method "<init>"
in class MoveAction
no doc comment for method "<init>"
in class SizeAction
in class BasicInternalFrameTitlePane
in file work\javax\swing\plaf\basic\BasicInternalFrameTitlePane.java
....
When specification for a method appears in JavaDoc it means that:
- it is attached to the method itself in the source of the class
- it is inhereted if method overrides or implements some other method
The attached quick-n-dirty program searched through java.swing.plaf sources for JDK7 b109 and prints out all the public/protected methods that don't override/implement anything and have no specification at all.
(it contains some simplifications, but the actual number could be only higher)
Total number of "unique" public/protected methods without any spec is 675.
Detailed report is attached. Extract from it is below:
-----------------------------------------------------
...
no doc comment for method "<init>"
no doc comment for method "getDirectories"
no doc comment for method "getFiles"
no doc comment for method "validateFileCache"
no doc comment for method "contains"
no doc comment for method "indexOf"
no doc comment for method "sort"
no doc comment for method "lt"
in class BasicDirectoryModel
in file work\javax\swing\plaf\basic\BasicDirectoryModel.java
------------------------------------
no doc comment for method "<init>"
no doc comment for method "installComponents"
no doc comment for method "uninstallComponents"
no doc comment for method "installListeners"
no doc comment for method "uninstallListeners"
no doc comment for method "installDefaults"
no doc comment for method "installIcons"
no doc comment for method "installStrings"
no doc comment for method "uninstallDefaults"
no doc comment for method "uninstallIcons"
no doc comment for method "uninstallStrings"
no doc comment for method "createModel"
no doc comment for method "getModel"
no doc comment for method "createPropertyChangeListener"
no doc comment for method "getFileName"
no doc comment for method "getDirectoryName"
no doc comment for method "setFileName"
no doc comment for method "setDirectoryName"
no doc comment for method "getFileChooser"
no doc comment for method "getAccessoryPanel"
no doc comment for method "getApproveButton"
no doc comment for method "getApproveButtonToolTipText"
no doc comment for method "clearIconCache"
no doc comment for method "createDoubleClickListener"
no doc comment for method "createListSelectionListener"
no doc comment for method "<init>"
in class DoubleClickListener
no doc comment for method "getApproveButtonMnemonic"
no doc comment for method "getNewFolderAction"
no doc comment for method "getGoHomeAction"
no doc comment for method "getChangeToParentDirectoryAction"
no doc comment for method "getApproveSelectionAction"
no doc comment for method "getCancelSelectionAction"
no doc comment for method "getUpdateAction"
no doc comment for method "<init>"
in class NewFolderAction
no doc comment for method "<init>"
in class GoHomeAction
no doc comment for method "<init>"
in class ChangeToParentDirectoryAction
no doc comment for method "<init>"
in class ApproveSelectionAction
no doc comment for method "<init>"
in class AcceptAllFileFilter
no doc comment for method "<init>"
no doc comment for method "clearIconCache"
no doc comment for method "getCachedIcon"
no doc comment for method "cacheIcon"
no doc comment for method "isHidden"
in class BasicFileView
in class BasicFileChooserUI
in file work\javax\swing\plaf\basic\BasicFileChooserUI.java
------------------------------------
no doc comment for method "drawEtchedRect"
no doc comment for method "drawGroove"
no doc comment for method "drawBezel"
no doc comment for method "drawLoweredBezel"
no doc comment for method "drawDashedRect"
no doc comment for method "getPreferredButtonSize"
in class BasicGraphicsUtils
in file work\javax\swing\plaf\basic\BasicGraphicsUtils.java
------------------------------------
no doc comment for method "getMenuItemCheckIcon"
no doc comment for method "getMenuItemArrowIcon"
no doc comment for method "getMenuArrowIcon"
no doc comment for method "getCheckBoxIcon"
no doc comment for method "getRadioButtonIcon"
no doc comment for method "getCheckBoxMenuItemIcon"
no doc comment for method "getRadioButtonMenuItemIcon"
no doc comment for method "createEmptyFrameIcon"
in class BasicIconFactory
in file work\javax\swing\plaf\basic\BasicIconFactory.java
------------------------------------
no doc comment for method "<init>"
no doc comment for method "installTitlePane"
no doc comment for method "addSubComponents"
no doc comment for method "createActions"
no doc comment for method "installListeners"
no doc comment for method "uninstallListeners"
no doc comment for method "installDefaults"
no doc comment for method "uninstallDefaults"
no doc comment for method "createButtons"
no doc comment for method "setButtonIcons"
no doc comment for method "assembleSystemMenu"
no doc comment for method "addSystemMenuItems"
no doc comment for method "createSystemMenu"
no doc comment for method "createSystemMenuBar"
no doc comment for method "showSystemMenu"
no doc comment for method "getTitle"
no doc comment for method "enableActions"
no doc comment for method "createPropertyChangeListener"
no doc comment for method "createLayout"
no doc comment for method "<init>"
in class CloseAction
no doc comment for method "<init>"
in class MaximizeAction
no doc comment for method "<init>"
in class IconifyAction
no doc comment for method "<init>"
in class RestoreAction
no doc comment for method "<init>"
in class MoveAction
no doc comment for method "<init>"
in class SizeAction
in class BasicInternalFrameTitlePane
in file work\javax\swing\plaf\basic\BasicInternalFrameTitlePane.java
....
- duplicates
-
JDK-8077095 Fix missing doclint warnings in the javax.swing.plaf.basic package
- Resolved
- relates to
-
JDK-8075082 Fix missing doclint warnings in the javax.swing package
- Resolved
-
JDK-7020860 BasicTreeUI contains getters/setters with unclear spec
- Resolved