[cp-patches] FYI: minor API doc fixes in java.awt.*

[David Gilbert]

I committed this patch to fix some API doc links in the java.awt.* package:

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

        * java/awt/AWTKeyStroke.java: fixed API doc links,
        * java/awt/BufferCapabilities.java: likewise,
        * java/awt/ColorPaintContext.java: likewise,
        * java/awt/Component.java: likewise,
        * java/awt/Container.java: likewise,
        * java/awt/EventQueue.java: likewise,
        * java/awt/GraphicsDevice.java: likewise,
        * java/awt/Image.java: likewise,
        * java/awt/KeyboardFocusManager.java: likewise,
        * java/awt/MediaTracker.java: likewise,
        * java/awt/PrintJob.java: likewise,
        * java/awt/Robot.java: likewise.
        
Regards,

Dave Gilbert

Index: java/awt/AWTKeyStroke.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/AWTKeyStroke.java,v
retrieving revision 1.10
diff -u -r1.10 AWTKeyStroke.java
--- java/awt/AWTKeyStroke.java  2 Jul 2005 20:32:22 -0000       1.10
+++ java/awt/AWTKeyStroke.java  6 Jul 2005 08:09:21 -0000
@@ -38,6 +38,7 @@
 
 package java.awt;
 
+import java.awt.event.InputEvent;
 import java.awt.event.KeyEvent;
 import java.io.ObjectStreamException;
 import java.io.Serializable;
Index: java/awt/BufferCapabilities.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/BufferCapabilities.java,v
retrieving revision 1.7
diff -u -r1.7 BufferCapabilities.java
--- java/awt/BufferCapabilities.java    2 Jul 2005 20:32:23 -0000       1.7
+++ java/awt/BufferCapabilities.java    6 Jul 2005 08:09:22 -0000
@@ -38,6 +38,8 @@
 
 package java.awt;
 
+import java.awt.image.BufferStrategy;
+
 /**
  * A double-buffering capability descriptor.  This class exposes
  * details about the double-buffering algorithms used by image
@@ -60,7 +62,7 @@
  * @author Eric Blake (address@hidden)
  *
  * @see BufferStrategy#getCapabilities()
- * @see GraphicsConfiguration#getCapabilities()
+ * @see GraphicsConfiguration#getBufferCapabilities()
  *
  * @since 1.4
  */
Index: java/awt/ColorPaintContext.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/ColorPaintContext.java,v
retrieving revision 1.4
diff -u -r1.4 ColorPaintContext.java
--- java/awt/ColorPaintContext.java     2 Jul 2005 20:32:23 -0000       1.4
+++ java/awt/ColorPaintContext.java     6 Jul 2005 08:09:22 -0000
@@ -105,8 +105,8 @@
    *
    * @param x the x-coordinate, in device space
    * @param y the y-coordinate, in device space
-   * @param w the width, in device space
-   * @param h the height, in device space
+   * @param width the width, in device space
+   * @param height the height, in device space
    * @return a raster for the given area and color
    */
   public Raster getRaster(int x, int y, int width, int height)
Index: java/awt/Component.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/Component.java,v
retrieving revision 1.60
diff -u -r1.60 Component.java
--- java/awt/Component.java     2 Jul 2005 20:32:23 -0000       1.60
+++ java/awt/Component.java     6 Jul 2005 08:09:29 -0000
@@ -3502,9 +3502,9 @@
   /**
    * Sets the focus traversal keys for one of the three focus
    * traversal directions supported by Components:
-   * address@hidden #KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS},
-   * address@hidden #KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS}, or
-   * address@hidden #KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS}. Normally, 
the
+   * address@hidden KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS},
+   * address@hidden KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS}, or
+   * address@hidden KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS}. Normally, 
the
    * default values should match the operating system's native
    * choices. To disable a given traversal, use
    * <code>Collections.EMPTY_SET</code>. The event dispatcher will
Index: java/awt/Container.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/Container.java,v
retrieving revision 1.53
diff -u -r1.53 Container.java
--- java/awt/Container.java     2 Jul 2005 20:32:24 -0000       1.53
+++ java/awt/Container.java     6 Jul 2005 08:09:32 -0000
@@ -269,7 +269,7 @@
    *
    * @return The same component that was added.
    *
-   * @throws ArrayIndexOutOfBounds If the specified index is invalid.
+   * @throws ArrayIndexOutOfBoundsException If the specified index is invalid.
    */
   public Component add(Component comp, int index)
   {
@@ -300,7 +300,7 @@
    * @param index The index in the component list to insert this child
    * at, or -1 to add at the end of the list.
    *
-   * @throws ArrayIndexOutOfBounds If the specified index is invalid.
+   * @throws ArrayIndexOutOfBoundsException If the specified index is invalid.
    */
   public void add(Component comp, Object constraints, int index)
   {
@@ -320,7 +320,7 @@
    * @param index The index in the component list to insert this child
    * at, or -1 to add at the end of the list.
    *
-   * @throws ArrayIndexOutOfBounds If the specified index is invalid.
+   * @throws ArrayIndexOutOfBoundsException If the specified index is invalid.
    */
   protected void addImpl(Component comp, Object constraints, int index)
   {
@@ -436,7 +436,7 @@
   /**
    * Removes the specified component from this container.
    *
-   * @return component The component to remove from this container.
+   * @param comp The component to remove from this container.
    */
   public void remove(Component comp)
   {
@@ -1367,7 +1367,7 @@
    * however, ContainerOrderFocusTraversalPolicy is in effect, and it
    * supports implicit down-cycle traversal operations.
    *
-   * @return true if this is a focus cycle root, false otherwise
+   * @param focusCycleRoot true if this is a focus cycle root, false otherwise
    *
    * @since 1.4
    */
Index: java/awt/EventQueue.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/EventQueue.java,v
retrieving revision 1.22
diff -u -r1.22 EventQueue.java
--- java/awt/EventQueue.java    2 Jul 2005 20:32:24 -0000       1.22
+++ java/awt/EventQueue.java    6 Jul 2005 08:09:33 -0000
@@ -42,6 +42,7 @@
 
 import java.awt.event.ActionEvent;
 import java.awt.event.InputEvent;
+import java.awt.event.InputMethodEvent;
 import java.awt.event.InvocationEvent;
 import java.awt.event.WindowEvent;
 import java.lang.reflect.InvocationTargetException;
Index: java/awt/GraphicsDevice.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/GraphicsDevice.java,v
retrieving revision 1.4
diff -u -r1.4 GraphicsDevice.java
--- java/awt/GraphicsDevice.java        2 Jul 2005 20:32:25 -0000       1.4
+++ java/awt/GraphicsDevice.java        6 Jul 2005 08:09:33 -0000
@@ -38,6 +38,8 @@
 
 package java.awt;
 
+import java.awt.image.VolatileImage;
+
 /**
  * This describes a graphics device available to the given environment. This
  * includes screen and printer devices, and the different configurations for
@@ -163,8 +165,8 @@
    *
    * @param w the window to toggle
    * @see #isFullScreenSupported()
-   * @see getFullScreenWindow()
-   * @see setDisplayMode(DisplayMode)
+   * @see #getFullScreenWindow()
+   * @see #setDisplayMode(DisplayMode)
    * @see Component#enableInputMethods(boolean)
    * @since 1.4
    */
Index: java/awt/Image.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/Image.java,v
retrieving revision 1.10
diff -u -r1.10 Image.java
--- java/awt/Image.java 2 Jul 2005 20:32:25 -0000       1.10
+++ java/awt/Image.java 6 Jul 2005 08:09:33 -0000
@@ -94,7 +94,7 @@
    * Constant indicating that the area averaging scaling algorithm should be
    * used.
    *
-   * @see AreaAveragingScaleFilter
+   * @see java.awt.image.AreaAveragingScaleFilter
    * @since 1.1
    */
   public static final int SCALE_AREA_AVERAGING = 16;
@@ -141,7 +141,7 @@
    * This method is only valid for off-screen objects.
    *
    * @return a graphics context object for an off-screen object
-   * @see Graphics#createImage(int, int)
+   * @see Graphics#getcreateImage(int, int)
    */
   public abstract Graphics getGraphics();
 
Index: java/awt/KeyboardFocusManager.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/KeyboardFocusManager.java,v
retrieving revision 1.13
diff -u -r1.13 KeyboardFocusManager.java
--- java/awt/KeyboardFocusManager.java  2 Jul 2005 20:32:25 -0000       1.13
+++ java/awt/KeyboardFocusManager.java  6 Jul 2005 08:09:36 -0000
@@ -38,8 +38,10 @@
 
 package java.awt;
 
+import java.applet.Applet;
 import java.awt.event.FocusEvent;
 import java.awt.event.KeyEvent;
+import java.awt.event.WindowEvent;
 import java.beans.PropertyChangeListener;
 import java.beans.PropertyChangeSupport;
 import java.beans.PropertyVetoException;
@@ -335,8 +337,8 @@
    * @param owner the Component to return from getFocusOwner and
    * getGlobalFocusOwner
    *
-   * @see Component.requestFocus ()
-   * @see Component.requestFocusInWindow ()
+   * @see Component#requestFocus()
+   * @see Component#requestFocusInWindow()
    */
   protected void setGlobalFocusOwner (Component owner)
   {
@@ -419,8 +421,8 @@
    * @param focusOwner the Component to return from
    * getPermanentFocusOwner and getGlobalPermanentFocusOwner
    *
-   * @see Component.requestFocus ()
-   * @see Component.requestFocusInWindow ()
+   * @see Component#requestFocus()
+   * @see Component#requestFocusInWindow()
    */
   protected void setGlobalPermanentFocusOwner (Component focusOwner)
   {
Index: java/awt/MediaTracker.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/MediaTracker.java,v
retrieving revision 1.16
diff -u -r1.16 MediaTracker.java
--- java/awt/MediaTracker.java  2 Jul 2005 20:32:25 -0000       1.16
+++ java/awt/MediaTracker.java  6 Jul 2005 08:09:37 -0000
@@ -48,7 +48,7 @@
   * Media objects are tracked by assigning them an ID. It is possible
   * to assign the same ID to mutliple objects, effectivly grouping them
   * together. In this case the status flags (address@hidden #statusID}) and 
error flag
-  * (@link #isErrorID} and address@hidden #getErrorId}) are ORed together. This
+  * (@link #isErrorID} and address@hidden #getErrorsID}) are ORed together. 
This
   * means that you cannot say exactly which media object has which status,
   * at most you can say that there <em>are</em> certain media objects with
   * some certain status.
@@ -123,7 +123,7 @@
      * @return <code>true</code> if more data is needed, <code>false</code>
      *         otherwise
      *
-     * @see address@hidden java.awt.image.ImageObserver}
+     * @see java.awt.image.ImageObserver
      */
     public boolean imageUpdate(Image img, int flags, int x, int y, 
                                int width, int height)
Index: java/awt/PrintJob.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/PrintJob.java,v
retrieving revision 1.7
diff -u -r1.7 PrintJob.java
--- java/awt/PrintJob.java      2 Jul 2005 20:32:25 -0000       1.7
+++ java/awt/PrintJob.java      6 Jul 2005 08:09:37 -0000
@@ -38,6 +38,8 @@
 
 package java.awt;
 
+import java.util.Properties;
+
 /**
  * This abstract class represents a print job.
  *
Index: java/awt/Robot.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/Robot.java,v
retrieving revision 1.8
diff -u -r1.8 Robot.java
--- java/awt/Robot.java 2 Jul 2005 20:32:25 -0000       1.8
+++ java/awt/Robot.java 6 Jul 2005 08:09:37 -0000
@@ -53,7 +53,7 @@
  * create self-running demo programs.
  *
  * Since Robot generates native windowing system events, rather than
- * simply inserting address@hidden AWTEvents} on the AWT event queue, its use
+ * simply inserting address@hidden AWTEvent}s on the AWT event queue, its use
  * is not restricted to Java programs.  It can be used to
  * programatically drive any graphical application.
  *
@@ -227,7 +227,7 @@
   /**
    * Press a key.
    *
-   * @param keycode key to press, a address@hidden KeyEvent} VK_ constant
+   * @param keycode key to press, a address@hidden java.awt.event.KeyEvent} 
VK_ constant
    *
    * @exception IllegalArgumentException if keycode is not a valid key
    */
@@ -245,7 +245,8 @@
   /**
    * Release a key.
    *
-   * @param keycode key to release, a address@hidden KeyEvent} VK_ constant
+   * @param keycode key to release, a address@hidden java.awt.event.KeyEvent} 
VK_ 
+   *                constant
    *
    * @exception IllegalArgumentException if keycode is not a valid key
    */
@@ -312,7 +313,7 @@
   }
 
   /**
-   * Check if this Robot automatically calls address@hidden waitForIdle} after
+   * Check if this Robot automatically calls address@hidden #waitForIdle()} 
after
    * generating an event.
    *
    * @return true if waitForIdle is automatically called
@@ -324,7 +325,7 @@
 
   /**
    * Set whether or not this Robot automatically calls address@hidden
-   * waitForIdle} after generating an event.
+   * #waitForIdle()} after generating an event.
    *
    * @param isOn true if waitForIdle should be called automatically
    */