commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From djo...@apache.org
Subject svn commit: r1592873 - /commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java
Date Tue, 06 May 2014 20:42:00 GMT
Author: djones
Date: Tue May  6 20:41:59 2014
New Revision: 1592873

URL: http://svn.apache.org/r1592873
Log:
Further tidying of Javadoc.

Modified:
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java

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=1592873&r1=1592872&r2=1592873&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
May  6 20:41:59 2014
@@ -7638,27 +7638,23 @@ public class StringUtils {
 
     /**
      * <p>
-     * Wraps a String with a char.
+     * Wraps a string with a char.
      * <p>
      * 
-     * <p>
-     * A {@code null} input String returns {@code null}.
-     * </p>
-     * 
      * <pre>
-     * StringUtils.wrap(null, *)   = null
-     * StringUtils.wrap("", *)     = ""
-     * StringUtils.wrap("ab", '\0')  = "ab"
-     * StringUtils.wrap("ab", 'x')  = "xabx"
-     * StringUtils.wrap("ab", '\'')   = "'ab'"
+     * StringUtils.wrap(null, *)        = null
+     * StringUtils.wrap("", *)          = ""
+     * StringUtils.wrap("ab", '\0')     = "ab"
+     * StringUtils.wrap("ab", 'x')      = "xabx"
+     * StringUtils.wrap("ab", '\'')     = "'ab'"
      * StringUtils.wrap("\"ab\"", '\"') = "\"ab\""
      * </pre>
      * 
      * @param str
-     *            the String to be wrapper, may be null
+     *            the string to be wrapped, may be {@code null}
      * @param wrapWith
-     *            the char that will wrap str
-     * @return wrapped String, {@code null} if null String input
+     *            the char that will wrap {@code str}
+     * @return the wrapped string, or {@code null} if {@code str==null}
      * @since 3.4
      */
     public static String wrap(String str, char wrapWith) {



Mime
View raw message