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/>


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137287 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2003-04-09 01:04:48 +00:00
parent f810dc3645
commit e5c8e4a225
5 changed files with 15 additions and 15 deletions

View File

@ -69,7 +69,7 @@
* @author <a href="mailto:fredrik@westermarck.com">Fredrik Westermarck</a> * @author <a href="mailto:fredrik@westermarck.com">Fredrik Westermarck</a>
* @author Nikolay Metchev * @author Nikolay Metchev
* @since 2.0 * @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 { public class ArrayUtils {
@ -170,8 +170,8 @@ public static boolean isEquals(Object array1, Object array2) {
//----------------------------------------------------------------------- //-----------------------------------------------------------------------
/** /**
* <p>Converts the given array into a {@link Map}. Each element of the array * <p>Converts the given array into a {@link java.util.Map}. Each element of the array
* must be either a {@link Map.Entry} or an Array, containing at least two * 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 * elements, where the first element is used as key and the second as
* value.</p> * value.</p>
* *
@ -184,14 +184,14 @@ public static boolean isEquals(Object array1, Object array2) {
* {"BLUE", "#0000FF"}}); * {"BLUE", "#0000FF"}});
* </pre> * </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 * an Array containing at least two elements
* @return a <code>Map</code> that was created from the array * @return a <code>Map</code> that was created from the array
* @throws IllegalArgumentException if the array is <code>null</code> * @throws IllegalArgumentException if the array is <code>null</code>
* @throws IllegalArgumentException if one element of this Array is * @throws IllegalArgumentException if one element of this Array is
* itself an Array containing less then two elements * itself an Array containing less then two elements
* @throws IllegalArgumentException if the array contains elements other * @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) { public static Map toMap(Object[] array) {
if (array == null) { if (array == null) {

View File

@ -56,14 +56,14 @@
import java.math.BigInteger; import java.math.BigInteger;
import java.math.BigDecimal; 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:bayard@generationjava.com">Henri Yandell</a>
* @author <a href="mailto:rand_mcneely@yahoo.com">Rand McNeely</a> * @author <a href="mailto:rand_mcneely@yahoo.com">Rand McNeely</a>
* @author Stephen Colebourne * @author Stephen Colebourne
* @author <a href="mailto:steve.downey@netfolio.com">Steve Downey</a> * @author <a href="mailto:steve.downey@netfolio.com">Steve Downey</a>
* @since 1.0 * @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 { public final class NumberUtils {

View File

@ -62,7 +62,7 @@
* @author <a href="mailto:chrise@esha.com">Christopher Elkins</a> * @author <a href="mailto:chrise@esha.com">Christopher Elkins</a>
* @author Stephen Colebourne * @author Stephen Colebourne
* @since 2.0 (previously in org.apache.commons.lang) * @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 { public final class NumberRange extends Range implements Serializable {
@ -110,7 +110,7 @@ public NumberRange(Number num) {
* minimum and maximum numbers (both inclusive).</p> * minimum and maximum numbers (both inclusive).</p>
* *
* <p>The arguments may be passed in the order (min,max) or (max,min). The * <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> * correct value.</p>
* *
* <p>This constructor is designed to be used with two <code>Number</code> * <p>This constructor is designed to be used with two <code>Number</code>

View File

@ -61,7 +61,7 @@
* *
* @author <a href="mailto:sergek@lokitech.com">Serge Knystautas</a> * @author <a href="mailto:sergek@lokitech.com">Serge Knystautas</a>
* @since 2.1 * @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 { 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) { public static Calendar parse(String original) {
return parse(original, Locale.getDefault()); 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) { public static Calendar parse(String original, Locale locale) {
//Get the symbol names //Get the symbol names

View File

@ -68,7 +68,7 @@
* *
* @author Stephen Colebourne * @author Stephen Colebourne
* @since 2.0 * @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 { public class IdentifierUtils {
@ -502,8 +502,8 @@ private static class StringSessionIdentifierFactory implements Factory, Serializ
*/ */
private static final long MAX_RANDOM_LEN = 2176782336L; // 36 ** 6 private static final long MAX_RANDOM_LEN = 2176782336L; // 36 ** 6
/** /**
* The identifier must be unique within the typical lifespan of a * <p>The identifier must be unique within the typical lifespan of a
* session; the value can roll over after that. 3 characters: * session; the value can roll over after that.</p>3 characters:
* (this means a roll over after over a day, which is much larger * (this means a roll over after over a day, which is much larger
* than a typical lifespan). * than a typical lifespan).
*/ */