Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct API docs for clean and trim #44

Merged
merged 2 commits into from
May 29, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions src/main/java/org/apache/maven/shared/utils/StringUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public StringUtils()
//--------------------------------------------------------------------------

/**
* <p>Removes control characters, including whitespace, from both
* <p>Removes C0 control characters, including ASCII whitespace, from both
* ends of this String, handling <code>null</code> by returning
* an empty String.</p>
*
Expand All @@ -83,7 +83,7 @@ public StringUtils()
}

/**
* <p>Removes control characters, including whitespace, from both
* <p>Removes C0 control characters, including ASCII whitespace, from both
* ends of this String, handling <code>null</code> by returning
* <code>null</code>.</p>
*
Expand Down Expand Up @@ -530,10 +530,10 @@ public static String mid( String str, int pos, int len )
* <p>Splits the provided text into a array, based on a given separator.</p>
* <p/>
* <p>The separator is not included in the returned String array. The
* maximum number of splits to perfom can be controlled. A <code>null</code>
* separator will cause parsing to be on whitespace.</p>
* maximum number of splits to perform can be controlled. A <code>null</code>
* separator causes splitting on whitespace.</p>
* <p/>
* <p>This is useful for quickly splitting a String directly into
* <p>This is useful for quickly splitting a String into
* an array of tokens, instead of an enumeration of tokens (as
* <code>StringTokenizer</code> does).</p>
*
Expand Down Expand Up @@ -1688,7 +1688,7 @@ public static String getNestedString( String str, @Nonnull String open, @Nonnull
*
* @param str the String to check
* @param sub the substring to count
* @return the number of occurances, 0 if the String is <code>null</code>
* @return the number of occurrences, 0 if the String is <code>null</code>
* @throws NullPointerException if sub is <code>null</code>
*/
public static int countMatches( @Nullable String str, @Nonnull String sub )
Expand All @@ -1715,7 +1715,7 @@ public static int countMatches( @Nullable String str, @Nonnull String sub )
//--------------------------------------------------------------------------

/**
* <p>Checks if the String contains only unicode letters.</p>
* <p>Checks if the String contains only Unicode letters.</p>
* <p/>
* <p><code>null</code> will return <code>false</code>.
* An empty String will return <code>true</code>.</p>
Expand Down Expand Up @@ -1767,7 +1767,7 @@ public static boolean isWhitespace( String str )
}

/**
* <p>Checks if the String contains only unicode letters and
* <p>Checks if the String contains only Unicode letters and
* space (<code>' '</code>).</p>
* <p/>
* <p><code>null</code> will return <code>false</code>. An
Expand Down Expand Up @@ -1795,7 +1795,7 @@ public static boolean isAlphaSpace( String str )
}

/**
* <p>Checks if the String contains only unicode letters or digits.</p>
* <p>Checks if the String contains only Unicode letters or digits.</p>
* <p/>
* <p><code>null</code> will return <code>false</code>. An empty
* String will return <code>true</code>.</p>
Expand All @@ -1822,7 +1822,7 @@ public static boolean isAlphanumeric( String str )
}

/**
* <p>Checks if the String contains only unicode letters, digits
* <p>Checks if the String contains only Unicode letters, digits
* or space (<code>' '</code>).</p>
* <p/>
* <p><code>null</code> will return <code>false</code>. An empty
Expand Down Expand Up @@ -1850,7 +1850,7 @@ public static boolean isAlphanumericSpace( String str )
}

/**
* <p>Checks if the String contains only unicode digits.</p>
* <p>Checks if the String contains only Unicode digits.</p>
* <p/>
* <p><code>null</code> will return <code>false</code>.
* An empty String will return <code>true</code>.</p>
Expand Down