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@137286 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/lang/CharSetUtils.java

@@ -59,7 +59,7 @@ package org.apache.commons.lang;
  * @author <a href="bayard@generationjava.com">Henri Yandell</a>
  * @author Stephen Colebourne
  * @since 1.0
- * @version $Id: CharSetUtils.java,v 1.10 2003/03/23 17:59:09 scolebourne Exp $
+ * @version $Id: CharSetUtils.java,v 1.11 2003/04/09 00:07:50 ggregory Exp $
  */
 public class CharSetUtils {
 
@@ -74,9 +74,9 @@ public class CharSetUtils {
     }
 
     /**
-     * <p>Creates a CharSetUtils object which allows a certain amount of
+     * <p>Creates a <code>CharSetUtils</code> object which allows a certain amount of
-     * set logic to be performed upon the following syntax:</p>
+     * set logic to be performed.</p>
-     *
+     * <p>The syntax is:</p>
      * <ul>
      *  <li>"aeio" which implies 'a','e',..
      *  <li>"^e" implies not e. However it only negates, it's not

src/java/org/apache/commons/lang/ClassUtils.java

@@ -62,7 +62,7 @@ import java.util.List;
  *
  * @author Stephen Colebourne
  * @since 2.0
- * @version $Id: ClassUtils.java,v 1.9 2003/03/23 17:59:09 scolebourne Exp $
+ * @version $Id: ClassUtils.java,v 1.10 2003/04/09 00:07:50 ggregory Exp $
  */
 public class ClassUtils {
 
@@ -299,7 +299,8 @@ public class ClassUtils {
     // -------------------------------------------------------------------------
     
     /**
-     * <p>Given a <code>List</code> of class names, this method converts them into classes.     *
+     * <p>Given a <code>List</code> of class names, this method converts them into classes.     
+     *
      * A new <code>List</code> is returned. If the class name cannot be found, <code>null</code>
      * is stored in the <code>List</code>. If the class name in the <code>List</code> is
      * <code>null</code>, <code>null</code> is stored in the output <code>List</code>.</p>

src/java/org/apache/commons/lang/NumberRange.java

@@ -63,7 +63,7 @@ package org.apache.commons.lang;
  * @author <a href="mailto:chrise@esha.com">Christopher Elkins</a>
  * @author Stephen Colebourne
  * @since 1.0
- * @version $Revision: 1.6 $ $Date: 2003/03/23 18:00:59 $
+ * @version $Revision: 1.7 $ $Date: 2003/04/09 00:07:50 $
  * 
  * @deprecated Use one of the Range classes in org.apache.commons.lang.math
  */
@@ -189,7 +189,7 @@ public final class NumberRange {
 
     /**
      * <p>Indicates whether some other <code>Object</code> is "equal" to
-     * this one</p>.
+     * this one.</p>
      *
      * @param obj the reference object with which to compare
      * @return <code>true</code> if this object is the same as the obj

src/java/org/apache/commons/lang/StringEscapeUtils.java

@@ -75,12 +75,12 @@ import org.apache.commons.lang.exception.NestableRuntimeException;
  * @author Helge Tesgaard
  * @author <a href="sean@boohai.com">Sean Brown</a>
  * @since 2.0
- * @version $Id: StringEscapeUtils.java,v 1.3 2003/04/02 06:14:46 alex Exp $
+ * @version $Id: StringEscapeUtils.java,v 1.4 2003/04/09 00:07:49 ggregory Exp $
  */
 public class StringEscapeUtils {
 
     /**
-     * <p><code>StringEscapeUtils<code> instances should NOT be constructed in
+     * <p><code>StringEscapeUtils</code> instances should NOT be constructed in
      * standard programming. Instead, the class should be used as
      * <code>StringEscapeUtils.escapeJava("foo");</code>.</p>
      *
@@ -496,8 +496,8 @@ public class StringEscapeUtils {
     }
 
     /**
-     * Turns funky characters into HTML entity equivalents<p>
+     * <p>Turns funky characters into HTML entity equivalents.</p>
-     * e.g. <tt>"bread" & "butter"</tt> => <tt>&amp;quot;bread&amp;quot; &amp;amp; &amp;quot;butter&amp;quot;</tt>.
+     * For example: <tt>"bread" & "butter"</tt> => <tt>&amp;quot;bread&amp;quot; &amp;amp; &amp;quot;butter&amp;quot;</tt>.
      * Supports all known HTML entities, including funky accents. See the source code for more detail.
      * see http://hotwired.lycos.com/webmonkey/reference/special_characters/
      * @see #unescapeHtml(String)

src/java/org/apache/commons/lang/StringUtils.java

@@ -78,7 +78,7 @@ import org.apache.commons.lang.exception.NestableRuntimeException;
  * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
  * @author Arun Mammen Thomas
  * @since 1.0
- * @version $Id: StringUtils.java,v 1.40 2003/03/29 16:17:21 alex Exp $
+ * @version $Id: StringUtils.java,v 1.41 2003/04/09 00:07:50 ggregory Exp $
  */
 public class StringUtils {
 
@@ -2130,9 +2130,9 @@ public class StringUtils {
     }
 
     /**
-     * Compare two strings, and return the index at which the strings begin to differ
+     * <p>Compare two strings, and return the index at which the strings begin to differ.</p>
-     * <p>
+     * 
-     * For example, <code>differenceAt("i am a machine", "i am a robot") -> 7</code>
+     * <p>For example, <code>differenceAt("i am a machine", "i am a robot") -> 7</code></p>
      *
      * @return the index where s2 and s1 begin to differ; -1 if they are equal
      */

src/java/org/apache/commons/lang/util/BitField.java

@@ -63,7 +63,7 @@ package org.apache.commons.lang.util;
  * @author Andrew C. Oliver (acoliver at apache dot org)
  * @author Stephen Colebourne
  * @since 2.0
- * @version $Id: BitField.java,v 1.4 2003/03/23 17:52:25 scolebourne Exp $
+ * @version $Id: BitField.java,v 1.5 2003/04/09 00:07:49 ggregory Exp $
  */
 public class BitField {
     
@@ -148,7 +148,7 @@ public class BitField {
     }
 
     /**
-     * Is the field set or not? This is most commonly used for a
+     * Returns whether the field is set or not. This is most commonly used for a
      * single-bit field, which is often used to represent a boolean
      * value; the results of using it for a multi-bit field is to
      * determine whether *any* of its bits are set
@@ -163,7 +163,7 @@ public class BitField {
     }
 
     /**
-     * Are all of the bits set or not? This is a stricter test than
+     * Returns whether all of the bits are set or not. This is a stricter test than
      * isSet, in that all of the bits in a multi-bit set must be set
      * for this method to return true
      *