[cp-patches] FYI: Api docs updates for TextSyntax derived printing attributes

[Wolfgang Baer]

Hi,

this time only api doc additions and updates to complete
the TextSyntax derived printing attributes.

Regards,
Wolfgang

2005-12-18  Wolfgang Baer  <address@hidden>

        * javax/print/attribute/standard/JobOriginatingUserName.java,
        * javax/print/attribute/standard/RequestingUserName.java,
        * javax/print/attribute/standard/JobMessageFromOperator.java,
        * javax/print/attribute/standard/JobName.java,
        * javax/print/attribute/standard/OutputDeviceAssigned.java,
        * javax/print/attribute/standard/PrinterInfo.java,
        * javax/print/attribute/standard/PrinterLocation.java,
        * javax/print/attribute/standard/PrinterMakeAndModel.java,
        * javax/print/attribute/standard/PrinterMessageFromOperator.java,
        * javax/print/attribute/standard/DocumentName.java,
        * javax/print/attribute/standard/PrinterName.java:
        Added and updated javadocs to class and methods.

Index: javax/print/attribute/standard/JobOriginatingUserName.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobOriginatingUserName.java,v
retrieving revision 1.5
diff -u -r1.5 JobOriginatingUserName.java
--- javax/print/attribute/standard/JobOriginatingUserName.java  2 Jul 2005 
20:32:46 -0000       1.5
+++ javax/print/attribute/standard/JobOriginatingUserName.java  18 Dec 2005 
11:52:55 -0000
@@ -1,5 +1,5 @@
 /* JobOriginatingUserName.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,12 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>JobOriginatingUserName</code> attribute specifies the name of 
+ * the user which submitted the print job.
+ * <p>
+ * <b>IPP Compatibility:</b> JobOriginatingUserName is an IPP 1.1 attribute.
+ * </p>
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class JobOriginatingUserName extends TextSyntax
@@ -55,8 +61,10 @@
    * Creates a <code>JobOriginatingUserName</code> object.
    *
    * @param userName the user name
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if userName is null
+   * @exception NullPointerException if userName is <code>null</code>.
    */
   public JobOriginatingUserName(String userName, Locale locale)
   {
@@ -64,11 +72,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -81,7 +90,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>JobOriginatingUserName</code> itself
+   * @return The class <code>JobOriginatingUserName</code> itself.
    */
   public Class getCategory()
   {
@@ -89,9 +98,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "job-originating-user-name"
+   * @return The name "job-originating-user-name".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/RequestingUserName.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/RequestingUserName.java,v
retrieving revision 1.5
diff -u -r1.5 RequestingUserName.java
--- javax/print/attribute/standard/RequestingUserName.java      2 Jul 2005 
20:32:46 -0000       1.5
+++ javax/print/attribute/standard/RequestingUserName.java      18 Dec 2005 
11:52:55 -0000
@@ -1,5 +1,5 @@
 /* RequestingUserName.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,12 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>RequestingUserName</code> attribute provides the name of 
+ * the user which requests the printing of the given job.
+ * <p>
+ * <b>IPP Compatibility:</b> RequestingUserName is an IPP 1.1 attribute.
+ * </p>
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class RequestingUserName extends TextSyntax
@@ -54,10 +60,11 @@
   /**
    * Creates a <code>RequestingUserName</code> object.
    *
-   * @param userName the job name
-   * @param locale the locale of the user, null means default locale
+   * @param userName the user name
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if userName is null
+   * @exception NullPointerException if userName is <code>null</code>.
    */
   public RequestingUserName(String userName, Locale locale)
   {
@@ -65,11 +72,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -82,7 +90,7 @@
   /**
    * Returns category of this attribute.
    *
-   * @return the class <code>RequestingUserName</code> itself
+   * @return The class <code>RequestingUserName</code> itself.
    */
   public Class getCategory()
   {
@@ -90,9 +98,9 @@
   }
 
   /**
-   * Returns name of this attribute.
+   * Returns the name of this attribute.
    *
-   * @return the string "requesting-user-name"
+   * @return The name "requesting-user-name".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/JobMessageFromOperator.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobMessageFromOperator.java,v
retrieving revision 1.5
diff -u -r1.5 JobMessageFromOperator.java
--- javax/print/attribute/standard/JobMessageFromOperator.java  2 Jul 2005 
20:32:46 -0000       1.5
+++ javax/print/attribute/standard/JobMessageFromOperator.java  18 Dec 2005 
11:52:55 -0000
@@ -1,5 +1,5 @@
 /* JobMessageFromOperator.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,15 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>JobMessageFromOperator</code> printing attribute provides 
+ * a message from an operator or a system administrator related to the
+ * print job. This may include information why a certain action has been
+ * taken on the print job like a modification.
+ * <p>
+ * <b>IPP Compatibility:</b> JobMessageFromOperator is an IPP 1.1 
+ * attribute.
+ * </p>
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class JobMessageFromOperator extends TextSyntax
@@ -55,8 +64,10 @@
    * Creates a <code>JobMessageFromOperator</code> object.
    *
    * @param message the message
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if message is null
+   * @exception NullPointerException if message is <code>null</code>.
    */
   public JobMessageFromOperator(String message, Locale locale)
   {
@@ -64,11 +75,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -81,7 +93,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>JobMessageFromOperator</code> itself
+   * @return The class <code>JobMessageFromOperator</code> itself.
    */
   public Class getCategory()
   {
@@ -89,9 +101,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "job-message-from-operator"
+   * @return The name "job-message-from-operator".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/JobName.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobName.java,v
retrieving revision 1.5
diff -u -r1.5 JobName.java
--- javax/print/attribute/standard/JobName.java 2 Jul 2005 20:32:46 -0000       
1.5
+++ javax/print/attribute/standard/JobName.java 18 Dec 2005 11:52:55 -0000
@@ -1,5 +1,5 @@
 /* JobName.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -45,6 +45,12 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>JobName</code> printing attribute provides the name of a 
+ * print job for identification.
+ * <p>
+ * <b>IPP Compatibility:</b> JobName is an IPP 1.1 attribute.
+ * </p>
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class JobName extends TextSyntax
@@ -55,9 +61,11 @@
   /**
    * Creates a <code>JobName</code> object.
    *
-   * @param jobName the job name
+   * @param jobName the job name.
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if jobName is null
+   * @exception NullPointerException if jobName is <code>null</code>.
    */
   public JobName(String jobName, Locale locale)
   {
@@ -65,11 +73,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -82,7 +91,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>JobName</code> itself
+   * @return The class <code>JobName</code> itself.
    */
   public Class getCategory()
   {
@@ -90,9 +99,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "job-name"
+   * @return The name "job-name".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/OutputDeviceAssigned.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/OutputDeviceAssigned.java,v
retrieving revision 1.6
diff -u -r1.6 OutputDeviceAssigned.java
--- javax/print/attribute/standard/OutputDeviceAssigned.java    2 Jul 2005 
20:32:46 -0000       1.6
+++ javax/print/attribute/standard/OutputDeviceAssigned.java    18 Dec 2005 
11:52:55 -0000
@@ -1,5 +1,5 @@
 /* OutputDeviceAssigned.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,18 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>OutputDeviceAssigned</code> printing attribute specifies the
+ * output printer device assigned by a print service to a print job. 
+ * <p>
+ * This may be empty if a print service is embedded in a printer, e.g. is the
+ * output device. However there exist print services with several physical 
+ * output devices (e.g. CUPS classes) where this attribute provides the actual
+ * output device.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> OutputDeviceAssigned is an IPP 1.1 attribute.
+ * </p>
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class OutputDeviceAssigned extends TextSyntax
@@ -54,9 +66,11 @@
   /**
    * Creates a <code>OutputDeviceAssigned</code> object.
    *
-   * @param deviceName the user name
+   * @param deviceName the name of the device.
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if deviceName is null
+   * @exception NullPointerException if deviceName is <code>null</code>.
    */
   public OutputDeviceAssigned(String deviceName, Locale locale)
   {
@@ -64,11 +78,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -81,7 +96,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>OutputDeviceAssigned</code> itself
+   * @return The class <code>OutputDeviceAssigned</code> itself.
    */
   public Class getCategory()
   {
@@ -89,9 +104,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "output-device-assigned"
+   * @return The name "output-device-assigned".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/PrinterInfo.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/PrinterInfo.java,v
retrieving revision 1.4
diff -u -r1.4 PrinterInfo.java
--- javax/print/attribute/standard/PrinterInfo.java     2 Jul 2005 20:32:46 
-0000       1.4
+++ javax/print/attribute/standard/PrinterInfo.java     18 Dec 2005 11:52:55 
-0000
@@ -1,5 +1,5 @@
 /* PrinterInfo.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,12 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>PrinterInfo</code> printing attribute provides 
+ * informations about a printer device.
+ * <p>
+ * <b>IPP Compatibility:</b> PrinterInfo is an IPP 1.1 attribute.
+ * </p>
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class PrinterInfo extends TextSyntax
@@ -55,9 +61,10 @@
    * Creates a <code>PrinterInfo</code> object.
    *
    * @param printerInfo the printer info
-   * @param locale the locale of the info, null means default locale
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if printerInfo is null
+   * @exception NullPointerException if printerInfo is <code>null</code>.
    */
   public PrinterInfo(String printerInfo, Locale locale)
   {
@@ -65,11 +72,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -82,7 +90,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>PrinterInfo</code> itself
+   * @return The class <code>PrinterInfo</code> itself.
    */
   public Class getCategory()
   {
@@ -90,9 +98,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "printer-info"
+   * @return The name "printer-info".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/PrinterLocation.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/PrinterLocation.java,v
retrieving revision 1.4
diff -u -r1.4 PrinterLocation.java
--- javax/print/attribute/standard/PrinterLocation.java 2 Jul 2005 20:32:46 
-0000       1.4
+++ javax/print/attribute/standard/PrinterLocation.java 18 Dec 2005 11:52:55 
-0000
@@ -1,5 +1,5 @@
 /* PrinterLocation.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,12 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>PrinterLocation</code> printing attribute provides the location 
+ * of a printer device. This may be a room and building name for example.
+ * <p>
+ * <b>IPP Compatibility:</b> PrinterLocation is an IPP 1.1 attribute.
+ * </p>
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class PrinterLocation extends TextSyntax
@@ -55,9 +61,10 @@
    * Creates a <code>PrinterLocation</code> object.
    *
    * @param printerLocation the printer location
-   * @param locale the locale of the location, null means default locale
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if printerLocation is null
+   * @exception NullPointerException if printerLocation is <code>null</code>.
    */
   public PrinterLocation(String printerLocation, Locale locale)
   {
@@ -65,11 +72,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -82,7 +90,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>PrinterLocation</code> itself
+   * @return The class <code>PrinterLocation</code> itself.
    */
   public Class getCategory()
   {
@@ -90,9 +98,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "printer-location"
+   * @return The name "printer-location".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/PrinterMakeAndModel.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/PrinterMakeAndModel.java,v
retrieving revision 1.4
diff -u -r1.4 PrinterMakeAndModel.java
--- javax/print/attribute/standard/PrinterMakeAndModel.java     2 Jul 2005 
20:32:46 -0000       1.4
+++ javax/print/attribute/standard/PrinterMakeAndModel.java     18 Dec 2005 
11:52:55 -0000
@@ -1,5 +1,5 @@
 /* PrinterMakeAndModel.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,12 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>PrinterMakeAndModel</code> printing attribute provides the name
+ * of the maker and the model of the printer.
+ * <p>
+ * <b>IPP Compatibility:</b> PrinterMakeAndModel is an IPP 1.1 attribute.
+ * </p>
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class PrinterMakeAndModel extends TextSyntax
@@ -55,9 +61,10 @@
    * Creates a <code>PrinterMakeAndModel</code> object.
    *
    * @param makeAndModel the make and model string
-   * @param locale the locale of the make and model, null means default locale
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if makeAndModel is null
+   * @exception NullPointerException if makeAndModel is <code>null</code>.
    */
   public PrinterMakeAndModel(String makeAndModel, Locale locale)
   {
@@ -65,11 +72,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -82,7 +90,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>PrinterMakeAndModel</code> itself
+   * @return The class <code>PrinterMakeAndModel</code> itself.
    */
   public Class getCategory()
   {
@@ -90,9 +98,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "printer-make-and-model"
+   * @return The name "printer-make-and-model".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/PrinterMessageFromOperator.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/PrinterMessageFromOperator.java,v
retrieving revision 1.4
diff -u -r1.4 PrinterMessageFromOperator.java
--- javax/print/attribute/standard/PrinterMessageFromOperator.java      2 Jul 
2005 20:32:46 -0000       1.4
+++ javax/print/attribute/standard/PrinterMessageFromOperator.java      18 Dec 
2005 11:52:55 -0000
@@ -1,5 +1,5 @@
 /* PrinterMessageFromOperator.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,15 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>PrinterMessageFromOperator</code> printing attribute provides 
+ * a message from an operator or a system administrator related to the 
+ * printer. This may include informations about the status of the printer
+ * or expected downtimes, etc.
+ * <p>
+ * <b>IPP Compatibility:</b> PrinterMessageFromOperator is an IPP 1.1 
+ * attribute.
+ * </p>
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class PrinterMessageFromOperator extends TextSyntax
@@ -55,9 +64,10 @@
    * Creates a <code>PrinterMessageFromOperator</code> object.
    *
    * @param message the message
-   * @param locale the locale of the message, null means default locale
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if message is null
+   * @exception NullPointerException if message is <code>null</code>.
    */
   public PrinterMessageFromOperator(String message, Locale locale)
   {
@@ -65,11 +75,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -82,7 +93,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>PrinterMessageFromOperator</code> itself
+   * @return The class <code>PrinterMessageFromOperator</code> itself.
    */
   public Class getCategory()
   {
@@ -90,9 +101,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "printer-message-from-operator"
+   * @return The name "printer-message-from-operator".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/DocumentName.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/DocumentName.java,v
retrieving revision 1.5
diff -u -r1.5 DocumentName.java
--- javax/print/attribute/standard/DocumentName.java    2 Jul 2005 20:32:46 
-0000       1.5
+++ javax/print/attribute/standard/DocumentName.java    18 Dec 2005 11:52:55 
-0000
@@ -1,5 +1,5 @@
 /* DocumentName.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,18 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>DocumentName</code> printing attribute specifies a document name.
+ * <p>
+ * The document name may be different than the name of the job. It must not be
+ * unique across multiple documents in the same print job. Normally, an 
+ * application provides the document name for the user by using e.g. the file 
+ * name or a name generated automatically by the application.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> DocumentName is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.JobName
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class DocumentName extends TextSyntax
@@ -55,6 +67,8 @@
    * Creates a <code>DocumentName</code> object.
    *
    * @param documentName the document name
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
    * @exception NullPointerException if documentName is null
    */
@@ -64,11 +78,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -81,7 +96,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>DocumentName</code> itself
+   * @return The class <code>DocumentName</code> itself.
    */
   public Class getCategory()
   {
@@ -89,9 +104,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "document-name"
+   * @return The name "document-name".
    */
   public String getName()
   {
Index: javax/print/attribute/standard/PrinterName.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/standard/PrinterName.java,v
retrieving revision 1.4
diff -u -r1.4 PrinterName.java
--- javax/print/attribute/standard/PrinterName.java     2 Jul 2005 20:32:46 
-0000       1.4
+++ javax/print/attribute/standard/PrinterName.java     18 Dec 2005 11:52:55 
-0000
@@ -1,5 +1,5 @@
 /* PrinterName.java -- 
-   Copyright (C) 2004 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -44,6 +44,14 @@
 import javax.print.attribute.TextSyntax;
 
 /**
+ * The <code>PrinterName</code> printing attribute provides the name of a 
+ * print service. The name may but must not be related to parts of the
+ * printer URI.
+ * <p>
+ * <b>IPP Compatibility:</b> PrinterName is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.PrinterURI
+ * 
  * @author Michael Koch (address@hidden)
  */
 public final class PrinterName extends TextSyntax
@@ -55,9 +63,10 @@
    * Creates a <code>PrinterName</code> object.
    *
    * @param printerName the printer name
-   * @param locale the locale of the name, null means default locale
+   * @param locale the locale to use, if <code>null</code> the default
+   * locale is used.
    *
-   * @exception NullPointerException if printerName is null
+   * @exception NullPointerException if printerName is <code>null</code>.
    */
   public PrinterName(String printerName, Locale locale)
   {
@@ -65,11 +74,12 @@
   }
 
   /**
-   * Tests of obj is equal to this object.
+   * Tests if the given object is equal to this object.
    *
    * @param obj the object to test
    *
-   * @return true if both objects are equal, false otherwise.
+   * @return <code>true</code> if both objects are equal, 
+   * <code>false</code> otherwise.
    */
   public boolean equals(Object obj)
   {
@@ -82,7 +92,7 @@
   /**
    * Returns category of this class.
    *
-   * @return the class <code>PrinterName</code> itself
+   * @return The class <code>PrinterName</code> itself.
    */
   public Class getCategory()
   {
@@ -90,9 +100,9 @@
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "printer-name"
+   * @return The name "printer-name".
    */
   public String getName()
   {