[commons-text] 03/06: Javadoc.

[gg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git

commit fb7c75ffb7f71d50d3b24dbbc2e49ae14d964830
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jun 28 14:56:40 2020 -0400

    Javadoc.
---
 src/main/java/org/apache/commons/text/TextStringBuilder.java | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/src/main/java/org/apache/commons/text/TextStringBuilder.java b/src/main/java/org/apache/commons/text/TextStringBuilder.java
index 7cc0122..b94be8d 100644
--- a/src/main/java/org/apache/commons/text/TextStringBuilder.java
+++ b/src/main/java/org/apache/commons/text/TextStringBuilder.java
@@ -3219,12 +3219,10 @@ public class TextStringBuilder implements CharSequence, Appendable, Serializable
     }
 
     /**
-     * Validates parameters defining a single index in the builder.
+     * Validates that an index is in the range {@code 0 <= index <= size}.
      *
-     * @param index
-     *            the index, must be valid
-     * @throws IndexOutOfBoundsException
-     *             if the index is invalid
+     * @param index the index, must be valid
+     * @throws IndexOutOfBoundsException Thrown when the index is not the range {@code 0 <= index <= size}.
      */
     protected void validateIndex(final int index) {
         if (index < 0 || index > size) {