From e5c8e4a225d133d525f41f497257d9f127c6a9ab Mon Sep 17 00:00:00 2001 From: "Gary D. Gregory" Date: Wed, 9 Apr 2003 01:04:48 +0000 Subject: [PATCH] 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: git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137287 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/commons/lang/ArrayUtils.java | 10 +++++----- src/java/org/apache/commons/lang/NumberUtils.java | 4 ++-- src/java/org/apache/commons/lang/math/NumberRange.java | 4 ++-- .../org/apache/commons/lang/time/CalendarUtils.java | 6 +++--- .../org/apache/commons/lang/util/IdentifierUtils.java | 6 +++--- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/java/org/apache/commons/lang/ArrayUtils.java b/src/java/org/apache/commons/lang/ArrayUtils.java index 617a0859d..90f93f4e0 100644 --- a/src/java/org/apache/commons/lang/ArrayUtils.java +++ b/src/java/org/apache/commons/lang/ArrayUtils.java @@ -69,7 +69,7 @@ * @author Fredrik Westermarck * @author Nikolay Metchev * @since 2.0 - * @version $Id: ArrayUtils.java,v 1.10 2003/03/23 17:57:42 scolebourne Exp $ + * @version $Id: ArrayUtils.java,v 1.11 2003/04/09 01:04:47 ggregory Exp $ */ public class ArrayUtils { @@ -170,8 +170,8 @@ public static boolean isEquals(Object array1, Object array2) { //----------------------------------------------------------------------- /** - *

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 + *

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.

* @@ -184,14 +184,14 @@ public static boolean isEquals(Object array1, Object array2) { * {"BLUE", "#0000FF"}}); * * - * @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 Map that was created from the array * @throws IllegalArgumentException if the array is null * @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) { diff --git a/src/java/org/apache/commons/lang/NumberUtils.java b/src/java/org/apache/commons/lang/NumberUtils.java index b052b8070..68f59bb4d 100644 --- a/src/java/org/apache/commons/lang/NumberUtils.java +++ b/src/java/org/apache/commons/lang/NumberUtils.java @@ -56,14 +56,14 @@ import java.math.BigInteger; import java.math.BigDecimal; /** - *

Provides extra functionality for Java Number classes

. + *

Provides extra functionality for Java Number classes.

* * @author Henri Yandell * @author Rand McNeely * @author Stephen Colebourne * @author Steve Downey * @since 1.0 - * @version $Id: NumberUtils.java,v 1.7 2003/03/23 18:00:59 scolebourne Exp $ + * @version $Id: NumberUtils.java,v 1.8 2003/04/09 01:04:47 ggregory Exp $ */ public final class NumberUtils { diff --git a/src/java/org/apache/commons/lang/math/NumberRange.java b/src/java/org/apache/commons/lang/math/NumberRange.java index b76ce1647..894904cd6 100644 --- a/src/java/org/apache/commons/lang/math/NumberRange.java +++ b/src/java/org/apache/commons/lang/math/NumberRange.java @@ -62,7 +62,7 @@ * @author Christopher Elkins * @author Stephen Colebourne * @since 2.0 (previously in org.apache.commons.lang) - * @version $Id: NumberRange.java,v 1.2 2003/03/23 17:51:15 scolebourne Exp $ + * @version $Id: NumberRange.java,v 1.3 2003/04/09 01:04:47 ggregory Exp $ */ public final class NumberRange extends Range implements Serializable { @@ -110,7 +110,7 @@ public NumberRange(Number num) { * minimum and maximum numbers (both inclusive).

* *

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.

* *

This constructor is designed to be used with two Number diff --git a/src/java/org/apache/commons/lang/time/CalendarUtils.java b/src/java/org/apache/commons/lang/time/CalendarUtils.java index d85c0f527..5b93c8932 100644 --- a/src/java/org/apache/commons/lang/time/CalendarUtils.java +++ b/src/java/org/apache/commons/lang/time/CalendarUtils.java @@ -61,7 +61,7 @@ * * @author Serge Knystautas * @since 2.1 - * @version $Id: CalendarUtils.java,v 1.2 2003/02/04 22:19:33 scolebourne Exp $ + * @version $Id: CalendarUtils.java,v 1.3 2003/04/09 01:04:48 ggregory Exp $ */ public class CalendarUtils { @@ -269,14 +269,14 @@ private static void modify(Calendar val, int field, boolean round) { } /** - * 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 diff --git a/src/java/org/apache/commons/lang/util/IdentifierUtils.java b/src/java/org/apache/commons/lang/util/IdentifierUtils.java index 237eaf9cd..98a955c0d 100644 --- a/src/java/org/apache/commons/lang/util/IdentifierUtils.java +++ b/src/java/org/apache/commons/lang/util/IdentifierUtils.java @@ -68,7 +68,7 @@ * * @author Stephen Colebourne * @since 2.0 - * @version $Id: IdentifierUtils.java,v 1.3 2003/03/23 17:52:25 scolebourne Exp $ + * @version $Id: IdentifierUtils.java,v 1.4 2003/04/09 01:04:48 ggregory Exp $ */ public class IdentifierUtils { @@ -502,8 +502,8 @@ private static class StringSessionIdentifierFactory implements Factory, Serializ */ 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: + *

The identifier must be unique within the typical lifespan of a + * session; the value can roll over after that.

3 characters: * (this means a roll over after over a day, which is much larger * than a typical lifespan). */