[cp-patches] FYI: added API docs for javax.swing.Icon interface

[David Gilbert]

I committed this patch:

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

        * javax/swing/Icon.java: added API doc comments.

Regards,

Dave

Index: javax/swing/Icon.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/Icon.java,v
retrieving revision 1.6
diff -u -r1.6 Icon.java
--- javax/swing/Icon.java       13 Jul 2005 21:22:44 -0000      1.6
+++ javax/swing/Icon.java       23 Jul 2005 20:41:35 -0000
@@ -1,5 +1,5 @@
 /* Icon.java -- 
-   Copyright (C) 2002, 2004 Free Software Foundation, Inc.
+   Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -46,7 +46,28 @@
  */
 public interface Icon
 {
+  /**
+   * Returns the height of the icon.
+   * 
+   * @return The height of the icon.
+   */
   int getIconHeight();
+  
+  /**
+   * Returns the width of the icon.
+   * 
+   * @return The width of the icon.
+   */
   int getIconWidth();
+  
+  /**
+   * Draws the icon at the location (x, y) on the specified graphics device.
+   * 
+   * @param c  a component related to the icon in some way (can be ignored by
+               some implementing classes).
+   * @param g  the graphics device.
+   * @param x  the x-coordinate.
+   * @param y  the y-coordinate.
+   */
   void paintIcon(Component c, Graphics g, int x, int y);
 }