From 9949212b92de00609cb511d6f1b4599290240f73 Mon Sep 17 00:00:00 2001
From: Isira Seneviratne
Date: Fri, 17 Apr 2020 12:06:48 +0530
Subject: [PATCH] Fix some spelling and grammar issues in the StringUtils
Javadoc.
---
.../org/apache/commons/lang3/StringUtils.java | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java
index e74ccefad..a585c2eb3 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -38,17 +38,17 @@ import java.util.regex.Pattern;
* Trim/Strip
* - removes leading and trailing whitespace
* Equals/Compare
- * - compares two strings null-safe
+ * - compares two strings in a null-safe manner
* startsWith
- * - check if a String starts with a prefix null-safe
+ * - check if a String starts with a prefix in a null-safe manner
* endsWith
- * - check if a String ends with a suffix null-safe
+ * - check if a String ends with a suffix in a null-safe manner
* IndexOf/LastIndexOf/Contains
* - null-safe index-of checks
* IndexOfAny/LastIndexOfAny/IndexOfAnyBut/LastIndexOfAnyBut
* - index-of any of a set of Strings
* ContainsOnly/ContainsNone/ContainsAny
- * - does String contains only/none/any of these characters
+ * - checks if String contains only/none/any of these characters
* Substring/Left/Right/Mid
* - null-safe substring extractions
* SubstringBefore/SubstringAfter/SubstringBetween
@@ -80,7 +80,7 @@ import java.util.regex.Pattern;
* Reverse/ReverseDelimited
* - reverses a String
* Abbreviate
- * - abbreviates a string using ellipsis or another given String
+ * - abbreviates a string using ellipses or another given String
* Difference
* - compares Strings and reports on their differences
* LevenshteinDistance
@@ -107,7 +107,7 @@ import java.util.regex.Pattern;
* {@code NullPointerException} should be considered a bug in
* {@code StringUtils}.
*
- * Methods in this class give sample code to explain their operation.
+ *
Methods in this class include sample code in their Javadoc comments to explain their operation.
* The symbol {@code *} is used to indicate any input including {@code null}.
*
* #ThreadSafe#
@@ -564,7 +564,7 @@ public class StringUtils {
* Centers a String in a larger String of size {@code size}
* using the space character (' ').
*
- * If the size is less than the String length, the String is returned.
+ *
If the size is less than the String length, the original String is returned.
* A {@code null} String returns {@code null}.
* A negative size is treated as zero.
*
@@ -5015,7 +5015,7 @@ public class StringUtils {
}
/**
- * Find the latest index of any of a set of potential substrings.
+ * Find the latest index of any substring in a set of potential substrings.
*
* A {@code null} CharSequence will return {@code -1}.
* A {@code null} search array will return {@code -1}.
@@ -6386,7 +6386,7 @@ public class StringUtils {
/**
*
Replaces a String with another String inside a larger String,
* for the first {@code max} values of the search String,
- * case sensitively/insensisitively based on {@code ignoreCase} value.
+ * case sensitively/insensitively based on {@code ignoreCase} value.
*
* A {@code null} reference passed to this method is a no-op.
*