Fix JavaDoc grammar issues (#1246)

* Remove dangling JavaDoc

* Fix grammar issues

---------

Co-authored-by: David Szigecsan <david.szigecsan@sagemcom.com>
This commit is contained in:
Dávid Szigecsán 2024-07-16 11:49:34 +02:00 committed by GitHub
parent 7914b958b8
commit 59a679310a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 18 additions and 38 deletions

View File

@ -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. * correctly.
* <p> * <p>
* Multi-dimensional primitive arrays are also handled correctly by this method. * Multi-dimensional primitive arrays are also handled correctly by this method.

View File

@ -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}. * {@code zero} is {@code false}.
* *
* <p>{@code null} will be converted to {@code null}.</p> * <p>{@code null} will be converted to {@code null}.</p>

View File

@ -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 * <p>To be equal, the minimum and maximum values must be equal, which
* ignores any differences in the comparator.</p> * ignores any differences in the comparator.</p>

View File

@ -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) * @see String#endsWith(String)
* @param str the CharSequence to check, may be null * @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} * <p>{@code null}s are handled without exceptions. Two {@code null}
* references are considered to be equal. The comparison is case insensitive.</p> * 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. * otherwise returns the source string.
* *
* <p>A {@code null} source string will return {@code null}. * <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. * the source string.
* *
* <p> * <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. * otherwise returns the source string.
* *
* <p>A {@code null} source string will return {@code null}. * <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) * @see String#startsWith(String)
* @param str the CharSequence to check, may be null * @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} * <p>{@code null}s are handled without exceptions. Two {@code null}
* references are considered to be equal. The comparison is case insensitive.</p> * 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. * @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 * @since 3.10
*/ */
public static String toRootUpperCase(final String source) { public static String toRootUpperCase(final String source) {

View File

@ -2456,26 +2456,6 @@ public final class SystemProperties {
return getProperty(JAVA_UTIL_LOGGING_CONFIG_FILE); 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. * Gets the current value from the system properties map.
* <p> * <p>

View File

@ -1033,7 +1033,7 @@ public class EqualsBuilder implements Builder<Boolean> {
/** /**
* Sets {@link Class}es whose instances should be compared by calling their {@code equals} * 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> * <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 * Prominent example being {@link String} class with its hash code cache field. Due to the importance

View File

@ -25,7 +25,7 @@ import org.apache.commons.lang3.Validate;
import org.apache.commons.lang3.exception.ExceptionUtils; 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. * java.util.concurrent} package.
* *
* @since 3.0 * @since 3.0

View File

@ -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 * 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 * specialization of {@link Consumer}. Unlike most other functional interfaces, {@link TriConsumer} is expected to
* operate via side-effects. * operate via side effects.
* *
* <p> * <p>
* This is a {@link FunctionalInterface} whose functional method is {@link #accept(Object, Object, Object)}. * This is a {@link FunctionalInterface} whose functional method is {@link #accept(Object, Object, Object)}.

View File

@ -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> * <p>To be equal, both values must be equal. Thus 2/4 is not equal to 1/2.</p>
* *

View File

@ -1229,7 +1229,7 @@ public class DateUtils {
final int max = val.getActualMaximum(aField[0]); final int max = val.getActualMaximum(aField[0]);
//Calculate the offset from the minimum allowed value //Calculate the offset from the minimum allowed value
offset = val.get(aField[0]) - min; 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; roundUp = offset > (max - min) / 2;
} }
//We need to remove this field //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, * 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. * <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. * A parse is only deemed successful if it parses the whole of the input string.