[cp-patches] FYI: API docs update javax.print.attribute

[Wolfgang Baer]

Hi,

this adds and enhances some api docs for some classes
in javax.print.attribute.

2005-11-13  Wolfgang Baer  <address@hidden>

        * javax/print/attribute/HashDocAttributeSet.java,
        * javax/print/attribute/HashPrintJobAttributeSet.java,
        * javax/print/attribute/HashPrintRequestAttributeSet.java,
        * javax/print/attribute/HashPrintServiceAttributeSet.java,
        Added class api docs and enhanced method api docs.

Regards,
Wolfgang

        

Index: ChangeLog
===================================================================
RCS file: /cvsroot/classpath/classpath/ChangeLog,v
retrieving revision 1.5565
diff -u -r1.5565 ChangeLog
--- ChangeLog   13 Nov 2005 17:36:10 -0000      1.5565
+++ ChangeLog   13 Nov 2005 18:56:12 -0000
@@ -1,3 +1,11 @@
+2005-11-13  Wolfgang Baer  <address@hidden>
+
+       * javax/print/attribute/HashDocAttributeSet.java,
+       * javax/print/attribute/HashPrintJobAttributeSet.java,
+       * javax/print/attribute/HashPrintRequestAttributeSet.java,
+       * javax/print/attribute/HashPrintServiceAttributeSet.java,
+       Added class api docs and enhanced method api docs.
+
 2005-11-13  Tom Tromey  <address@hidden>
 
        * native/jni/midi-dssi/.cvsignore: Updated.
Index: javax/print/attribute/HashDocAttributeSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/HashDocAttributeSet.java,v
retrieving revision 1.2
diff -u -r1.2 HashDocAttributeSet.java
--- javax/print/attribute/HashDocAttributeSet.java      2 Jul 2005 20:32:46 
-0000       1.2
+++ javax/print/attribute/HashDocAttributeSet.java      13 Nov 2005 18:56:12 
-0000
@@ -1,5 +1,5 @@
 /* HashDocAttributeSet.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -39,6 +39,10 @@
 
 import java.io.Serializable;
 
+/**
+ * <code>HashDocAttributeSet</code> provides an implementation of
+ * address@hidden javax.print.attribute.DocAttributeSet}.
+ */
 public class HashDocAttributeSet extends HashAttributeSet
   implements DocAttributeSet, Serializable
 {
@@ -56,7 +60,7 @@
    * Creates a <code>HashDocAttributeSet</code> object with the given
    * attribute in it.
    *
-   * @param attribute the attriute tu put into the attribute set
+   * @param attribute the attribute to put into the attribute set
    *
    * @exception NullPointerException if attribute is null
    */
@@ -69,9 +73,11 @@
    * Creates a <code>HashDocAttributeSet</code> object with the given
    * attributes in it.
    *
-   * @param attributes the attributes to put into the attribute set
+   * @param attributes the array of attributes to put into the set. If
+   * <code>null</code> an empty set is created.
    *
-   * @exception NullPointerException if attributes is null
+   * @exception NullPointerException if one of the attributes of the given
+   * array is null.
    */
   public HashDocAttributeSet(DocAttribute[] attributes)
   {
@@ -79,11 +85,11 @@
   }
 
   /**
-   * Creates a <code>HashDocAttributeSet</code> object with the given
-   * attributes in it.
-   *
-   * @param attributes the attributes to put into the attribute set
+   * Creates a <code>HashDocAttributeSet</code> object with the attributes
+   * of the given attributes set in it.
    *
+   * @param attributes the attributes set to put into the set. If 
+   * <code>null</code> an empty set is created.
    * @exception ClassCastException if any element of attributes is not
    * an instance of <code>DocAttribute</code>
    */
Index: javax/print/attribute/HashPrintJobAttributeSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/HashPrintJobAttributeSet.java,v
retrieving revision 1.2
diff -u -r1.2 HashPrintJobAttributeSet.java
--- javax/print/attribute/HashPrintJobAttributeSet.java 2 Jul 2005 20:32:46 
-0000       1.2
+++ javax/print/attribute/HashPrintJobAttributeSet.java 13 Nov 2005 18:56:12 
-0000
@@ -1,5 +1,5 @@
 /* HashPrintJobAttributeSet.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -39,6 +39,10 @@
 
 import java.io.Serializable;
 
+/**
+ * <code>HashPrintJobAttributeSet</code> provides an implementation of
+ * address@hidden javax.print.attribute.PrintJobAttributeSet}.
+ */
 public class HashPrintJobAttributeSet extends HashAttributeSet
   implements Serializable, PrintJobAttributeSet
 {
@@ -56,7 +60,7 @@
    * Creates a <code>HashPrintJobAttributeSet</code> object with the given
    * attribute in it.
    *
-   * @param attribute the attriute tu put into the attribute set
+   * @param attribute the attribute to put into the attribute set
    *
    * @exception NullPointerException if attribute is null
    */
@@ -69,9 +73,11 @@
    * Creates a <code>HashPrintJobAttributeSet</code> object with the given
    * attributes in it.
    *
-   * @param attributes the attributes to put into the attribute set
+   * @param attributes the array of attributes to put into the set. If
+   * <code>null</code> an empty set is created.
    *
-   * @exception NullPointerException if attributes is null
+   * @exception NullPointerException if one of the attributes of the given
+   * array is null.
    */
   public HashPrintJobAttributeSet(PrintJobAttribute[] attributes)
   {
@@ -79,11 +85,11 @@
   }
   
   /**
-   * Creates a <code>HashPrintJobAttributeSet</code> object with the given
-   * attributes in it.
-   *
-   * @param attributes the attributes to put into the attribute set
+   * Creates a <code>HashPrintJobAttributeSet</code> object with the attributes
+   * of the given attributes set in it.
    *
+   * @param attributes the attributes set to put into the set. If 
+   * <code>null</code> an empty set is created.
    * @exception ClassCastException if any element of attributes is not
    * an instance of <code>PrintJobAttribute</code>
    */
Index: javax/print/attribute/HashPrintRequestAttributeSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/HashPrintRequestAttributeSet.java,v
retrieving revision 1.2
diff -u -r1.2 HashPrintRequestAttributeSet.java
--- javax/print/attribute/HashPrintRequestAttributeSet.java     2 Jul 2005 
20:32:46 -0000       1.2
+++ javax/print/attribute/HashPrintRequestAttributeSet.java     13 Nov 2005 
18:56:12 -0000
@@ -1,5 +1,5 @@
 /* HashPrintRequestAttributeSet.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -39,6 +39,10 @@
 
 import java.io.Serializable;
 
+/**
+ * <code>HashPrintRequestAttributeSet</code> provides an implementation of
+ * address@hidden javax.print.attribute.PrintRequestAttributeSet}.
+ */
 public class HashPrintRequestAttributeSet extends HashAttributeSet
   implements Serializable, PrintRequestAttributeSet
 {
@@ -56,7 +60,7 @@
    * Creates a <code>HashPrintRequestAttributeSet</code> object with the given
    * attribute in it.
    *
-   * @param attribute the attriute tu put into the attribute set
+   * @param attribute the attribute to put into the attribute set
    *
    * @exception NullPointerException if attribute is null
    */
@@ -69,9 +73,11 @@
    * Creates a <code>HashPrintRequestAttributeSet</code> object with the given
    * attributes in it.
    *
-   * @param attributes the attributes to put into the attribute set
+   * @param attributes the array of attributes to put into the set. If
+   * <code>null</code> an empty set is created.
    *
-   * @exception NullPointerException if attributes is null
+   * @exception NullPointerException if one of the attributes of the given
+   * array is null.
    */
   public HashPrintRequestAttributeSet(PrintRequestAttribute[] attributes)
   {
@@ -79,11 +85,11 @@
   }
   
   /**
-   * Creates a <code>HashPrintRequestAttributeSet</code> object with the given
-   * attributes in it.
-   *
-   * @param attributes the attributes to put into the attribute set
+   * Creates a <code>HashPrintRequestAttributeSet</code> object with the 
attributes
+   * of the given attributes set in it.
    *
+   * @param attributes the attributes set to put into the set. If 
+   * <code>null</code> an empty set is created.
    * @exception ClassCastException if any element of attributes is not
    * an instance of <code>PrintRequestAttribute</code>
    */
Index: javax/print/attribute/HashPrintServiceAttributeSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/HashPrintServiceAttributeSet.java,v
retrieving revision 1.2
diff -u -r1.2 HashPrintServiceAttributeSet.java
--- javax/print/attribute/HashPrintServiceAttributeSet.java     2 Jul 2005 
20:32:46 -0000       1.2
+++ javax/print/attribute/HashPrintServiceAttributeSet.java     13 Nov 2005 
18:56:12 -0000
@@ -1,5 +1,5 @@
 /* HashPrintServiceAttributeSet.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -39,6 +39,10 @@
 
 import java.io.Serializable;
 
+/**
+ * <code>HashPrintServiceAttributeSet</code> provides an implementation of
+ * address@hidden javax.print.attribute.PrintServiceAttributeSet}.
+ */
 public class HashPrintServiceAttributeSet extends HashAttributeSet
   implements Serializable, PrintServiceAttributeSet
 {
@@ -56,7 +60,7 @@
    * Creates a <code>HashPrintServiceAttributeSet</code> object with the given
    * attribute in it.
    *
-   * @param attribute the attriute tu put into the attribute set
+   * @param attribute the attribute to put into the attribute set
    *
    * @exception NullPointerException if attribute is null
    */
@@ -69,9 +73,11 @@
    * Creates a <code>HashPrintServiceAttributeSet</code> object with the given
    * attributes in it.
    *
-   * @param attributes the attributes to put into the attribute set
+   * @param attributes the array of attributes to put into the set. If
+   * <code>null</code> an empty set is created.
    *
-   * @exception NullPointerException if attributes is null
+   * @exception NullPointerException if one of the attributes of the given
+   * array is null.
    */
   public HashPrintServiceAttributeSet(PrintServiceAttribute[] attributes)
   {
@@ -79,11 +85,11 @@
   }
   
   /**
-   * Creates a <code>HashPrintServiceAttributeSet</code> object with the given
-   * attributes in it.
-   *
-   * @param attributes the attributes to put into the attribute set
+   * Creates a <code>HashPrintServiceAttributeSet</code> object with the 
attributes
+   * of the given attributes set in it.
    *
+   * @param attributes the attributes set to put into the set. If 
+   * <code>null</code> an empty set is created.
    * @exception ClassCastException if any element of attributes is not
    * an instance of <code>PrintServiceAttribute</code>
    */