ggregory 2003/08/22 10:25:34
Modified: lang/src/java/org/apache/commons/lang RandomStringUtils.java
ObjectUtils.java WordUtils.java StringUtils.java
SerializationUtils.java CharSet.java
CharSetUtils.java BooleanUtils.java CharRange.java
Validate.java ClassUtils.java ArrayUtils.java
Log:
Class Javadoc: Normalize on the active voice, "Returns", "Sets", etc.
The .lang pkg now lists with consistent format in the package level doc too.
Revision Changes Path
1.24 +3 -3
jakarta-commons/lang/src/java/org/apache/commons/lang/RandomStringUtils.java
Index: RandomStringUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/RandomStringUtils.java,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- RandomStringUtils.java 21 Aug 2003 15:52:54 -0000 1.23
+++ RandomStringUtils.java 22 Aug 2003 17:25:33 -0000 1.24
@@ -55,13 +55,13 @@
import java.util.Random;
/**
- * <p>Common random <code>String</code> manipulation routines.</p>
+ * <p>Operations for random <code>String</code>s.</p>
*
* @author GenerationJava Core library
* @author <a href="mailto:[EMAIL PROTECTED]">Henri Yandell</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Steven Caswell</a>
* @author Stephen Colebourne
- * @author <a href="mailto:[EMAIL PROTECTED]">Gary Gregory</a>
+ * @author Gary Gregory
* @author Phil Steitz
* @since 1.0
* @version $Id$
1.21 +3 -3
jakarta-commons/lang/src/java/org/apache/commons/lang/ObjectUtils.java
Index: ObjectUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/ObjectUtils.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- ObjectUtils.java 21 Aug 2003 15:52:54 -0000 1.20
+++ ObjectUtils.java 22 Aug 2003 17:25:33 -0000 1.21
@@ -56,7 +56,7 @@
import java.io.Serializable;
/**
- * <p>Common <code>Object</code> manipulation routines.</p>
+ * <p>Operations on <code>Object</code>.</p>
*
* <p>This class tries to handle <code>null</code> input gracefully.
* An exception will generally not be thrown for a <code>null</code> input.
@@ -66,7 +66,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Janek Bogucki</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Daniel Rall</a>
* @author Stephen Colebourne
- * @author <a href="mailto:[EMAIL PROTECTED]">Gary Gregory</a>
+ * @author Gary Gregory
* @since 1.0
* @version $Id$
*/
1.7 +3 -3
jakarta-commons/lang/src/java/org/apache/commons/lang/WordUtils.java
Index: WordUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/WordUtils.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- WordUtils.java 19 Aug 2003 00:11:20 -0000 1.6
+++ WordUtils.java 22 Aug 2003 17:25:33 -0000 1.7
@@ -54,7 +54,7 @@
package org.apache.commons.lang;
/**
- * <p><code>WordUtils</code> is a utility class to assist with word wrapping.</p>
+ * <p>Assists with word wrapping.</p>
*
* <p>This class tries to handle <code>null</code> input gracefully.
* An exception will not be thrown for a <code>null</code> input.
@@ -64,7 +64,7 @@
* @author Henri Yandell
* @author Stephen Colebourne
* @author <a href="mailto:[EMAIL PROTECTED]">Henning P. Schmiedehausen</a>
- * @author <a href="mailto:[EMAIL PROTECTED]">Gary Gregory</a>
+ * @author Gary Gregory
* @since 2.0
* @version $Id$
*/
1.106 +3 -3
jakarta-commons/lang/src/java/org/apache/commons/lang/StringUtils.java
Index: StringUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/StringUtils.java,v
retrieving revision 1.105
retrieving revision 1.106
diff -u -r1.105 -r1.106
--- StringUtils.java 21 Aug 2003 22:13:24 -0000 1.105
+++ StringUtils.java 22 Aug 2003 17:25:33 -0000 1.106
@@ -58,7 +58,7 @@
import java.util.List;
/**
- * <p>Common [EMAIL PROTECTED] java.lang.String} manipulation routines that are
+ * <p>Operations on [EMAIL PROTECTED] java.lang.String} that are
* <code>null</code> safe.</p>
*
* <ul>
@@ -142,7 +142,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Alexander Day Chaffee</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Henning P. Schmiedehausen</a>
* @author Arun Mammen Thomas
- * @author <a href="mailto:[EMAIL PROTECTED]">Gary Gregory</a>
+ * @author Gary Gregory
* @author Phil Steitz
* @since 1.0
* @version $Id$
1.12 +4 -4
jakarta-commons/lang/src/java/org/apache/commons/lang/SerializationUtils.java
Index: SerializationUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/SerializationUtils.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- SerializationUtils.java 21 Aug 2003 05:35:23 -0000 1.11
+++ SerializationUtils.java 22 Aug 2003 17:25:33 -0000 1.12
@@ -63,9 +63,9 @@
import java.io.Serializable;
/**
- * <p><code>SerializationUtils</code> provides methods that assist with the
- * serialization process, or perform additional functionality based on
serialization.
- * </p><p>
+ * <p>Assists with the serialization process and performs additional functionality
based
+ * on serialization.</p>
+ * <p>
* <ul>
* <li>Deep clone using serialization
* <li>Serialize managing finally and IOException
1.20 +2 -2
jakarta-commons/lang/src/java/org/apache/commons/lang/CharSet.java
Index: CharSet.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/CharSet.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- CharSet.java 21 Aug 2003 05:26:02 -0000 1.19
+++ CharSet.java 22 Aug 2003 17:25:33 -0000 1.20
@@ -63,7 +63,7 @@
/**
* <p>A set of characters.</p>
*
- * <p>This class is immutable, but subclasses may not be.</p>
+ * <p>Instances are immutable, but instances of subclasses may not be.</p>
*
* @author Henri Yandell
* @author Stephen Colebourne
1.26 +3 -2
jakarta-commons/lang/src/java/org/apache/commons/lang/CharSetUtils.java
Index: CharSetUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/CharSetUtils.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- CharSetUtils.java 22 Aug 2003 03:06:36 -0000 1.25
+++ CharSetUtils.java 22 Aug 2003 17:25:33 -0000 1.26
@@ -54,12 +54,13 @@
package org.apache.commons.lang;
/**
- * <p>Numerous routines to manipulate a <code>CharSet</code>.</p>
+ * <p>Operations on <code>CharSet</code>s.</p>
*
* <p>This class handles <code>null</code> input gracefully.
* An exception will not be thrown for a <code>null</code> input.
* Each method documents its behaviour in more detail.</p>
*
+ * @see CharSet
* @author <a href="[EMAIL PROTECTED]">Henri Yandell</a>
* @author Stephen Colebourne
* @author Phil Steitz
1.14 +17 -17
jakarta-commons/lang/src/java/org/apache/commons/lang/BooleanUtils.java
Index: BooleanUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/BooleanUtils.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- BooleanUtils.java 18 Aug 2003 02:22:22 -0000 1.13
+++ BooleanUtils.java 22 Aug 2003 17:25:33 -0000 1.14
@@ -56,8 +56,7 @@
import org.apache.commons.lang.math.NumberUtils;
/**
- * <p><code>BooleanUtils</code> contains utility methods for working for
- * boolean and Boolean objects.</p>
+ * <p>Operations on boolean primitives and Boolean objects.</p>
*
* <p>This class tries to handle <code>null</code> input gracefully.
* An exception will not be thrown for a <code>null</code> input.
@@ -65,6 +64,7 @@
*
* @author Stephen Colebourne
* @author Matthew Hawthorne
+ * @author Gary Gregory
* @since 2.0
* @version $Id$
*/
@@ -143,7 +143,7 @@
// Integer to Boolean methods
//-----------------------------------------------------------------------
/**
- * <p>Convert an int to a boolean using the convention that <code>zero</code>
+ * <p>Converts an int to a boolean using the convention that <code>zero</code>
* is <code>false</code>.</p>
*
* @param value the int to convert
@@ -155,7 +155,7 @@
}
/**
- * <p>Convert an int to a Boolean using the convention that <code>zero</code>
+ * <p>Converts an int to a Boolean using the convention that <code>zero</code>
* is <code>false</code>.</p>
*
* @param value the int to convert
@@ -167,7 +167,7 @@
}
/**
- * <p>Convert an Integer to a Boolean using the convention that
<code>zero</code>
+ * <p>Converts an Integer to a Boolean using the convention that
<code>zero</code>
* is <code>false</code>.</p>
*
* <p><code>null</code> will be converted to <code>null</code>.</p>
@@ -184,7 +184,7 @@
}
/**
- * <p>Convert an int to a boolean specifying the conversion values.</p>
+ * <p>Converts an int to a boolean specifying the conversion values.</p>
*
* @param value the Integer to convert
* @param trueValue the value to match for <code>true</code>
@@ -203,7 +203,7 @@
}
/**
- * <p>Convert an Integer to a boolean specifying the conversion values.</p>
+ * <p>Converts an Integer to a boolean specifying the conversion values.</p>
*
* @param value the Integer to convert
* @param trueValue the value to match for <code>true</code>,
@@ -230,7 +230,7 @@
}
/**
- * <p>Convert an int to a Boolean specifying the conversion values.</p>
+ * <p>Converts an int to a Boolean specifying the conversion values.</p>
*
* @param value the Integer to convert
* @param trueValue the value to match for <code>true</code>
@@ -252,7 +252,7 @@
}
/**
- * <p>Convert an Integer to a Boolean specifying the conversion values.</p>
+ * <p>Converts an Integer to a Boolean specifying the conversion values.</p>
*
* @param value the Integer to convert
* @param trueValue the value to match for <code>true</code>,
@@ -287,7 +287,7 @@
// Boolean to Integer methods
//-----------------------------------------------------------------------
/**
- * <p>Convert a boolean to an int using the convention that
+ * <p>Converts a boolean to an int using the convention that
* <code>zero</code> is <code>false</code>.</p>
*
* @param bool the boolean to convert
@@ -298,7 +298,7 @@
}
/**
- * <p>Convert a boolean to an Integer using the convention that
+ * <p>Converts a boolean to an Integer using the convention that
* <code>zero</code> is <code>false</code>.</p>
*
* @param bool the boolean to convert
@@ -309,7 +309,7 @@
}
/**
- * <p>Convert a Boolean to a Integer using the convention that
+ * <p>Converts a Boolean to a Integer using the convention that
* <code>zero</code> is <code>false</code>.</p>
*
* <p><code>null</code> will be converted to <code>null</code>.</p>
@@ -325,7 +325,7 @@
}
/**
- * <p>Convert a boolean to an int specifying the conversion values.</p>
+ * <p>Converts a boolean to an int specifying the conversion values.</p>
*
* @param bool the to convert
* @param trueValue the value to return if <code>true</code>
@@ -337,7 +337,7 @@
}
/**
- * <p>Convert a Boolean to an int specifying the conversion values.</p>
+ * <p>Converts a Boolean to an int specifying the conversion values.</p>
*
* @param bool the Boolean to convert
* @param trueValue the value to return if <code>true</code>
@@ -353,7 +353,7 @@
}
/**
- * <p>Convert a boolean to an Integer specifying the conversion values.</p>
+ * <p>Converts a boolean to an Integer specifying the conversion values.</p>
*
* @param bool the to convert
* @param trueValue the value to return if <code>true</code>,
@@ -367,7 +367,7 @@
}
/**
- * <p>Convert a Boolean to an Integer specifying the conversion values.</p>
+ * <p>Converts a Boolean to an Integer specifying the conversion values.</p>
*
* @param bool the Boolean to convert
* @param trueValue the value to return if <code>true</code>,
1.15 +3 -2
jakarta-commons/lang/src/java/org/apache/commons/lang/CharRange.java
Index: CharRange.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/CharRange.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- CharRange.java 18 Aug 2003 02:22:22 -0000 1.14
+++ CharRange.java 22 Aug 2003 17:25:33 -0000 1.15
@@ -58,11 +58,12 @@
/**
* <p>A contiguous range of characters, optionally negated.</p>
*
- * <p>This class is immutable.</p>
+ * <p>Instances are immutable.</p>
*
* @author Henri Yandell
* @author Stephen Colebourne
* @author Chris Feldhacker
+ * @author Gary Gregory
* @since 1.0
* @version $Id$
*/
1.5 +4 -3
jakarta-commons/lang/src/java/org/apache/commons/lang/Validate.java
Index: Validate.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/Validate.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Validate.java 19 Aug 2003 02:32:15 -0000 1.4
+++ Validate.java 22 Aug 2003 17:25:33 -0000 1.5
@@ -57,10 +57,10 @@
import java.util.Iterator;
import java.util.Map;
/**
- * <p>Validate is a static utility class for validating arguments.
+ * <p>Assists in alidating arguments.</p>
*
* <p>The class is based along the lines of JUnit. If an argument value is
- * deemed invalid, an IllegalArgumentException is thrown. For example:
+ * deemed invalid, an IllegalArgumentException is thrown. For example:</p>
*
* <pre>
* Validate.isTrue( i > 0, "The value must be greater than zero: ", i);
@@ -69,6 +69,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Ola Berg</a>
* @author Stephen Colebourne
+ * @author Gary Gregory
* @since 2.0
* @version $Id$
*/
1.21 +3 -3
jakarta-commons/lang/src/java/org/apache/commons/lang/ClassUtils.java
Index: ClassUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/ClassUtils.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- ClassUtils.java 18 Aug 2003 02:22:22 -0000 1.20
+++ ClassUtils.java 22 Aug 2003 17:25:33 -0000 1.21
@@ -57,13 +57,13 @@
import java.util.Iterator;
import java.util.List;
/**
- * <p>Provides utility methods for working for classes without using reflection.</p>
+ * <p>Operates on classes without using reflection.</p>
*
* <p>This class handles invalid <code>null</code> inputs as best it can.
* Each method documents its behaviour in more detail.</p>
*
* @author Stephen Colebourne
- * @author <a href="mailto:[EMAIL PROTECTED]">Gary Gregory</a>
+ * @author Gary Gregory
* @since 2.0
* @version $Id$
*/
1.25 +4 -3
jakarta-commons/lang/src/java/org/apache/commons/lang/ArrayUtils.java
Index: ArrayUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/ArrayUtils.java,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- ArrayUtils.java 18 Aug 2003 02:22:22 -0000 1.24
+++ ArrayUtils.java 22 Aug 2003 17:25:33 -0000 1.25
@@ -62,8 +62,8 @@
import org.apache.commons.lang.builder.ToStringStyle;
/**
- * <p><code>ArrayUtils</code> contains utility methods for working with
- * arrays.</p>
+ * <p>Operations on arrays, primitive arrays (like <code>int[]</code>) and
primitive wrapper arrays
+ * (like <code>Integer[]</code>).</p>
*
* <p>This class tries to handle <code>null</code> input gracefully.
* An exception will not be thrown for a <code>null</code>
@@ -77,6 +77,7 @@
* @author Matthew Hawthorne
* @author Tim O'Brien
* @author Pete Gieser
+ * @author Gary Gregory
* @since 2.0
* @version $Id$
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
