commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject cvs commit: jakarta-commons/lang/src/java/org/apache/commons/lang StringEscapeUtils.java StringUtils.java CharSetUtils.java ClassUtils.java NumberRange.java
Date Wed, 09 Apr 2003 00:07:50 GMT
ggregory    2003/04/08 17:07:50

  Modified:    lang/src/java/org/apache/commons/lang/util BitField.java
               lang/src/java/org/apache/commons/lang StringEscapeUtils.java
                        StringUtils.java CharSetUtils.java ClassUtils.java
                        NumberRange.java
  Log:
  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.5       +3 -3      jakarta-commons/lang/src/java/org/apache/commons/lang/util/BitField.java
  
  Index: BitField.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/util/BitField.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- BitField.java	23 Mar 2003 17:52:25 -0000	1.4
  +++ BitField.java	9 Apr 2003 00:07:49 -0000	1.5
  @@ -148,7 +148,7 @@
       }
   
       /**
  -     * 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 @@
       }
   
       /**
  -     * 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
        *
  
  
  
  1.4       +4 -4      jakarta-commons/lang/src/java/org/apache/commons/lang/StringEscapeUtils.java
  
  Index: StringEscapeUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/StringEscapeUtils.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- StringEscapeUtils.java	2 Apr 2003 06:14:46 -0000	1.3
  +++ StringEscapeUtils.java	9 Apr 2003 00:07:49 -0000	1.4
  @@ -80,7 +80,7 @@
   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 @@
       }
   
       /**
  -     * 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>.
  +     * <p>Turns funky characters into HTML entity equivalents.</p>
  +     * 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)
  
  
  
  1.41      +4 -4      jakarta-commons/lang/src/java/org/apache/commons/lang/StringUtils.java
  
  Index: StringUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/StringUtils.java,v
  retrieving revision 1.40
  retrieving revision 1.41
  diff -u -r1.40 -r1.41
  --- StringUtils.java	29 Mar 2003 16:17:21 -0000	1.40
  +++ StringUtils.java	9 Apr 2003 00:07:50 -0000	1.41
  @@ -2130,9 +2130,9 @@
       }
   
       /**
  -     * Compare two strings, and return the index at which the strings begin to differ
  -     * <p>
  -     * For example, <code>differenceAt("i am a machine", "i am a robot") -> 7</code>
  +     * <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>
        *
        * @return the index where s2 and s1 begin to differ; -1 if they are equal
        */
  
  
  
  1.11      +4 -4      jakarta-commons/lang/src/java/org/apache/commons/lang/CharSetUtils.java
  
  Index: CharSetUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/CharSetUtils.java,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- CharSetUtils.java	23 Mar 2003 17:59:09 -0000	1.10
  +++ CharSetUtils.java	9 Apr 2003 00:07:50 -0000	1.11
  @@ -74,9 +74,9 @@
       }
   
       /**
  -     * <p>Creates a CharSetUtils object which allows a certain amount of
  -     * set logic to be performed upon the following syntax:</p>
  -     *
  +     * <p>Creates a <code>CharSetUtils</code> object which allows a certain
amount of
  +     * 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
  
  
  
  1.10      +3 -2      jakarta-commons/lang/src/java/org/apache/commons/lang/ClassUtils.java
  
  Index: ClassUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/ClassUtils.java,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- ClassUtils.java	23 Mar 2003 17:59:09 -0000	1.9
  +++ ClassUtils.java	9 Apr 2003 00:07:50 -0000	1.10
  @@ -299,7 +299,8 @@
       // -------------------------------------------------------------------------
       
       /**
  -     * <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>
  
  
  
  1.7       +2 -2      jakarta-commons/lang/src/java/org/apache/commons/lang/NumberRange.java
  
  Index: NumberRange.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/NumberRange.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- NumberRange.java	23 Mar 2003 18:00:59 -0000	1.6
  +++ NumberRange.java	9 Apr 2003 00:07:50 -0000	1.7
  @@ -189,7 +189,7 @@
   
       /**
        * <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
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message