[cp-patches] FYI: fixed minor API doc issues in SwingUtilities.java

[David Gilbert]

I committed this patch:

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

        * javax/swing/SwingUtilities.java: fixed some minor API doc problems.

Regards,

Dave Gilbert

Index: javax/swing/SwingUtilities.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/SwingUtilities.java,v
retrieving revision 1.33
diff -u -r1.33 SwingUtilities.java
--- javax/swing/SwingUtilities.java     20 Jul 2005 12:42:21 -0000      1.33
+++ javax/swing/SwingUtilities.java     22 Aug 2005 11:03:45 -0000
@@ -449,7 +449,7 @@
    * @return A component containing <code>(x,y)</code>, or
    * <code>null</code>
    *
-   * @see java.awt.Container#findComponentAt
+   * @see java.awt.Container#findComponentAt(int, int)
    */
   public static Component getDeepestComponentAt(Component parent, int x, int y)
   {
@@ -473,7 +473,7 @@
    * @param p The point to convert
    * @param c The component which the point is expressed in terms of
    *
-   * @see convertPointFromScreen
+   * @see #convertPointFromScreen
    */
   public static void convertPointToScreen(Point p, Component c)
   {
@@ -568,7 +568,7 @@
    *
    * @see #convertPointToScreen
    * @see #convertPointFromScreen
-   * @see #convertPoint
+   * @see #convertPoint(Component, int, int, Component)
    * @see #getRoot
    */
   public static Rectangle convertRectangle(Component source,
@@ -596,7 +596,7 @@
    * component's coordinate space, and with the destination component as
    * its source
    *
-   * @see #convertPoint
+   * @see #convertPoint(Component, int, int, Component)
    */
   public static MouseEvent convertMouseEvent(Component source,
                                              MouseEvent sourceEvent,
@@ -938,7 +938,7 @@
   }
 
   /** 
-   * Calls address@hidden java.awt.EventQueue.invokeLater} with the
+   * Calls address@hidden java.awt.EventQueue#invokeLater} with the
    * specified address@hidden Runnable}. 
    */
   public static void invokeLater(Runnable doRun)
@@ -947,7 +947,7 @@
   }
 
   /** 
-   * Calls address@hidden java.awt.EventQueue.invokeAndWait} with the
+   * Calls address@hidden java.awt.EventQueue#invokeAndWait} with the
    * specified address@hidden Runnable}. 
    */
   public static void invokeAndWait(Runnable doRun)
@@ -958,7 +958,10 @@
   }
 
   /** 
-   * Calls address@hidden java.awt.EventQueue.isEventDispatchThread}.
+   * Calls address@hidden java.awt.EventQueue#isDispatchThread()}.
+   * 
+   * @return <code>true</code> if the current thread is the current AWT event 
+   * dispatch thread.
    */
   public static boolean isEventDispatchThread()
   {
@@ -1262,11 +1265,11 @@
    * Calculates the intersection of two rectangles.
    *
    * @param x upper-left x coodinate of first rectangle
-   * @param x upper-left y coodinate of first rectangle
+   * @param y upper-left y coodinate of first rectangle
    * @param w width of first rectangle
    * @param h height of first rectangle
    * @param rect a Rectangle object of the second rectangle
-   * @throws a NullPointerException if rect is null.
+   * @throws NullPointerException if rect is null.
    *
    * @return a rectangle corresponding to the intersection of the
    * two rectangles. A zero rectangle is returned if the rectangles
@@ -1308,11 +1311,11 @@
    * Calculates the union of two rectangles.
    *
    * @param x upper-left x coodinate of first rectangle
-   * @param x upper-left y coodinate of first rectangle
+   * @param y upper-left y coodinate of first rectangle
    * @param w width of first rectangle
    * @param h height of first rectangle
    * @param rect a Rectangle object of the second rectangle
-   * @throws a NullPointerException if rect is null.
+   * @throws NullPointerException if rect is null.
    *
    * @return a rectangle corresponding to the union of the
    * two rectangles. A rectangle encompassing both is returned if the
@@ -1361,9 +1364,9 @@
    *     maps should be returned, may be
    *     address@hidden JComponent#WHEN_IN_FOCUSED_WINDOW},
    *     address@hidden JComponent#WHEN_FOCUSED} or
-   *     address@hidden JComponent#WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
+   *     address@hidden JComponent#WHEN_ANCESTOR_OF_FOCUSED_COMPONENT}
    *
-   * @return
+   * @return The input map.
    */
   public static InputMap getUIInputMap(JComponent component, int cond)
   {