[cp-patches] FYI: API docs for javax.swing.text.MutableAttributeSet.java

[David Gilbert]

I committed this patch:

2006-01-16  David Gilbert  <address@hidden>

        * javax/swing/text/MutableAttributeSet.java: Updated API docs all over.

Regards,

Dave

Index: javax/swing/text/MutableAttributeSet.java
===================================================================
RCS file: 
/sources/classpath/classpath/javax/swing/text/MutableAttributeSet.java,v
retrieving revision 1.5
diff -u -r1.5 MutableAttributeSet.java
--- javax/swing/text/MutableAttributeSet.java   2 Jul 2005 20:32:51 -0000       
1.5
+++ javax/swing/text/MutableAttributeSet.java   16 Jan 2006 10:10:56 -0000
@@ -1,5 +1,5 @@
 /* MutableAttributeSet.java --
-   Copyright (C) 2002, 2004 Free Software Foundation, Inc.
+   Copyright (C) 2002, 2004, 2006 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -40,46 +40,78 @@
 import java.util.Enumeration;
 
 /**
- * MutableAttributeSet
+ * An address@hidden AttributeSet} that supports modification of the stored 
+ * attributes.
+ * 
  * @author     Andrew Selkirk
- * @version    1.0
+ * @since 1.2
  */
 public interface MutableAttributeSet extends AttributeSet
 {
   /**
-   * addAttribute
-   * @param name TODO
-   * @param value TODO
+   * Adds an attribute with the given <code>name</code> and <code>value</code>
+   * to the set.  If the set already contains an attribute with the given
+   * <code>name</code>, the attribute value is updated.
+   * 
+   * @param name  the attribute name (<code>null</code> not permitted).
+   * @param value  the value (<code>null</code> not permitted).
+   * 
+   * @throws NullPointerException if either argument is <code>null</code>.
    */
   void addAttribute(Object name, Object value);
 
   /**
-   * addAttributes
-   * @param attributes TODO
+   * Adds all the attributes from <code>attributes</code> to this set.
+   * 
+   * @param attributes  the set of attributes to add (<code>null</code> not
+   *                    permitted).
+   *                    
+   * @throws NullPointerException if <code>attributes</code> is 
+   *         <code>null</code>.
    */
   void addAttributes(AttributeSet attributes);
 
   /**
-   * removeAttribute
-   * @param name TODO
+   * Removes the attribute with the specified <code>name</code>, if this 
+   * attribute is defined.  This method will only remove an attribute from
+   * this set, not from the resolving parent.
+   * 
+   * @param name  the attribute name (<code>null</code> not permitted).
+   * 
+   * @throws NullPointerException if <code>name</code> is <code>null</code>.
    */
   void removeAttribute(Object name);
 
   /**
-   * removeAttributes
-   * @param names TODO
+   * Removes the attributes listed in <code>names</code>.
+   * 
+   * @param names  the attribute names (<code>null</code> not permitted).
+   * 
+   * @throws NullPointerException if <code>names</code> is <code>null</code> 
+   *         or contains any <code>null</code> values.
    */
   void removeAttributes(Enumeration names);
 
   /**
-   * removeAttributes
-   * @param attributes TODO
+   * Removes attributes from this set if they are found in the 
+   * given set.  Only attributes whose key AND value are removed.
+   * Removes attributes only from this set, not from the resolving parent.  
+   * Since the resolving parent is stored as an attribute, if 
+   * <code>attributes</code> has the same resolving parent as this set, the
+   * parent will be removed from this set.
+   * 
+   * @param attributes  the attributes (<code>null</code> not permitted).
    */
   void removeAttributes(AttributeSet attributes);
 
   /**
-   * setResolveParent
-   * @param parent TODO
+   * Sets the reolving parent for this set.  When looking up an attribute, if
+   * it is not found in this set, then the resolving parent is also used for
+   * the lookup. 
+   * 
+   * @param parent  the parent attribute set (<code>null</code> not permitted).
+   * 
+   * @throws NullPointerException if <code>parent</code> is <code>null</code>.
    */
   void setResolveParent(AttributeSet parent);
 }