[cp-patches] FYI: minor API doc fixes for javax.swing.plaf.basic.* package

[David Gilbert]

I committed this patch to fix some minor API doc issues:

2005-07-08  David Gilbert  <address@hidden>

        * javax/swing/plaf/basic/BasicButtonUI.java: minor API doc fixes,
        * javax/swing/plaf/basic/BasicComboBoxEditor.java: likewise,
        * javax/swing/plaf/basic/BasicGraphicsUtils.java: likewise,
        * javax/swing/plaf/basic/BasicLabelUI.java: likewise,
        * javax/swing/plaf/basic/BasicListUI.java: likewise,
        * javax/swing/plaf/basic/BasicLookAndFeel.java: likewise,
        * javax/swing/plaf/basic/BasicMenuBarUI.java: likewise,
        * javax/swing/plaf/basic/BasicMenuUI.java: likewise,
        * javax/swing/plaf/basic/BasicPopupMenuUI.java: likewise,
        * javax/swing/plaf/basic/BasicScrollBarUI.java: likewise,
        * javax/swing/plaf/basic/BasicSpinnerUI.java: likewise,
        * javax/swing/plaf/basic/BasicSplitPaneDivider.java: likewise,
        * javax/swing/plaf/basic/BasicToolTipUI.java: likewise.

Regards,

Dave Gilbert

Index: javax/swing/plaf/basic/BasicButtonUI.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicButtonUI.java,v
retrieving revision 1.20
diff -u -r1.20 BasicButtonUI.java
--- javax/swing/plaf/basic/BasicButtonUI.java   2 Jul 2005 20:32:50 -0000       
1.20
+++ javax/swing/plaf/basic/BasicButtonUI.java   8 Jul 2005 15:16:15 -0000
@@ -200,7 +200,7 @@
 
   /**
    * Calculate the preferred size of this component, by delegating to
-   * address@hidden BasicGraphicsUtils.getPreferredButtonSize}.
+   * address@hidden BasicGraphicsUtils#getPreferredButtonSize}.
    *
    * @param c The component to measure
    *
@@ -300,8 +300,8 @@
    * @param tr Text rectangle, contained in visible rectangle
    * @param ir Icon rectangle, contained in visible rectangle
    *
-   * @see AbstractButton.isFocusPainted()
-   * @see JComponent.hasFocus()
+   * @see AbstractButton#isFocusPainted()
+   * @see JComponent#hasFocus()
    */
   protected void paintFocus(Graphics g, AbstractButton b, Rectangle vr,
                             Rectangle tr, Rectangle ir)
Index: javax/swing/plaf/basic/BasicComboBoxEditor.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicComboBoxEditor.java,v
retrieving revision 1.4
diff -u -r1.4 BasicComboBoxEditor.java
--- javax/swing/plaf/basic/BasicComboBoxEditor.java     2 Jul 2005 20:32:50 
-0000       1.4
+++ javax/swing/plaf/basic/BasicComboBoxEditor.java     8 Jul 2005 15:16:15 
-0000
@@ -1,5 +1,5 @@
 /* BasicComboBoxEditor.java --
-   Copyright (C) 2004  Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005  Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -81,13 +81,13 @@
   }
 
   /**
-   * Sets item that should be editted when any editting operation is performed
+   * Sets item that should be edited when any editing operation is performed
    * by the user. The value is always equal to the currently selected value
    * in the combo box. Thus whenever a different value is selected from the
-   * combo box list then this method should be  called to change editting
+   * combo box list then this method should be  called to change editing
    * item to the new selected item.
    *
-   * @param selectedItem item that is currently selected in the combo box
+   * @param item item that is currently selected in the combo box
    */
   public void setItem(Object item)
   {
Index: javax/swing/plaf/basic/BasicGraphicsUtils.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicGraphicsUtils.java,v
retrieving revision 1.14
diff -u -r1.14 BasicGraphicsUtils.java
--- javax/swing/plaf/basic/BasicGraphicsUtils.java      2 Jul 2005 20:32:50 
-0000       1.14
+++ javax/swing/plaf/basic/BasicGraphicsUtils.java      8 Jul 2005 15:16:15 
-0000
@@ -51,6 +51,8 @@
 import java.awt.geom.Rectangle2D;
 
 import javax.swing.AbstractButton;
+import javax.swing.Icon;
+import javax.swing.JComponent;
 import javax.swing.SwingUtilities;
 
 
@@ -585,7 +587,9 @@
    *         and <code>height</code> fields indicate the preferred
    *         extent in pixels.
    *
-   * @see javax.swing.SwingUtilities#layoutCompoundLabel
+   * @see javax.swing.SwingUtilities#layoutCompoundLabel(JComponent, 
+   *      FontMetrics, String, Icon, int, int, int, int, Rectangle, Rectangle, 
+   *      Rectangle, int)
    */
   public static Dimension getPreferredButtonSize(AbstractButton b,
                                                  int textIconGap)
Index: javax/swing/plaf/basic/BasicLabelUI.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicLabelUI.java,v
retrieving revision 1.13
diff -u -r1.13 BasicLabelUI.java
--- javax/swing/plaf/basic/BasicLabelUI.java    2 Jul 2005 20:32:50 -0000       
1.13
+++ javax/swing/plaf/basic/BasicLabelUI.java    8 Jul 2005 15:16:15 -0000
@@ -92,7 +92,8 @@
 
   /**
    * Returns the preferred size of this component as calculated by the
-   * address@hidden layoutCL} method.
+   * address@hidden #layoutCL(JLabel, FontMetrics, String, Icon, Rectangle, 
Rectangle, 
+   * Rectangle)} method.
    *
    * @param c This address@hidden JComponent} to get a preferred size for.
    *
Index: javax/swing/plaf/basic/BasicListUI.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicListUI.java,v
retrieving revision 1.22
diff -u -r1.22 BasicListUI.java
--- javax/swing/plaf/basic/BasicListUI.java     2 Jul 2005 20:32:50 -0000       
1.22
+++ javax/swing/plaf/basic/BasicListUI.java     8 Jul 2005 15:16:16 -0000
@@ -95,7 +95,7 @@
   }
 
   /**
-   * A helper class which listens for address@hidden FocusEvents}
+   * A helper class which listens for address@hidden FocusEvent}s
    * from the JList.
    */
   public class FocusHandler implements FocusListener
@@ -133,7 +133,7 @@
    * A helper class which listens for address@hidden ListDataEvent}s generated 
by
    * the address@hidden JList}'s address@hidden ListModel}.
    *
-   * @see javax.swing.JList#model
+   * @see javax.swing.JList#getModel()
    */
   public class ListDataHandler implements ListDataListener
   {
Index: javax/swing/plaf/basic/BasicLookAndFeel.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicLookAndFeel.java,v
retrieving revision 1.25
diff -u -r1.25 BasicLookAndFeel.java
--- javax/swing/plaf/basic/BasicLookAndFeel.java        8 Jul 2005 10:35:35 
-0000       1.25
+++ javax/swing/plaf/basic/BasicLookAndFeel.java        8 Jul 2005 15:16:20 
-0000
@@ -47,7 +47,6 @@
 import java.util.Enumeration;
 import java.util.ResourceBundle;
 
-import javax.swing.ImageIcon;
 import javax.swing.KeyStroke;
 import javax.swing.LookAndFeel;
 import javax.swing.UIDefaults;
@@ -55,7 +54,6 @@
 import javax.swing.plaf.ColorUIResource;
 import javax.swing.plaf.DimensionUIResource;
 import javax.swing.plaf.FontUIResource;
-import javax.swing.plaf.IconUIResource;
 import javax.swing.plaf.InsetsUIResource;
 import javax.swing.text.JTextComponent;
 
@@ -69,7 +67,7 @@
   static final long serialVersionUID = -6096995660290287879L;
 
   /**
-   * Constructor BasicLookAndFeel
+   * Creates a new instance of the Basic look and feel.
    */
   public BasicLookAndFeel()
   {
@@ -77,8 +75,10 @@
   }
 
   /**
-   * getDefaults
-   * @return UIDefaults
+   * Creates and returns a new instance of the default resources for this look 
+   * and feel.
+   * 
+   * @return The UI defaults.
    */
   public UIDefaults getDefaults()
   {
@@ -95,8 +95,10 @@
   }
 
   /**
-   * initClassDefaults
-   * @param value0 TODO
+   * Populates the <code>defaults</code> table with mappings between class IDs 
+   * and fully qualified class names for the UI delegates.
+   * 
+   * @param defaults  the defaults table (<code>null</code> not permitted).
    */
   protected void initClassDefaults(UIDefaults defaults)
   {
@@ -155,8 +157,9 @@
   }
 
   /**
-   * initSystemColorDefaults
-   * @param defaults TODO
+   * Populates the <code>defaults</code> table with system color defaults.
+   * 
+   * @param defaults  the defaults table (<code>null</code> not permitted).
    */
   protected void initSystemColorDefaults(UIDefaults defaults)
   {
@@ -198,13 +201,14 @@
   }
 
   /**
-   * loadSystemColors
-   * @param defaults TODO
-   * @param value1 TODO
-   * @param value2 TODO
+   * Loads the system colors.  This method is not implemented yet.
+   * 
+   * @param defaults  the defaults table (<code>null</code> not permitted).
+   * @param systemColors TODO
+   * @param useNative TODO
    */
-  protected void loadSystemColors(UIDefaults defaults, String[] value1,
-                                  boolean value2)
+  protected void loadSystemColors(UIDefaults defaults, String[] systemColors,
+                                  boolean useNative)
   {
     // TODO
   }
@@ -232,7 +236,7 @@
 
   /**
    * initComponentDefaults
-   * @param defaults TODO
+   * @param defaults  the defaults table (<code>null</code> not permitted).
    */
   protected void initComponentDefaults(UIDefaults defaults)
   {
@@ -839,7 +843,7 @@
       "TableHeader.font", new FontUIResource("Dialog", Font.PLAIN, 12),
       "TableHeader.foreground", new ColorUIResource(darkShadow),
 
-                       "TextArea.background", new ColorUIResource(light),
+            "TextArea.background", new ColorUIResource(light),
       "TextArea.border", new BasicBorders.MarginBorder(),
       "TextArea.caretBlinkRate", new Integer(500),
       "TextArea.caretForeground", new ColorUIResource(Color.black),
@@ -880,11 +884,11 @@
                                                              0),
                                       "notify-field-accept"),
         new JTextComponent.KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_LEFT,
-                                                            
InputEvent.SHIFT_DOWN_MASK),
-                                                            
"selection-backward"),
+                                 InputEvent.SHIFT_DOWN_MASK),
+                                 "selection-backward"),
         new JTextComponent.KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_RIGHT,
-                                                            
InputEvent.SHIFT_DOWN_MASK),
-                                                            
"selection-forward"),
+                                 InputEvent.SHIFT_DOWN_MASK),
+                                 "selection-forward"),
           },
       "TextField.margin", new InsetsUIResource(0, 0, 0, 0),
       "TextField.selectionBackground", new ColorUIResource(Color.black),
Index: javax/swing/plaf/basic/BasicMenuBarUI.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicMenuBarUI.java,v
retrieving revision 1.9
diff -u -r1.9 BasicMenuBarUI.java
--- javax/swing/plaf/basic/BasicMenuBarUI.java  2 Jul 2005 20:32:50 -0000       
1.9
+++ javax/swing/plaf/basic/BasicMenuBarUI.java  8 Jul 2005 15:16:20 -0000
@@ -105,7 +105,7 @@
    * Factory method to create a BasicMenuBarUI for the given address@hidden
    * JComponent}, which should be a address@hidden JMenuBar}.
    *
-   * @param b The address@hidden JComponent} a UI is being created for.
+   * @param x The address@hidden JComponent} a UI is being created for.
    *
    * @return A BasicMenuBarUI for the address@hidden JComponent}.
    */
Index: javax/swing/plaf/basic/BasicMenuUI.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicMenuUI.java,v
retrieving revision 1.9
diff -u -r1.9 BasicMenuUI.java
--- javax/swing/plaf/basic/BasicMenuUI.java     2 Jul 2005 20:32:50 -0000       
1.9
+++ javax/swing/plaf/basic/BasicMenuUI.java     8 Jul 2005 15:16:20 -0000
@@ -419,7 +419,7 @@
       *
       * @param e The PropertyChangeEvent.
       */
-    public void propertyChange(PropertyChangeEvent evt)
+    public void propertyChange(PropertyChangeEvent e)
     {
     }
   }
Index: javax/swing/plaf/basic/BasicPopupMenuUI.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicPopupMenuUI.java,v
retrieving revision 1.11
diff -u -r1.11 BasicPopupMenuUI.java
--- javax/swing/plaf/basic/BasicPopupMenuUI.java        2 Jul 2005 20:32:50 
-0000       1.11
+++ javax/swing/plaf/basic/BasicPopupMenuUI.java        8 Jul 2005 15:16:20 
-0000
@@ -51,6 +51,7 @@
 import javax.swing.JComponent;
 import javax.swing.JLayeredPane;
 import javax.swing.JMenu;
+import javax.swing.JMenuItem;
 import javax.swing.JPopupMenu;
 import javax.swing.MenuElement;
 import javax.swing.MenuSelectionManager;
Index: javax/swing/plaf/basic/BasicScrollBarUI.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicScrollBarUI.java,v
retrieving revision 1.21
diff -u -r1.21 BasicScrollBarUI.java
--- javax/swing/plaf/basic/BasicScrollBarUI.java        2 Jul 2005 20:32:50 
-0000       1.21
+++ javax/swing/plaf/basic/BasicScrollBarUI.java        8 Jul 2005 15:16:21 
-0000
@@ -45,8 +45,6 @@
 import java.awt.Graphics;
 import java.awt.Insets;
 import java.awt.LayoutManager;
-import java.awt.Point;
-import java.awt.Polygon;
 import java.awt.Rectangle;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
Index: javax/swing/plaf/basic/BasicSpinnerUI.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicSpinnerUI.java,v
retrieving revision 1.5
diff -u -r1.5 BasicSpinnerUI.java
--- javax/swing/plaf/basic/BasicSpinnerUI.java  2 Jul 2005 20:32:50 -0000       
1.5
+++ javax/swing/plaf/basic/BasicSpinnerUI.java  8 Jul 2005 15:16:21 -0000
@@ -1,5 +1,5 @@
 /* SpinnerUI.java --
-   Copyright (C) 2003, 2004  Free Software Foundation, Inc.
+   Copyright (C) 2003, 2004, 2005  Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -161,7 +161,7 @@
    * obtained from <code>UIManager.getLookAndFeelDefaults</code>, as well as
    * set the layout obtained from <code>createLayout</code>
    *
-   * @see #javax.swing.UIManager#getLookAndFeelDefaults
+   * @see javax.swing.UIManager#getLookAndFeelDefaults
    * @see #createLayout
    * @see #installUI
    */
Index: javax/swing/plaf/basic/BasicSplitPaneDivider.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicSplitPaneDivider.java,v
retrieving revision 1.9
diff -u -r1.9 BasicSplitPaneDivider.java
--- javax/swing/plaf/basic/BasicSplitPaneDivider.java   2 Jul 2005 20:32:50 
-0000       1.9
+++ javax/swing/plaf/basic/BasicSplitPaneDivider.java   8 Jul 2005 15:16:24 
-0000
@@ -273,7 +273,7 @@
    *
    * @param border the new border. Typically, this will be an instance of
    *        address@hidden
-   *        javax.swing.plaf.basic.BasicBorders.SplitPaneDividerBorder}.
+   *        javax.swing.plaf.basic.BasicBorders.SplitPaneBorder}.
    *
    * @since 1.3
    */
Index: javax/swing/plaf/basic/BasicToolTipUI.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/plaf/basic/BasicToolTipUI.java,v
retrieving revision 1.4
diff -u -r1.4 BasicToolTipUI.java
--- javax/swing/plaf/basic/BasicToolTipUI.java  2 Jul 2005 20:32:50 -0000       
1.4
+++ javax/swing/plaf/basic/BasicToolTipUI.java  8 Jul 2005 15:16:24 -0000
@@ -97,7 +97,7 @@
                         * @param x The x coordinate to start painting at.
                         * @param y The y coordinate to start painting at.
                         * @param w The width of the Component.
-                        * @param y The height of the Component.
+                        * @param h The height of the Component.
                         */
       public void paintBorder(Component c, Graphics g, int x, int y, int w,
                               int h)