[cp-patches] FYI: Api docs additions in javax.print.attribute

[Wolfgang Baer]

Hi,

subjects says all.

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

        * javax/print/attribute/DateTimeSyntax.java,
        * javax/print/attribute/EnumSyntax.java,
        * javax/print/attribute/IntegerSyntax.java,
        * javax/print/attribute/URISyntax.java:
        Added and enhances some api docs.

Regards,
Wolfgang

Index: javax/print/attribute/IntegerSyntax.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/IntegerSyntax.java,v
retrieving revision 1.3
diff -u -r1.3 IntegerSyntax.java
--- javax/print/attribute/IntegerSyntax.java    2 Jul 2005 20:32:46 -0000       
1.3
+++ javax/print/attribute/IntegerSyntax.java    15 Nov 2005 16:15:38 -0000
@@ -1,5 +1,5 @@
 /* IntegerSyntax.java -- 
-   Copyright (C) 2003, 2004  Free Software Foundation, Inc.
+   Copyright (C) 2003, 2004, 2005  Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -40,7 +40,10 @@
 import java.io.Serializable;
 
 /**
- * @author Michael Koch
+ * <code>IntegerSyntax</code> is the abstract base class of all attribute 
+ * classes having an integer as value.
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public abstract class IntegerSyntax implements Cloneable, Serializable
 {
@@ -49,7 +52,7 @@
   /**
    * Creates a <code>IntegerSyntax</code> with the given value.
    *
-   * @param value the value to set
+   * @param value the integer to set
    */
   protected IntegerSyntax(int value)
   {
@@ -57,9 +60,10 @@
   }
 
   /**
-   * Creates a <code>IntegerSyntax</code> with the given arguments.
+   * Creates a <code>IntegerSyntax</code> with the given integer value
+   * and checks if the value lies inside the given bounds..
    *
-   * @param value the value to set
+   * @param value the integer to set
    * @param lowerBound the lower bound for the value
    * @param upperBound the upper bound for the value
    *
@@ -78,7 +82,7 @@
   /**
    * Returns the value of this object.
    *
-   * @return the value
+   * @return The integer value.
    */
   public int getValue()
   {
@@ -86,11 +90,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)
   {
@@ -103,7 +108,7 @@
   /**
    * Returns the hashcode for this object.
    *
-   * @return the hashcode
+   * @return The hashcode.
    */
   public int hashCode()
   {
@@ -113,7 +118,7 @@
   /**
    * Returns the string representation for this object.
    *
-   * @return the string representation
+   * @return The string representation.
    */
   public String toString()
   {
Index: javax/print/attribute/EnumSyntax.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/print/attribute/EnumSyntax.java,v
retrieving revision 1.5
diff -u -r1.5 EnumSyntax.java
--- javax/print/attribute/EnumSyntax.java       13 Nov 2005 10:34:18 -0000      
1.5
+++ javax/print/attribute/EnumSyntax.java       15 Nov 2005 16:15:38 -0000
@@ -42,8 +42,8 @@
 import java.io.Serializable;
 
 /**
- * EnumSyntax is the abstract base class of all enumeration classes in 
- * the Java Print Service API. 
+ * <code>EnumSyntax</code> is the abstract base class of all enumeration
+ * classes in the Java Print Service API. 
  * <p>
  * Every enumeration class which extends from EnumSyntax provides several 
  * enumeration objects as singletons of its class.
Index: javax/print/attribute/URISyntax.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/print/attribute/URISyntax.java,v
retrieving revision 1.2
diff -u -r1.2 URISyntax.java
--- javax/print/attribute/URISyntax.java        2 Jul 2005 20:32:46 -0000       
1.2
+++ javax/print/attribute/URISyntax.java        15 Nov 2005 16:15:38 -0000
@@ -1,5 +1,5 @@
 /* URISyntax.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -41,7 +41,10 @@
 import java.net.URI;
 
 /**
- * @author Michael Koch
+ * <code>URISyntax</code> is the abstract base class of all attribute 
+ * classes having an Uniform Resource Identifier URI as value.
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public abstract class URISyntax
   implements Cloneable, Serializable
@@ -66,11 +69,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
    *
-   * @returns 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)
   {
@@ -83,7 +87,7 @@
   /**
    * Returns the URI value of this syntax object.
    *
-   * @return the URI
+   * @return The URI.
    */
   public URI getURI()
   {
@@ -93,7 +97,7 @@
   /**
    * Returns the hashcode for this object.
    *
-   * @return the hashcode
+   * @return The hashcode.
    */
   public int hashCode()
   {
@@ -103,7 +107,7 @@
   /**
    * Returns the string representation for this object.
    *
-   * @return the string representation
+   * @return The string representation.
    */
   public String toString()
   {
Index: javax/print/attribute/DateTimeSyntax.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/DateTimeSyntax.java,v
retrieving revision 1.2
diff -u -r1.2 DateTimeSyntax.java
--- javax/print/attribute/DateTimeSyntax.java   2 Jul 2005 20:32:46 -0000       
1.2
+++ javax/print/attribute/DateTimeSyntax.java   15 Nov 2005 16:15:38 -0000
@@ -1,5 +1,5 @@
 /* DateTimeSyntax.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -41,7 +41,10 @@
 import java.util.Date;
 
 /**
- * @author Michael Koch
+ * <code>DateTimeSyntax</code> is the abstract base class of all attribute 
+ * classes having a date and a time as value.
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public abstract class DateTimeSyntax implements Cloneable, Serializable
 {
@@ -52,7 +55,7 @@
   /**
    * Creates a <code>DateTimeSyntax</code> with a given value.
    *
-   * @param value the value for this syntax
+   * @param value the date for this syntax
    *
    * @exception NullPointerException if value is null
    */
@@ -67,7 +70,7 @@
   /**
    * Returns the date value of this object.
    *
-   * @return the date value
+   * @return The date value.
    */
   public Date getValue()
   {
@@ -79,7 +82,8 @@
    * 
    * @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)
   {
@@ -92,7 +96,7 @@
   /**
    * Returns the hashcode for this object.
    *
-   * @return the hashcode
+   * @return The hashcode.
    */
   public int hashCode()
   {