commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bay...@apache.org
Subject svn commit: r1079271 - in /commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3: CharSequenceUtils.java ImmutablePair.java MutablePair.java Pair.java StringEscapeUtils.java StringUtils.java time/package.html
Date Tue, 08 Mar 2011 06:10:28 GMT
Author: bayard
Date: Tue Mar  8 06:10:28 2011
New Revision: 1079271

URL: http://svn.apache.org/viewvc?rev=1079271&view=rev
Log:
Fixing javadoc warnings

Modified:
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/MutablePair.java
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/package.html

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java?rev=1079271&r1=1079270&r2=1079271&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
(original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
Tue Mar  8 06:10:28 2011
@@ -48,7 +48,7 @@ public class CharSequenceUtils {
      * 
      * <p>This provides the {@code CharSequence} equivalent to {@link String#substring(int)}.
      * The length (in {@code char}) of the returned sequence is {@code length() - start},
-     * so if {@start == end} then an empty sequence is returned.</p>
+     * so if {@code start == end} then an empty sequence is returned.</p>
      *
      * @param cs  the specified subsequence, null returns null
      * @param start  the start index, inclusive, valid

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java?rev=1079271&r1=1079270&r2=1079271&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java Tue
Mar  8 06:10:28 2011
@@ -67,7 +67,7 @@ public class ImmutablePair<L, R> extends
     }
 
     /**
-     * {@link Map.Entry#setValue(Object)} implementation.
+     * {@link java.util.Map.Entry#setValue(Object)} implementation.
      * @throws UnsupportedOperationException
      */
     public R setValue(R arg0) {

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/MutablePair.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/MutablePair.java?rev=1079271&r1=1079270&r2=1079271&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/MutablePair.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/MutablePair.java Tue
Mar  8 06:10:28 2011
@@ -88,7 +88,7 @@ public class MutablePair<L, R> extends P
     }
 
     /**
-     * Implement {@link Map.Entry#setValue(Object)}.
+     * Implement {@link java.util.Map.Entry#setValue(Object)}.
      * @param value value (<code>rightElement</code>) to set
      */
     public R setValue(R value) {

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java?rev=1079271&r1=1079270&r2=1079271&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java Tue Mar  8
06:10:28 2011
@@ -40,12 +40,12 @@ public abstract class Pair<L, R> impleme
 
     /**
      * Get the "right" element of the pair.
-     * @return
+     * @return R
      */
     public abstract R getRightElement();
 
     /**
-     * Return {@link #getLeftElement()} as a {@link Map.Entry}'s key.
+     * Return {@link #getLeftElement()} as a {@link java.util.Map.Entry}'s key.
      * @return L
      */
     public final L getKey() {
@@ -53,7 +53,7 @@ public abstract class Pair<L, R> impleme
     }
 
     /**
-     * Return {@link #getRightElement()} as a {@link Map.Entry}'s value.
+     * Return {@link #getRightElement()} as a {@link java.util.Map.Entry}'s value.
      * @return R
      */
     public R getValue() {

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java?rev=1079271&r1=1079270&r2=1079271&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
(original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
Tue Mar  8 06:10:28 2011
@@ -53,7 +53,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for escaping Java. 
      * 
-     * While {@link escapeJava(String)} is the expected method of use, this 
+     * While {@link #escapeJava(String)} is the expected method of use, this 
      * object allows the Java escaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -71,7 +71,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for escaping EcmaScript/JavaScript. 
      * 
-     * While {@link escapeEcmaScript(String)} is the expected method of use, this 
+     * While {@link #escapeEcmaScript(String)} is the expected method of use, this 
      * object allows the EcmaScript escaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -91,7 +91,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for escaping XML.
      * 
-     * While {@link escapeXml(String)} is the expected method of use, this 
+     * While {@link #escapeXml(String)} is the expected method of use, this 
      * object allows the XML escaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -104,7 +104,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for escaping HTML version 3.0.
      * 
-     * While {@link escapeHtml3(String)} is the expected method of use, this 
+     * While {@link #escapeHtml3(String)} is the expected method of use, this 
      * object allows the HTML escaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -117,7 +117,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for escaping HTML version 4.0.
      * 
-     * While {@link escapeHtml4(String)} is the expected method of use, this 
+     * While {@link #escapeHtml4(String)} is the expected method of use, this 
      * object allows the HTML escaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -131,7 +131,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for escaping individual Comma Separated Values. 
      * 
-     * While {@link escapeCsv(String)} is the expected method of use, this 
+     * While {@link #escapeCsv(String)} is the expected method of use, this 
      * object allows the CSV escaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -171,7 +171,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for unescaping escaped Java. 
      * 
-     * While {@link unescapeJava(String)} is the expected method of use, this 
+     * While {@link #unescapeJava(String)} is the expected method of use, this 
      * object allows the Java unescaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -193,7 +193,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for unescaping escaped EcmaScript. 
      * 
-     * While {@link unescapeEcmaScript(String)} is the expected method of use, this 
+     * While {@link #unescapeEcmaScript(String)} is the expected method of use, this 
      * object allows the EcmaScript unescaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -202,7 +202,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for unescaping escaped HTML 3.0. 
      * 
-     * While {@link unescapeHtml3(String)} is the expected method of use, this 
+     * While {@link #unescapeHtml3(String)} is the expected method of use, this 
      * object allows the HTML unescaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -216,7 +216,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for unescaping escaped HTML 4.0. 
      * 
-     * While {@link unescapeHtml4(String)} is the expected method of use, this 
+     * While {@link #unescapeHtml4(String)} is the expected method of use, this 
      * object allows the HTML unescaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -231,7 +231,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for unescaping escaped XML.
      * 
-     * While {@link unescapeXml(String)} is the expected method of use, this 
+     * While {@link #unescapeXml(String)} is the expected method of use, this 
      * object allows the XML unescaping functionality to be used 
      * as the foundation for a custom translator. 
      */
@@ -245,7 +245,7 @@ public class StringEscapeUtils {
     /**
      * Translator object for unescaping escaped Comma Separated Value entries.
      * 
-     * While {@link unescapeCsv(String)} is the expected method of use, this 
+     * While {@link #unescapeCsv(String)} is the expected method of use, this 
      * object allows the CSV unescaping functionality to be used 
      * as the foundation for a custom translator. 
      */

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java?rev=1079271&r1=1079270&r2=1079271&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java Tue
Mar  8 06:10:28 2011
@@ -3193,7 +3193,7 @@ public class StringUtils {
      * StringUtils.join([null, "", "a"]) = "a"
      * </pre>
      *
-     * @param array  the array of values to join together, may be null
+     * @param elements  the values to join together, may be null
      * @return the joined String, {@code null} if null array input
      * @since 2.0
      * @since 3.0 Changed signature to use varargs

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/package.html
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/package.html?rev=1079271&r1=1079270&r2=1079271&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/package.html (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/package.html Tue
Mar  8 06:10:28 2011
@@ -18,6 +18,6 @@ limitations under the License.
 <body>
 Provides classes and methods to work with dates and durations.
 @since 2.0
-<p>These classes are immutable (and therefore thread-safe) apart from {@link StopWatch}.</p>
+<p>These classes are immutable (and therefore thread-safe) apart from {@link org.apache.commons.lang3.time.StopWatch}.</p>
 </body>
 </html>



Mime
View raw message