You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2024/07/16 09:49:40 UTC
(commons-lang) branch master updated: Fix JavaDoc grammar issues (#1246)
This is an automated email from the ASF dual-hosted git repository.
sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new 59a679310 Fix JavaDoc grammar issues (#1246)
59a679310 is described below
commit 59a679310a39331c4c54e8858408f5213f70dbc2
Author: Dávid Szigecsán <si...@gmail.com>
AuthorDate: Tue Jul 16 11:49:34 2024 +0200
Fix JavaDoc grammar issues (#1246)
* Remove dangling JavaDoc
* Fix grammar issues
---------
Co-authored-by: David Szigecsan <da...@sagemcom.com>
---
.../java/org/apache/commons/lang3/ArrayUtils.java | 2 +-
.../java/org/apache/commons/lang3/BooleanUtils.java | 2 +-
src/main/java/org/apache/commons/lang3/Range.java | 2 +-
.../java/org/apache/commons/lang3/StringUtils.java | 18 +++++++++---------
.../org/apache/commons/lang3/SystemProperties.java | 20 --------------------
.../apache/commons/lang3/builder/EqualsBuilder.java | 2 +-
.../commons/lang3/concurrent/ConcurrentUtils.java | 2 +-
.../apache/commons/lang3/function/TriConsumer.java | 2 +-
.../java/org/apache/commons/lang3/math/Fraction.java | 2 +-
.../org/apache/commons/lang3/time/DateUtils.java | 4 ++--
10 files changed, 18 insertions(+), 38 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
index 08a34835a..d1b41a4e7 100644
--- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
@@ -3240,7 +3240,7 @@ public class ArrayUtils {
}
/**
- * Compares two arrays, using equals(), handling multi-dimensional arrays
+ * Compares two arrays, using equals(), handling multidimensional arrays
* correctly.
* <p>
* Multi-dimensional primitive arrays are also handled correctly by this method.
diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
index 13585b299..f8f93fa75 100644
--- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java
+++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
@@ -960,7 +960,7 @@ public class BooleanUtils {
}
/**
- * Converts a Boolean to a Integer using the convention that
+ * Converts a Boolean to an Integer using the convention that
* {@code zero} is {@code false}.
*
* <p>{@code null} will be converted to {@code null}.</p>
diff --git a/src/main/java/org/apache/commons/lang3/Range.java b/src/main/java/org/apache/commons/lang3/Range.java
index ab0c67a5f..1ceb8329e 100644
--- a/src/main/java/org/apache/commons/lang3/Range.java
+++ b/src/main/java/org/apache/commons/lang3/Range.java
@@ -289,7 +289,7 @@ public class Range<T> implements Serializable {
}
/**
- * Compares this range to another object to test if they are equal..
+ * Compares this range to another object to test if they are equal.
*
* <p>To be equal, the minimum and maximum values must be equal, which
* ignores any differences in the comparator.</p>
diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java
index fa3a69071..82612f277 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -1742,7 +1742,7 @@ public class StringUtils {
}
/**
- * Check if a CharSequence ends with a specified suffix (optionally case insensitive).
+ * Check if a CharSequence ends with a specified suffix (optionally case-insensitive).
*
* @see String#endsWith(String)
* @param str the CharSequence to check, may be null
@@ -1797,7 +1797,7 @@ public class StringUtils {
}
/**
- * Case insensitive check if a CharSequence ends with a specified suffix.
+ * Case-insensitive check if a CharSequence ends with a specified suffix.
*
* <p>{@code null}s are handled without exceptions. Two {@code null}
* references are considered to be equal. The comparison is case insensitive.</p>
@@ -5958,7 +5958,7 @@ public class StringUtils {
}
/**
- * Case insensitive removal of a substring if it is at the end of a source string,
+ * Case-insensitive removal of a substring if it is at the end of a source string,
* otherwise returns the source string.
*
* <p>A {@code null} source string will return {@code null}.
@@ -6043,7 +6043,7 @@ public class StringUtils {
}
/**
- * Case insensitive removal of all occurrences of a substring from within
+ * Case-insensitive removal of all occurrences of a substring from within
* the source string.
*
* <p>
@@ -6178,7 +6178,7 @@ public class StringUtils {
}
/**
- * Case insensitive removal of a substring if it is at the beginning of a source string,
+ * Case-insensitive removal of a substring if it is at the beginning of a source string,
* otherwise returns the source string.
*
* <p>A {@code null} source string will return {@code null}.
@@ -8024,7 +8024,7 @@ public class StringUtils {
}
/**
- * Check if a CharSequence starts with a specified prefix (optionally case insensitive).
+ * Check if a CharSequence starts with a specified prefix (optionally case-insensitive).
*
* @see String#startsWith(String)
* @param str the CharSequence to check, may be null
@@ -8081,7 +8081,7 @@ public class StringUtils {
}
/**
- * Case insensitive check if a CharSequence starts with a specified prefix.
+ * Case-insensitive check if a CharSequence starts with a specified prefix.
*
* <p>{@code null}s are handled without exceptions. Two {@code null}
* references are considered to be equal. The comparison is case insensitive.</p>
@@ -9013,10 +9013,10 @@ public class StringUtils {
}
/**
- * Converts the given source String as a upper-case using the {@link Locale#ROOT} locale in a null-safe manner.
+ * Converts the given source String as an upper-case using the {@link Locale#ROOT} locale in a null-safe manner.
*
* @param source A source String or null.
- * @return the given source String as a upper-case using the {@link Locale#ROOT} locale or null.
+ * @return the given source String as an upper-case using the {@link Locale#ROOT} locale or null.
* @since 3.10
*/
public static String toRootUpperCase(final String source) {
diff --git a/src/main/java/org/apache/commons/lang3/SystemProperties.java b/src/main/java/org/apache/commons/lang3/SystemProperties.java
index 1c2d03653..9246975f9 100644
--- a/src/main/java/org/apache/commons/lang3/SystemProperties.java
+++ b/src/main/java/org/apache/commons/lang3/SystemProperties.java
@@ -2456,26 +2456,6 @@ public final class SystemProperties {
return getProperty(JAVA_UTIL_LOGGING_CONFIG_FILE);
}
- /**
- * Gets the current value from the system properties map.
- * <p>
- * Returns {@code null} if the property cannot be read due to a {@link SecurityException}.
- * </p>
- *
- * @return the current value from the system properties map.
- * @since 3.15.0
- */
-
- /**
- * Gets the current value from the system properties map.
- * <p>
- * Returns {@code null} if the property cannot be read due to a {@link SecurityException}.
- * </p>
- *
- * @return the current value from the system properties map.
- * @since 3.15.0
- */
-
/**
* Gets the current value from the system properties map.
* <p>
diff --git a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
index a4adb1485..93ac5e99a 100644
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
@@ -1033,7 +1033,7 @@ public class EqualsBuilder implements Builder<Boolean> {
/**
* Sets {@link Class}es whose instances should be compared by calling their {@code equals}
- * although being in recursive mode. So the fields of theses classes will not be compared recursively by reflection.
+ * although being in recursive mode. So the fields of these classes will not be compared recursively by reflection.
*
* <p>Here you should name classes having non-transient fields which are cache fields being set lazily.<br>
* Prominent example being {@link String} class with its hash code cache field. Due to the importance
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
index 70cb75083..7ad31d13b 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
@@ -25,7 +25,7 @@ import org.apache.commons.lang3.Validate;
import org.apache.commons.lang3.exception.ExceptionUtils;
/**
- * An utility class providing functionality related to the {@code
+ * A utility class providing functionality related to the {@code
* java.util.concurrent} package.
*
* @since 3.0
diff --git a/src/main/java/org/apache/commons/lang3/function/TriConsumer.java b/src/main/java/org/apache/commons/lang3/function/TriConsumer.java
index d0ba9b466..565041b8b 100644
--- a/src/main/java/org/apache/commons/lang3/function/TriConsumer.java
+++ b/src/main/java/org/apache/commons/lang3/function/TriConsumer.java
@@ -23,7 +23,7 @@ import java.util.function.Consumer;
/**
* Represents an operation that accepts three input arguments and returns no result. This is the three-arity
* specialization of {@link Consumer}. Unlike most other functional interfaces, {@link TriConsumer} is expected to
- * operate via side-effects.
+ * operate via side effects.
*
* <p>
* This is a {@link FunctionalInterface} whose functional method is {@link #accept(Object, Object, Object)}.
diff --git a/src/main/java/org/apache/commons/lang3/math/Fraction.java b/src/main/java/org/apache/commons/lang3/math/Fraction.java
index c1e8a8ee7..d1ff02c06 100644
--- a/src/main/java/org/apache/commons/lang3/math/Fraction.java
+++ b/src/main/java/org/apache/commons/lang3/math/Fraction.java
@@ -612,7 +612,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * Compares this fraction to another object to test if they are equal..
+ * Compares this fraction to another object to test if they are equal.
*
* <p>To be equal, both values must be equal. Thus 2/4 is not equal to 1/2.</p>
*
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 5bfed11b6..7db53628c 100644
--- a/src/main/java/org/apache/commons/lang3/time/DateUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/DateUtils.java
@@ -1229,7 +1229,7 @@ public class DateUtils {
final int max = val.getActualMaximum(aField[0]);
//Calculate the offset from the minimum allowed value
offset = val.get(aField[0]) - min;
- //Set roundUp if this is more than half way between the minimum and maximum
+ //Set roundUp if this is more than halfway between the minimum and maximum
roundUp = offset > (max - min) / 2;
}
//We need to remove this field
@@ -1282,7 +1282,7 @@ public class DateUtils {
/**
* Parses a string representing a date by trying a variety of different parsers,
- * using the default date format symbols for the given locale..
+ * using the default date format symbols for the given locale.
*
* <p>The parse will try each parse pattern in turn.
* A parse is only deemed successful if it parses the whole of the input string.