ggregory 2003/04/08 18:04:48
Modified: lang/src/java/org/apache/commons/lang NumberUtils.java
ArrayUtils.java
lang/src/java/org/apache/commons/lang/math NumberRange.java
lang/src/java/org/apache/commons/lang/util
IdentifierUtils.java
lang/src/java/org/apache/commons/lang/time
CalendarUtils.java
Log:
Fix some Javadoc {@link}s and clean up some Javadoc comments to remove warnings generated
when Javadoc from Java 1.4.1 is used.
FYI, warnings like: This sentence is different from what will be interpreted as the first
sentence in the
next major release (when that interpretation will be internationalized), which is: <snip/>
Revision Changes Path
1.8 +2 -2 jakarta-commons/lang/src/java/org/apache/commons/lang/NumberUtils.java
Index: NumberUtils.java
===================================================================
RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/NumberUtils.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- NumberUtils.java 23 Mar 2003 18:00:59 -0000 1.7
+++ NumberUtils.java 9 Apr 2003 01:04:47 -0000 1.8
@@ -56,7 +56,7 @@
import java.math.BigInteger;
import java.math.BigDecimal;
/**
- * <p>Provides extra functionality for Java Number classes</p>.
+ * <p>Provides extra functionality for Java Number classes.</p>
*
* @author <a href="mailto:bayard@generationjava.com">Henri Yandell</a>
* @author <a href="mailto:rand_mcneely@yahoo.com">Rand McNeely</a>
1.11 +5 -5 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.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- ArrayUtils.java 23 Mar 2003 17:57:42 -0000 1.10
+++ ArrayUtils.java 9 Apr 2003 01:04:47 -0000 1.11
@@ -170,8 +170,8 @@
//-----------------------------------------------------------------------
/**
- * <p>Converts the given array into a {@link Map}. Each element of the array
- * must be either a {@link Map.Entry} or an Array, containing at least two
+ * <p>Converts the given array into a {@link java.util.Map}. Each element of
the array
+ * must be either a {@link java.util.Map.Entry} or an Array, containing at least two
* elements, where the first element is used as key and the second as
* value.</p>
*
@@ -184,14 +184,14 @@
* {"BLUE", "#0000FF"}});
* </pre>
*
- * @param array an array whose elements are either a {@link Map.Entry} or
+ * @param array an array whose elements are either a {@link java.util.Map.Entry} or
* an Array containing at least two elements
* @return a <code>Map</code> that was created from the array
* @throws IllegalArgumentException if the array is <code>null</code>
* @throws IllegalArgumentException if one element of this Array is
* itself an Array containing less then two elements
* @throws IllegalArgumentException if the array contains elements other
- * than {@link Map.Entry} and an Array
+ * than {@link java.util.Map.Entry} and an Array
*/
public static Map toMap(Object[] array) {
if (array == null) {
1.3 +2 -2 jakarta-commons/lang/src/java/org/apache/commons/lang/math/NumberRange.java
Index: NumberRange.java
===================================================================
RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/math/NumberRange.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NumberRange.java 23 Mar 2003 17:51:15 -0000 1.2
+++ NumberRange.java 9 Apr 2003 01:04:47 -0000 1.3
@@ -110,7 +110,7 @@
* minimum and maximum numbers (both inclusive).</p>
*
* <p>The arguments may be passed in the order (min,max) or (max,min). The
- * {@link #getMinimum()} and {@link #getMaximum()} methods will return the
+ * {@link #getMinimumNumber()} and {@link #getMaximumNumber()} methods will return
the
* correct value.</p>
*
* <p>This constructor is designed to be used with two <code>Number</code>
1.4 +3 -3 jakarta-commons/lang/src/java/org/apache/commons/lang/util/IdentifierUtils.java
Index: IdentifierUtils.java
===================================================================
RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/util/IdentifierUtils.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- IdentifierUtils.java 23 Mar 2003 17:52:25 -0000 1.3
+++ IdentifierUtils.java 9 Apr 2003 01:04:48 -0000 1.4
@@ -502,8 +502,8 @@
*/
private static final long MAX_RANDOM_LEN = 2176782336L; // 36 ** 6
/**
- * The identifier must be unique within the typical lifespan of a
- * session; the value can roll over after that. 3 characters:
+ * <p>The identifier must be unique within the typical lifespan of a
+ * session; the value can roll over after that.</p>3 characters:
* (this means a roll over after over a day, which is much larger
* than a typical lifespan).
*/
1.3 +3 -3 jakarta-commons/lang/src/java/org/apache/commons/lang/time/CalendarUtils.java
Index: CalendarUtils.java
===================================================================
RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/time/CalendarUtils.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CalendarUtils.java 4 Feb 2003 22:19:33 -0000 1.2
+++ CalendarUtils.java 9 Apr 2003 01:04:48 -0000 1.3
@@ -269,14 +269,14 @@
}
/**
- * Parses strings the way that CVS supports it... very human readable
+ * Parses strings the way that CVS supports it (very human readable).
*/
public static Calendar parse(String original) {
return parse(original, Locale.getDefault());
}
/**
- * Parses strings the way that CVS supports it... very human readable
+ * Parses strings the way that CVS supports it (very human readable).
*/
public static Calendar parse(String original, Locale locale) {
//Get the symbol names
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
|