[cp-patches] FYI: JInternalFrame.paramString() + API docs

[David Gilbert]

This patch (committed) modifies the paramString() method to add a little more info 
for debugging, and adds/updates some API docs on other methods:

2006-04-18  David Gilbert  <[EMAIL PROTECTED]>
        * javax/swing/JInternalFrame.java
        (JDesktopIcon.getAccessibleContext): Added API docs,
        (getDefaultCloseOperation): Likewise,
        (paramString): Added 'title' attribute,
        (setDefaultCloseOperation): Added API docs.

Regards,

Dave
Index: javax/swing/JInternalFrame.java
===================================================================
RCS file: /sources/classpath/classpath/javax/swing/JInternalFrame.java,v
retrieving revision 1.33
diff -u -r1.33 JInternalFrame.java
--- javax/swing/JInternalFrame.java     13 Apr 2006 10:50:23 -0000      1.33
+++ javax/swing/JInternalFrame.java     18 Apr 2006 17:02:04 -0000
@@ -280,15 +280,17 @@
       updateUI();
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
+  /**
+   * Returns the object that provides accessibility features for this
+   * <code>JDesktopIcon</code> component.
+   *
+   * @return The accessible context (an instance of 
+   *         [EMAIL PROTECTED] AccessibleJDesktopIcon}).
+   */
     public AccessibleContext getAccessibleContext()
     {
       if (accessibleContext == null)
-       accessibleContext = new AccessibleJDesktopIcon();
+        accessibleContext = new AccessibleJDesktopIcon();
       return accessibleContext;
     }
 
@@ -773,10 +775,16 @@
   }
 
   /**
-   * This method returns the default action taken when this JInternalFrame is
-   * closed.
+   * Returns a code for the default action taken when this 
+   * <code>JInternalFrame</code> is closed.
    *
-   * @return The default action taken when this JInternalFrame is closed.
+   * @return The action code (usually one of 
+   *     [EMAIL PROTECTED] WindowConstants#DO_NOTHING_ON_CLOSE}, 
+   *     [EMAIL PROTECTED] WindowConstants#HIDE_ON_CLOSE}, or 
+   *     [EMAIL PROTECTED] WindowConstants#DISPOSE_ON_CLOSE}).
+   * 
+   * @see #setDefaultCloseOperation(int)
+   * @see #doDefaultCloseAction()
    */
   public int getDefaultCloseOperation()
   {
@@ -1202,13 +1210,15 @@
   }
 
   /**
-   * This method returns a String describing this JInternalFrame.
+   * An implementation dependent string describing the current state of this 
+   * <code>JInternalFrame</code> instance.
    *
-   * @return A String describing this JInternalFrame.
+   * @return A string describing the current state of this 
+   *     <code>JInternalFrame</code> instance.
    */
   protected String paramString()
   {
-    return super.paramString();
+    return super.paramString() + ",title=" + getTitle();
   }
 
   /**
@@ -1322,12 +1332,17 @@
   }
 
   /**
-   * This method sets the action taken when this JInternalFrame is closed.
-   *
-   * @param operation One of DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE or
-   *        DISPOSE_ON_CLOSE.
-   *
-   * @throws Error If the given operation is not one of the allowed modes.
+   * Sets a code for the action to be taken when this 
+   * <code>JInternalFrame</code> is closed.  Note that no validation is 
+   * performed on the <code>operation</code> code, any integer will be 
+   * accepted (nevertheless, you should pass in one of the listed values).
+   *
+   * @param operation  one of [EMAIL PROTECTED] 
WindowConstants#DO_NOTHING_ON_CLOSE}, 
+   *   [EMAIL PROTECTED] WindowConstants#HIDE_ON_CLOSE} or 
+   *   [EMAIL PROTECTED] WindowConstants#DISPOSE_ON_CLOSE}.
+   *   
+   * @see #getDefaultCloseOperation()
+   * @see #doDefaultCloseAction()
    */
   public void setDefaultCloseOperation(int operation)
   {