diff options
author | Wolfgang Baer <WBaer@gmx.de> | 2005-11-15 16:16:27 +0000 |
---|---|---|
committer | Wolfgang Baer <WBaer@gmx.de> | 2005-11-15 16:16:27 +0000 |
commit | 90e44b1b2cb9d112ca7747c6330f19fe76437c52 (patch) | |
tree | 31b01c7954900b417893828c67576d00e21fd143 | |
parent | 3b6e4355edea1be3e5f60627cda1303bd1145c76 (diff) | |
download | classpath-libgcj-import-20051115.tar.gz |
2005-11-15 Wolfgang Baer <WBaer@gmx.de>libgcj-import-20051115
* 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.
-rw-r--r-- | ChangeLog | 8 | ||||
-rw-r--r-- | javax/print/attribute/DateTimeSyntax.java | 16 | ||||
-rw-r--r-- | javax/print/attribute/EnumSyntax.java | 4 | ||||
-rw-r--r-- | javax/print/attribute/IntegerSyntax.java | 25 | ||||
-rw-r--r-- | javax/print/attribute/URISyntax.java | 18 |
5 files changed, 46 insertions, 25 deletions
@@ -1,3 +1,11 @@ +2005-11-15 Wolfgang Baer <WBaer@gmx.de> + + * 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. + 2005-11-15 Lillian Angel <langel@redhat.com> * gnu/java/awt/peer/gtk/GtkComponentPeer.java diff --git a/javax/print/attribute/DateTimeSyntax.java b/javax/print/attribute/DateTimeSyntax.java index 0e583e0b9..d59193265 100644 --- a/javax/print/attribute/DateTimeSyntax.java +++ b/javax/print/attribute/DateTimeSyntax.java @@ -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.io.Serializable; 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 (konqueror@gmx.de) */ public abstract class DateTimeSyntax implements Cloneable, Serializable { @@ -52,7 +55,7 @@ public abstract class DateTimeSyntax implements Cloneable, Serializable /** * 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 @@ public abstract class DateTimeSyntax implements Cloneable, Serializable /** * Returns the date value of this object. * - * @return the date value + * @return The date value. */ public Date getValue() { @@ -79,7 +82,8 @@ public abstract class DateTimeSyntax implements Cloneable, Serializable * * @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 @@ public abstract class DateTimeSyntax implements Cloneable, Serializable /** * Returns the hashcode for this object. * - * @return the hashcode + * @return The hashcode. */ public int hashCode() { diff --git a/javax/print/attribute/EnumSyntax.java b/javax/print/attribute/EnumSyntax.java index de0e5ebf3..9a5e62d45 100644 --- a/javax/print/attribute/EnumSyntax.java +++ b/javax/print/attribute/EnumSyntax.java @@ -42,8 +42,8 @@ import java.io.ObjectStreamException; 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. diff --git a/javax/print/attribute/IntegerSyntax.java b/javax/print/attribute/IntegerSyntax.java index d5500b4ca..c2f9224a2 100644 --- a/javax/print/attribute/IntegerSyntax.java +++ b/javax/print/attribute/IntegerSyntax.java @@ -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 @@ package javax.print.attribute; 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 (konqueror@gmx.de) */ public abstract class IntegerSyntax implements Cloneable, Serializable { @@ -49,7 +52,7 @@ public abstract class IntegerSyntax implements Cloneable, Serializable /** * 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 @@ public abstract class IntegerSyntax implements Cloneable, Serializable } /** - * 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 @@ public abstract class IntegerSyntax implements Cloneable, Serializable /** * Returns the value of this object. * - * @return the value + * @return The integer value. */ public int getValue() { @@ -86,11 +90,12 @@ public abstract class IntegerSyntax implements Cloneable, Serializable } /** - * 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 @@ public abstract class IntegerSyntax implements Cloneable, Serializable /** * Returns the hashcode for this object. * - * @return the hashcode + * @return The hashcode. */ public int hashCode() { @@ -113,7 +118,7 @@ public abstract class IntegerSyntax implements Cloneable, Serializable /** * Returns the string representation for this object. * - * @return the string representation + * @return The string representation. */ public String toString() { diff --git a/javax/print/attribute/URISyntax.java b/javax/print/attribute/URISyntax.java index f0583f7e5..07deb4b57 100644 --- a/javax/print/attribute/URISyntax.java +++ b/javax/print/attribute/URISyntax.java @@ -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.io.Serializable; 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 (konqueror@gmx.de) */ public abstract class URISyntax implements Cloneable, Serializable @@ -66,11 +69,12 @@ public abstract class URISyntax } /** - * 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 @@ public abstract class URISyntax /** * Returns the URI value of this syntax object. * - * @return the URI + * @return The URI. */ public URI getURI() { @@ -93,7 +97,7 @@ public abstract class URISyntax /** * Returns the hashcode for this object. * - * @return the hashcode + * @return The hashcode. */ public int hashCode() { @@ -103,7 +107,7 @@ public abstract class URISyntax /** * Returns the string representation for this object. * - * @return the string representation + * @return The string representation. */ public String toString() { |