You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Fredrik Westermarck <fr...@mdh.se> on 2002/11/07 20:08:07 UTC
[lang] [patch] Javadoc
Hi!
I have attached a patch that improves the Javadoc in ArrayUtils,
ClassUtils and StringUtils a little bit.
Re: [lang] [patch] Javadoc
Posted by Stephen Colebourne <sc...@btopenworld.com>.
Patch applied, thanks.
Stephen
----- Original Message -----
From: "Fredrik Westermarck" <fr...@mdh.se>
To: "Jakarta Commons Developers List" <co...@jakarta.apache.org>
Sent: Friday, November 15, 2002 12:17 AM
Subject: Re: [lang] [patch] Javadoc
> Stephen Colebourne wrote:
> > Unfortunately its the patch format thats wrong (Eclipse doesn't like
it).
> > See:
> > http://jakarta.apache.org/commons/patches.html
> >
> > (I think its the -u you're missing)
>
> You're right, I did miss the -u switch. Thats what happens when you try
> to use an GUI-application... :)
>
----------------------------------------------------------------------------
----
> Index: StringUtils.java
> ===================================================================
> RCS file:
/home/cvspublic/jakarta-commons/lang/src/java/org/apache/commons/lang/String
Utils.java,v
> retrieving revision 1.22
> diff -u -r1.22 StringUtils.java
> --- StringUtils.java 14 Nov 2002 22:29:25 -0000 1.22
> +++ StringUtils.java 15 Nov 2002 00:12:53 -0000
> @@ -1527,7 +1527,7 @@
> * Returns either the passed in Object as a String, or,
> * if the Object is <code>null</code>, an empty String.
> *
> - * @param str the Object to check
> + * @param obj the Object to check
> * @return the passed in Object's toString, or blank if it was null
> */
> public static String defaultString(Object obj) {
> Index: ArrayUtils.java
> ===================================================================
> RCS file:
/home/cvspublic/jakarta-commons/lang/src/java/org/apache/commons/lang/ArrayU
tils.java,v
> retrieving revision 1.2
> diff -u -r1.2 ArrayUtils.java
> --- ArrayUtils.java 14 Nov 2002 22:29:25 -0000 1.2
> +++ ArrayUtils.java 15 Nov 2002 00:12:53 -0000
> @@ -397,7 +397,8 @@
> *
> * @param array1 the first array, may be <code>null</code>
> * @param array2 the second array, may be <code>null</code>
> - * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> + * @return <code>true</code> if length of arrays matches, treating
> + * <code>null</code> as an empty array
> */
> public static boolean isSameLength(Object[] array1, Object[] array2)
{
> if ((array1 == null && array2 != null && array2.length > 0) ||
> @@ -415,8 +416,9 @@
> *
> * @param array1 the first array, may be <code>null</code>
> * @param array2 the second array, may be <code>null</code>
> - * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> - */
> + * @return <code>true</code> if length of arrays matches, treating
> + * <code>null</code> as an empty array
> + */
> public static boolean isSameLength(long[] array1, long[] array2) {
> if ((array1 == null && array2 != null && array2.length > 0) ||
> (array2 == null && array1 != null && array1.length > 0) ||
> @@ -433,8 +435,9 @@
> *
> * @param array1 the first array, may be <code>null</code>
> * @param array2 the second array, may be <code>null</code>
> - * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> - */
> + * @return <code>true</code> if length of arrays matches, treating
> + * <code>null</code> as an empty array
> + */
> public static boolean isSameLength(int[] array1, int[] array2) {
> if ((array1 == null && array2 != null && array2.length > 0) ||
> (array2 == null && array1 != null && array1.length > 0) ||
> @@ -451,8 +454,9 @@
> *
> * @param array1 the first array, may be <code>null</code>
> * @param array2 the second array, may be <code>null</code>
> - * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> - */
> + * @return <code>true</code> if length of arrays matches, treating
> + * <code>null</code> as an empty array
> + */
> public static boolean isSameLength(short[] array1, short[] array2) {
> if ((array1 == null && array2 != null && array2.length > 0) ||
> (array2 == null && array1 != null && array1.length > 0) ||
> @@ -469,8 +473,9 @@
> *
> * @param array1 the first array, may be <code>null</code>
> * @param array2 the second array, may be <code>null</code>
> - * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> - */
> + * @return <code>true</code> if length of arrays matches, treating
> + * <code>null</code> as an empty array
> + */
> public static boolean isSameLength(byte[] array1, byte[] array2) {
> if ((array1 == null && array2 != null && array2.length > 0) ||
> (array2 == null && array1 != null && array1.length > 0) ||
> @@ -487,8 +492,9 @@
> *
> * @param array1 the first array, may be <code>null</code>
> * @param array2 the second array, may be <code>null</code>
> - * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> - */
> + * @return <code>true</code> if length of arrays matches, treating
> + * <code>null</code> as an empty array
> + */
> public static boolean isSameLength(double[] array1, double[] array2)
{
> if ((array1 == null && array2 != null && array2.length > 0) ||
> (array2 == null && array1 != null && array1.length > 0) ||
> @@ -505,8 +511,9 @@
> *
> * @param array1 the first array, may be <code>null</code>
> * @param array2 the second array, may be <code>null</code>
> - * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> - */
> + * @return <code>true</code> if length of arrays matches, treating
> + * <code>null</code> as an empty array
> + */
> public static boolean isSameLength(float[] array1, float[] array2) {
> if ((array1 == null && array2 != null && array2.length > 0) ||
> (array2 == null && array1 != null && array1.length > 0) ||
> @@ -523,8 +530,9 @@
> *
> * @param array1 the first array, may be <code>null</code>
> * @param array2 the second array, may be <code>null</code>
> - * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> - */
> + * @return <code>true</code> if length of arrays matches, treating
> + * <code>null</code> as an empty array
> + */
> public static boolean isSameLength(boolean[] array1, boolean[]
array2) {
> if ((array1 == null && array2 != null && array2.length > 0) ||
> (array2 == null && array1 != null && array1.length > 0) ||
> @@ -540,7 +548,7 @@
> *
> * @param array1 the first array, must not be <code>null</code>
> * @param array2 the second array, must not be <code>null</code>
> - * @param true if type of arrays matches
> + * @return <code>true</code> if type of arrays matches
> * @throws IllegalArgumentException if either array is
<code>null</code>
> */
> public static boolean isSameType(Object array1, Object array2) {
>
>
----------------------------------------------------------------------------
----
> --
> To unsubscribe, e-mail:
<ma...@jakarta.apache.org>
> For additional commands, e-mail:
<ma...@jakarta.apache.org>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [lang] [patch] Javadoc
Posted by Fredrik Westermarck <fr...@mdh.se>.
Stephen Colebourne wrote:
> Unfortunately its the patch format thats wrong (Eclipse doesn't like it).
> See:
> http://jakarta.apache.org/commons/patches.html
>
> (I think its the -u you're missing)
You're right, I did miss the -u switch. Thats what happens when you try
to use an GUI-application... :)
Re: [lang] [patch] Javadoc
Posted by Stephen Colebourne <sc...@btopenworld.com>.
Unfortunately its the patch format thats wrong (Eclipse doesn't like it).
See:
http://jakarta.apache.org/commons/patches.html
(I think its the -u you're missing)
Stephen
----- Original Message -----
From: "Fredrik Westermarck" <fr...@mdh.se>
To: "Jakarta Commons Developers List" <co...@jakarta.apache.org>
Sent: Thursday, November 14, 2002 11:55 PM
Subject: Re: [lang] [patch] Javadoc
> Stephen Colebourne wrote:
> > I tried to apply the patch, but it failed, so I've done it mostly by
hand
> > instead. You may want to check the CVS again ;-)
>
> Hi!
>
> I've attached a new patch with the most obvious changes that was missed.
:)
>
----------------------------------------------------------------------------
----
> Index: StringUtils.java
> ===================================================================
> RCS file:
/home/cvspublic/jakarta-commons/lang/src/java/org/apache/commons/lang/String
Utils.java,v
> retrieving revision 1.22
> diff -r1.22 StringUtils.java
> 1530c1530
> < * @param str the Object to check
> ---
> > * @param obj the Object to check
> Index: ArrayUtils.java
> ===================================================================
> RCS file:
/home/cvspublic/jakarta-commons/lang/src/java/org/apache/commons/lang/ArrayU
tils.java,v
> retrieving revision 1.2
> diff -r1.2 ArrayUtils.java
> 400c400,401
> < * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> ---
> > * @return <code>true</code> if length of arrays matches, treating
> > * <code>null</code> as an empty array
> 418,419c419,421
> < * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
> > * <code>null</code> as an empty array
> > */
> 436,437c438,440
> < * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
> > * <code>null</code> as an empty array
> > */
> 454,455c457,459
> < * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
> > * <code>null</code> as an empty array
> > */
> 472,473c476,478
> < * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
> > * <code>null</code> as an empty array
> > */
> 490,491c495,497
> < * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
> > * <code>null</code> as an empty array
> > */
> 508,509c514,516
> < * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
> > * <code>null</code> as an empty array
> > */
> 526,527c533,535
> < * @param true if length of arrays matches, treating
<code>null</code> as an empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
> > * <code>null</code> as an empty array
> > */
> 543c551
> < * @param true if type of arrays matches
> ---
> > * @return <code>true</code> if type of arrays matches
>
>
----------------------------------------------------------------------------
----
> --
> To unsubscribe, e-mail:
<ma...@jakarta.apache.org>
> For additional commands, e-mail:
<ma...@jakarta.apache.org>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [lang] [patch] Javadoc
Posted by Fredrik Westermarck <fr...@mdh.se>.
Stephen Colebourne wrote:
> I tried to apply the patch, but it failed, so I've done it mostly by hand
> instead. You may want to check the CVS again ;-)
Hi!
I've attached a new patch with the most obvious changes that was missed. :)
Re: [lang] [patch] Javadoc
Posted by Stephen Colebourne <sc...@btopenworld.com>.
I tried to apply the patch, but it failed, so I've done it mostly by hand
instead. You may want to check the CVS again ;-)
Stephen
----- Original Message -----
From: "Fredrik Westermarck" <fr...@mdh.se>
To: <co...@jakarta.apache.org>
Sent: Thursday, November 07, 2002 7:08 PM
Subject: [lang] [patch] Javadoc
> Hi!
>
> I have attached a patch that improves the Javadoc in ArrayUtils,
> ClassUtils and StringUtils a little bit.
>
----------------------------------------------------------------------------
----
> Index: ArrayUtils.java
> ===================================================================
> RCS file:
/home/cvspublic/jakarta-commons/lang/src/java/org/apache/commons/lang/ArrayU
tils.java,v
> retrieving revision 1.1
> diff -r1.1 ArrayUtils.java
> 399c399,400
> < * @param true if length of arrays matches, treating null as an
empty array
> ---
> > * @return <code>true</code> if length of arrays matches, treating
<code>null</code>
> > * as an empty array
> 416c417,418
> < * @param true if length of arrays matches, treating null as an
empty array
> ---
> > * @return <code>true</code> if length of arrays matches, treating
<code>null</code>
> > * as an empty array
> 433c435,436
> < * @param true if length of arrays matches, treating null as an
empty array
> ---
> > * @return <code>true</code> if length of arrays matches, treating
<code>null</code>
> > * as an empty array
> 450,451c453,455
> < * @param true if length of arrays matches, treating null as an
empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
<code>null</code>
> > * as an empty array
> > */
> 467,468c471,473
> < * @param true if length of arrays matches, treating null as an
empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
<code>null</code>
> > * as an empty array
> > */
> 484,485c489,491
> < * @param true if length of arrays matches, treating null as an
empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
<code>null</code>
> > * as an empty array
> > */
> 501,502c507,509
> < * @param true if length of arrays matches, treating null as an
empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
<code>null</code>
> > * as an empty array
> > */
> 518,519c525,527
> < * @param true if length of arrays matches, treating null as an
empty array
> < */
> ---
> > * @return <code>true</code> if length of arrays matches, treating
<code>null</code>
> > * as an empty array
> > */
> 535c543
> < * @param true if type of arrays matches
> ---
> > * @return <code>true</code> if type of arrays matches
> Index: ClassUtils.java
> ===================================================================
> RCS file:
/home/cvspublic/jakarta-commons/lang/src/java/org/apache/commons/lang/ClassU
tils.java,v
> retrieving revision 1.3
> diff -r1.3 ClassUtils.java
> 59c59
> < import java.util.ListIterator;
> ---
> >
> 298c298
> < * @param classes the classNames to change, the class is stored
back
> ---
> > * @param classNames the classNames to change, the class is stored
back
> Index: StringUtils.java
> ===================================================================
> RCS file:
/home/cvspublic/jakarta-commons/lang/src/java/org/apache/commons/lang/String
Utils.java,v
> retrieving revision 1.21
> diff -r1.21 StringUtils.java
> 1527,1528c1527,1528
> < * Return either the passed in Object, or if it is
<code>null</code>,
> < * then an empty String.
> ---
> > * Return either the passed in Object as a String, or if the Object
is
> > * <code>null</code> an empty String.
> 1530c1530
> < * @param str the Object to check
> ---
> > * @param obj the Object to check
> 1538,1539c1538,1539
> < * Return either the passed in Object, or if it is
<code>null</code>,
> < * then a passed in default String.
> ---
> > * Return either the passed in Object as a String, or if the Object
is
> > * <code>null</code> the passed in default String.
>
>
----------------------------------------------------------------------------
----
> --
> To unsubscribe, e-mail:
<ma...@jakarta.apache.org>
> For additional commands, e-mail:
<ma...@jakarta.apache.org>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>