Repository: commons-lang Updated Branches: refs/heads/master ab25f6734 -> ebcef2d16
Fix a number of Javadoc typos (closes #232) Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/ebcef2d1 Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/ebcef2d1 Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/ebcef2d1 Branch: refs/heads/master Commit: ebcef2d16a81bfe1a818a362fd03cb5063640003 Parents: ab25f67 Author: Sebastian Kürten <sebast...@topobyte.de> Authored: Fri Feb 3 19:03:04 2017 +0100 Committer: pascalschumacher <pascalschumac...@gmx.net> Committed: Fri Feb 3 20:00:04 2017 +0100 ---------------------------------------------------------------------- .../org/apache/commons/lang3/ArrayUtils.java | 54 ++++++++++---------- .../commons/lang3/SerializationUtils.java | 2 +- .../apache/commons/lang3/reflect/TypeUtils.java | 8 +-- .../apache/commons/lang3/text/StrBuilder.java | 2 +- .../commons/lang3/text/StrSubstitutor.java | 20 ++++---- .../apache/commons/lang3/time/DateUtils.java | 2 +- 6 files changed, 44 insertions(+), 44 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-lang/blob/ebcef2d1/src/main/java/org/apache/commons/lang3/ArrayUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java index 624731e..b09e891 100644 --- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java +++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java @@ -2651,7 +2651,7 @@ public class ArrayUtils { * the starting index. Undervalue (<0) is promoted to 0, overvalue (>array.length) results in no * change. * @param endIndexExclusive - * elements up to endIndex-1 are shiftd in the array. Undervalue (< start index) results in no + * elements up to endIndex-1 are shifted in the array. Undervalue (< start index) results in no * change. Overvalue (>array.length) is demoted to array length. * @param offset * The number of positions to rotate the elements. If the offset is larger than the number of elements to @@ -2711,7 +2711,7 @@ public class ArrayUtils { * the starting index. Undervalue (<0) is promoted to 0, overvalue (>array.length) results in no * change. * @param endIndexExclusive - * elements up to endIndex-1 are shiftd in the array. Undervalue (< start index) results in no + * elements up to endIndex-1 are shifted in the array. Undervalue (< start index) results in no * change. Overvalue (>array.length) is demoted to array length. * @param offset * The number of positions to rotate the elements. If the offset is larger than the number of elements to @@ -2771,7 +2771,7 @@ public class ArrayUtils { * the starting index. Undervalue (<0) is promoted to 0, overvalue (>array.length) results in no * change. * @param endIndexExclusive - * elements up to endIndex-1 are shiftd in the array. Undervalue (< start index) results in no + * elements up to endIndex-1 are shifted in the array. Undervalue (< start index) results in no * change. Overvalue (>array.length) is demoted to array length. * @param offset * The number of positions to rotate the elements. If the offset is larger than the number of elements to @@ -2831,7 +2831,7 @@ public class ArrayUtils { * the starting index. Undervalue (<0) is promoted to 0, overvalue (>array.length) results in no * change. * @param endIndexExclusive - * elements up to endIndex-1 are shiftd in the array. Undervalue (< start index) results in no + * elements up to endIndex-1 are shifted in the array. Undervalue (< start index) results in no * change. Overvalue (>array.length) is demoted to array length. * @param offset * The number of positions to rotate the elements. If the offset is larger than the number of elements to @@ -2891,7 +2891,7 @@ public class ArrayUtils { * the starting index. Undervalue (<0) is promoted to 0, overvalue (>array.length) results in no * change. * @param endIndexExclusive - * elements up to endIndex-1 are shiftd in the array. Undervalue (< start index) results in no + * elements up to endIndex-1 are shifted in the array. Undervalue (< start index) results in no * change. Overvalue (>array.length) is demoted to array length. * @param offset * The number of positions to rotate the elements. If the offset is larger than the number of elements to @@ -2951,7 +2951,7 @@ public class ArrayUtils { * the starting index. Undervalue (<0) is promoted to 0, overvalue (>array.length) results in no * change. * @param endIndexExclusive - * elements up to endIndex-1 are shiftd in the array. Undervalue (< start index) results in no + * elements up to endIndex-1 are shifted in the array. Undervalue (< start index) results in no * change. Overvalue (>array.length) is demoted to array length. * @param offset * The number of positions to rotate the elements. If the offset is larger than the number of elements to @@ -3011,7 +3011,7 @@ public class ArrayUtils { * the starting index. Undervalue (<0) is promoted to 0, overvalue (>array.length) results in no * change. * @param endIndexExclusive - * elements up to endIndex-1 are shiftd in the array. Undervalue (< start index) results in no + * elements up to endIndex-1 are shifted in the array. Undervalue (< start index) results in no * change. Overvalue (>array.length) is demoted to array length. * @param offset * The number of positions to rotate the elements. If the offset is larger than the number of elements to @@ -3071,7 +3071,7 @@ public class ArrayUtils { * the starting index. Undervalue (<0) is promoted to 0, overvalue (>array.length) results in no * change. * @param endIndexExclusive - * elements up to endIndex-1 are shiftd in the array. Undervalue (< start index) results in no + * elements up to endIndex-1 are shifted in the array. Undervalue (< start index) results in no * change. Overvalue (>array.length) is demoted to array length. * @param offset * The number of positions to rotate the elements. If the offset is larger than the number of elements to @@ -3240,7 +3240,7 @@ public class ArrayUtils { * * <p>This method returns {@link #INDEX_NOT_FOUND} ({@code -1}) for a {@code null} input array. * - * @param array the array to travers backwards looking for the object, may be {@code null} + * @param array the array to traverse backwards looking for the object, may be {@code null} * @param objectToFind the object to find, may be {@code null} * @return the last index of the object within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -3259,7 +3259,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param objectToFind the object to find, may be {@code null} - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @return the last index of the object within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input */ @@ -3351,7 +3351,7 @@ public class ArrayUtils { * * <p>This method returns {@link #INDEX_NOT_FOUND} ({@code -1}) for a {@code null} input array. * - * @param array the array to travers backwards looking for the object, may be {@code null} + * @param array the array to traverse backwards looking for the object, may be {@code null} * @param valueToFind the object to find * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -3370,7 +3370,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param valueToFind the value to find - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input */ @@ -3454,7 +3454,7 @@ public class ArrayUtils { * * <p>This method returns {@link #INDEX_NOT_FOUND} ({@code -1}) for a {@code null} input array. * - * @param array the array to travers backwards looking for the object, may be {@code null} + * @param array the array to traverse backwards looking for the object, may be {@code null} * @param valueToFind the object to find * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -3473,7 +3473,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param valueToFind the value to find - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input */ @@ -3557,7 +3557,7 @@ public class ArrayUtils { * * <p>This method returns {@link #INDEX_NOT_FOUND} ({@code -1}) for a {@code null} input array. * - * @param array the array to travers backwards looking for the object, may be {@code null} + * @param array the array to traverse backwards looking for the object, may be {@code null} * @param valueToFind the object to find * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -3576,7 +3576,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param valueToFind the value to find - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input */ @@ -3662,7 +3662,7 @@ public class ArrayUtils { * * <p>This method returns {@link #INDEX_NOT_FOUND} ({@code -1}) for a {@code null} input array. * - * @param array the array to travers backwards looking for the object, may be {@code null} + * @param array the array to traverse backwards looking for the object, may be {@code null} * @param valueToFind the object to find * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -3682,7 +3682,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param valueToFind the value to find - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input * @since 2.1 @@ -3768,7 +3768,7 @@ public class ArrayUtils { * * <p>This method returns {@link #INDEX_NOT_FOUND} ({@code -1}) for a {@code null} input array. * - * @param array the array to travers backwards looking for the object, may be {@code null} + * @param array the array to traverse backwards looking for the object, may be {@code null} * @param valueToFind the object to find * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -3787,7 +3787,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param valueToFind the value to find - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input */ @@ -3922,7 +3922,7 @@ public class ArrayUtils { * * <p>This method returns {@link #INDEX_NOT_FOUND} ({@code -1}) for a {@code null} input array. * - * @param array the array to travers backwards looking for the object, may be {@code null} + * @param array the array to traverse backwards looking for the object, may be {@code null} * @param valueToFind the object to find * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -3958,7 +3958,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param valueToFind the value to find - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input */ @@ -3991,7 +3991,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param valueToFind the value to find - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @param tolerance search for value within plus/minus this amount * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -4095,7 +4095,7 @@ public class ArrayUtils { * * <p>This method returns {@link #INDEX_NOT_FOUND} ({@code -1}) for a {@code null} input array. * - * @param array the array to travers backwards looking for the object, may be {@code null} + * @param array the array to traverse backwards looking for the object, may be {@code null} * @param valueToFind the object to find * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -4114,7 +4114,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param valueToFind the value to find - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input */ @@ -4200,7 +4200,7 @@ public class ArrayUtils { * <p>This method returns {@link #INDEX_NOT_FOUND} ({@code -1}) if * {@code null} array input. * - * @param array the array to travers backwards looking for the object, may be {@code null} + * @param array the array to traverse backwards looking for the object, may be {@code null} * @param valueToFind the object to find * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input @@ -4219,7 +4219,7 @@ public class ArrayUtils { * * @param array the array to traverse for looking for the object, may be {@code null} * @param valueToFind the value to find - * @param startIndex the start index to travers backwards from + * @param startIndex the start index to traverse backwards from * @return the last index of the value within the array, * {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input */ http://git-wip-us.apache.org/repos/asf/commons-lang/blob/ebcef2d1/src/main/java/org/apache/commons/lang3/SerializationUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java b/src/main/java/org/apache/commons/lang3/SerializationUtils.java index 1840996..f1a4993 100644 --- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java +++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java @@ -273,7 +273,7 @@ public class SerializationUtils { } /** - * Overriden version that uses the parametrized <code>ClassLoader</code> or the <code>ClassLoader</code> + * Overridden version that uses the parameterized <code>ClassLoader</code> or the <code>ClassLoader</code> * of the current <code>Thread</code> to resolve the class. * @param desc An instance of class <code>ObjectStreamClass</code>. * @return A <code>Class</code> object corresponding to <code>desc</code>. http://git-wip-us.apache.org/repos/asf/commons-lang/blob/ebcef2d1/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java b/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java index 1f7e3ee..685e4cb 100644 --- a/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java +++ b/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java @@ -788,7 +788,7 @@ public class TypeUtils { } /** - * <p>Return a map of the type arguments of @{code type} in the context of {@code toClass}.</p> + * <p>Return a map of the type arguments of {@code type} in the context of {@code toClass}.</p> * * @param type the type in question * @param toClass the class @@ -890,7 +890,7 @@ public class TypeUtils { } /** - * <p>Return a map of the type arguments of a class in the context of @{code toClass}.</p> + * <p>Return a map of the type arguments of a class in the context of {@code toClass}.</p> * * @param cls the class in question * @param toClass the context class @@ -1527,7 +1527,7 @@ public class TypeUtils { /** * Helper method to establish the formal parameters for a parameterized type. - * @param mappings map containing the assignements + * @param mappings map containing the assignments * @param variables expected map keys * @return array of map values corresponding to specified keys */ @@ -1829,7 +1829,7 @@ public class TypeUtils { } /** - * Append {@code types} to @{code buf} with separator {@code sep}. + * Append {@code types} to {@code buf} with separator {@code sep}. * @param buf destination * @param sep separator * @param types to append http://git-wip-us.apache.org/repos/asf/commons-lang/blob/ebcef2d1/src/main/java/org/apache/commons/lang3/text/StrBuilder.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java index c7691a4..1d4e2a8 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java +++ b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java @@ -2651,7 +2651,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * changed on the tokenizer class, before retrieving the tokens. * <p> * The returned tokenizer is linked to this builder. You may intermix - * calls to the buider and tokenizer within certain limits, however + * calls to the builder and tokenizer within certain limits, however * there is no synchronization. Once the tokenizer has been used once, * it must be {@link StrTokenizer#reset() reset} to pickup the latest * changes in the builder. For example: http://git-wip-us.apache.org/repos/asf/commons-lang/blob/ebcef2d1/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java index ee07087..0af4d14 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java +++ b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java @@ -957,7 +957,7 @@ public class StrSubstitutor { /** * Gets the variable prefix matcher currently in use. * <p> - * The variable prefix is the characer or characters that identify the + * The variable prefix is the character or characters that identify the * start of a variable. This prefix is expressed in terms of a matcher * allowing advanced prefix matches. * @@ -970,7 +970,7 @@ public class StrSubstitutor { /** * Sets the variable prefix matcher currently in use. * <p> - * The variable prefix is the characer or characters that identify the + * The variable prefix is the character or characters that identify the * start of a variable. This prefix is expressed in terms of a matcher * allowing advanced prefix matches. * @@ -1003,7 +1003,7 @@ public class StrSubstitutor { /** * Sets the variable prefix to use. * <p> - * The variable prefix is the characer or characters that identify the + * The variable prefix is the character or characters that identify the * start of a variable. This method allows a string prefix to be easily set. * * @param prefix the prefix for variables, not null @@ -1022,7 +1022,7 @@ public class StrSubstitutor { /** * Gets the variable suffix matcher currently in use. * <p> - * The variable suffix is the characer or characters that identify the + * The variable suffix is the character or characters that identify the * end of a variable. This suffix is expressed in terms of a matcher * allowing advanced suffix matches. * @@ -1035,7 +1035,7 @@ public class StrSubstitutor { /** * Sets the variable suffix matcher currently in use. * <p> - * The variable suffix is the characer or characters that identify the + * The variable suffix is the character or characters that identify the * end of a variable. This suffix is expressed in terms of a matcher * allowing advanced suffix matches. * @@ -1054,7 +1054,7 @@ public class StrSubstitutor { /** * Sets the variable suffix to use. * <p> - * The variable suffix is the characer or characters that identify the + * The variable suffix is the character or characters that identify the * end of a variable. This method allows a single character suffix to * be easily set. * @@ -1087,7 +1087,7 @@ public class StrSubstitutor { /** * Gets the variable default value delimiter matcher currently in use. * <p> - * The variable default value delimiter is the characer or characters that delimite the + * The variable default value delimiter is the character or characters that delimit the * variable name and the variable default value. This delimiter is expressed in terms of a matcher * allowing advanced variable default value delimiter matches. * <p> @@ -1103,7 +1103,7 @@ public class StrSubstitutor { /** * Sets the variable default value delimiter matcher to use. * <p> - * The variable default value delimiter is the characer or characters that delimite the + * The variable default value delimiter is the character or characters that delimit the * variable name and the variable default value. This delimiter is expressed in terms of a matcher * allowing advanced variable default value delimiter matches. * <p> @@ -1122,7 +1122,7 @@ public class StrSubstitutor { /** * Sets the variable default value delimiter to use. * <p> - * The variable default value delimiter is the characer or characters that delimite the + * The variable default value delimiter is the character or characters that delimit the * variable name and the variable default value. This method allows a single character * variable default value delimiter to be easily set. * @@ -1137,7 +1137,7 @@ public class StrSubstitutor { /** * Sets the variable default value delimiter to use. * <p> - * The variable default value delimiter is the characer or characters that delimite the + * The variable default value delimiter is the character or characters that delimit the * variable name and the variable default value. This method allows a string * variable default value delimiter to be easily set. * <p> http://git-wip-us.apache.org/repos/asf/commons-lang/blob/ebcef2d1/src/main/java/org/apache/commons/lang3/time/DateUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/time/DateUtils.java b/src/main/java/org/apache/commons/lang3/time/DateUtils.java index a832e93..fc9f577 100644 --- a/src/main/java/org/apache/commons/lang3/time/DateUtils.java +++ b/src/main/java/org/apache/commons/lang3/time/DateUtils.java @@ -670,7 +670,7 @@ public class DateUtils { /** * Converts a {@code Date} of a given {@code TimeZone} into a {@code Calendar} * @param date the date to convert to a Calendar - * @param tz the time zone of the @{code date} + * @param tz the time zone of the {@code date} * @return the created Calendar * @throws NullPointerException if {@code date} or {@code tz} is null */