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-lang.git
The following commit(s) were added to refs/heads/master by this push:
new 745a70091 Fix malformed Javadoc comments
745a70091 is described below
commit 745a70091f6bc659da2d7f71374859125538b34c
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Dec 13 15:33:15 2025 -0500
Fix malformed Javadoc comments
---
src/main/java/org/apache/commons/lang3/CharSet.java | 8 ++++----
src/main/java/org/apache/commons/lang3/ObjectUtils.java | 16 ++++++++--------
.../org/apache/commons/lang3/SerializationUtils.java | 6 +++---
src/main/java/org/apache/commons/lang3/StringUtils.java | 2 +-
.../commons/lang3/builder/ReflectionToStringBuilder.java | 4 ++--
.../java/org/apache/commons/lang3/math/NumberUtils.java | 8 ++++----
.../org/apache/commons/lang3/mutable/MutableDouble.java | 4 ++--
.../org/apache/commons/lang3/mutable/MutableFloat.java | 4 ++--
.../apache/commons/lang3/reflect/ConstructorUtils.java | 8 ++++----
.../java/org/apache/commons/lang3/util/FluentBitSet.java | 8 ++++----
10 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java
b/src/main/java/org/apache/commons/lang3/CharSet.java
index 96089b785..883cfa286 100644
--- a/src/main/java/org/apache/commons/lang3/CharSet.java
+++ b/src/main/java/org/apache/commons/lang3/CharSet.java
@@ -106,10 +106,10 @@ public class CharSet implements Serializable {
*
* <p>The matching order is:</p>
* <ol>
- * <li>Negated multi character range, such as "^a-e"
- * <li>Ordinary multi character range, such as "a-e"
- * <li>Negated single character, such as "^a"
- * <li>Ordinary single character, such as "a"
+ * <li>Negated multi character range, such as "^a-e"</li>
+ * <li>Ordinary multi character range, such as "a-e"</li>
+ * <li>Negated single character, such as "^a"</li>
+ * <li>Ordinary single character, such as "a"</li>
* </ol>
*
* <p>Matching works left to right. Once a match is found the
diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java
b/src/main/java/org/apache/commons/lang3/ObjectUtils.java
index 6d29fc07b..e62fd4c34 100644
--- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java
@@ -1022,10 +1022,10 @@ public static boolean isNotEmpty(final Object object) {
* @param values the set of comparable values, may be null.
* @return
* <ul>
- * <li>If any objects are non-null and unequal, the greater object.
- * <li>If all objects are non-null and equal, the first.
- * <li>If any of the comparables are null, the greater of the
non-null objects.
- * <li>If all the comparables are null, null is returned.
+ * <li>If any objects are non-null and unequal, the greater
object.</li>
+ * <li>If all objects are non-null and equal, the first.</li>
+ * <li>If any of the comparables are null, the greater of the
non-null objects.</li>
+ * <li>If all the comparables are null, null is returned.</li>
* </ul>
*/
@SafeVarargs
@@ -1092,10 +1092,10 @@ public static <T extends Comparable<? super T>> T
median(final T... items) {
* @param values the set of comparable values, may be null
* @return
* <ul>
- * <li>If any objects are non-null and unequal, the lesser object.
- * <li>If all objects are non-null and equal, the first.
- * <li>If any of the comparables are null, the lesser of the
non-null objects.
- * <li>If all the comparables are null, null is returned.
+ * <li>If any objects are non-null and unequal, the lesser
object.</li>
+ * <li>If all objects are non-null and equal, the first.</li>
+ * <li>If any of the comparables are null, the lesser of the
non-null objects.</li>
+ * <li>If all the comparables are null, null is returned.</li>
* </ul>
*/
@SafeVarargs
diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
index 4e1197841..5a41cc7c5 100644
--- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
@@ -32,9 +32,9 @@
* on serialization.
*
* <ul>
- * <li>Deep clone using serialization
- * <li>Serialize managing finally and IOException
- * <li>Deserialize managing finally and IOException
+ * <li>Deep clone using serialization</li>
+ * <li>Serialize managing finally and IOException</li>
+ * <li>Deserialize managing finally and IOException</li>
* </ul>
*
* <p>This class throws exceptions for invalid {@code null} inputs.
diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java
b/src/main/java/org/apache/commons/lang3/StringUtils.java
index b12e481dc..e7fd432cd 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -51,7 +51,7 @@
* <li><strong>endsWith</strong>
* - check if a String ends with a suffix in a null-safe manner</li>
* <li><strong>IndexOf/LastIndexOf/Contains</strong>
- * - null-safe index-of checks
+ * - null-safe index-of checks</li>
*
<li><strong>IndexOfAny/LastIndexOfAny/IndexOfAnyBut/LastIndexOfAnyBut</strong>
* - index-of any of a set of Strings</li>
* <li><strong>ContainsOnly/ContainsNone/ContainsAny</strong>
diff --git
a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
index e3080bdc2..418e96fd1 100644
---
a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
+++
b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
@@ -591,8 +591,8 @@ public <T> ReflectionToStringBuilder(
/**
* Returns whether or not to append the given {@link Field}.
* <ul>
- * <li>Transient fields are appended only if {@link #isAppendTransients()}
returns {@code true}.
- * <li>Static fields are appended only if {@link #isAppendStatics()}
returns {@code true}.
+ * <li>Transient fields are appended only if {@link #isAppendTransients()}
returns {@code true}.</li>
+ * <li>Static fields are appended only if {@link #isAppendStatics()}
returns {@code true}.</li>
* <li>Inner class fields are not appended.</li>
* </ul>
*
diff --git a/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
b/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
index df22652fb..740a15544 100644
--- a/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
+++ b/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
@@ -763,10 +763,10 @@ private static boolean isSign(final char ch) {
* Given {@code s = mant + "." + dec}:
* </p>
* <ul>
- * <li>{@code true} if s is {@code "0.0"}
- * <li>{@code true} if s is {@code "0."}
- * <li>{@code true} if s is {@code ".0"}
- * <li>{@code false} otherwise (this assumes {@code "."} is not possible)
+ * <li>{@code true} if s is {@code "0.0"}</li>
+ * <li>{@code true} if s is {@code "0."}</li>
+ * <li>{@code true} if s is {@code ".0"}</li>
+ * <li>{@code false} otherwise (this assumes {@code "."} is not
possible)</li>
* </ul>
*
* @param mant the mantissa decimal digits before the decimal point (sign
must be removed; never null).
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
b/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
index f05e8fdee..605ae6d77 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
@@ -188,9 +188,9 @@ public double doubleValue() {
* </p>
* <ul>
* <li>If {@code d1} and {@code d2} both represent {@code Double.NaN},
then the {@code equals} method returns {@code true}, even though
- * {@code Double.NaN == Double.NaN} has the value {@code false}.
+ * {@code Double.NaN == Double.NaN} has the value {@code false}.</li>
* <li>If {@code d1} represents {@code +0.0} while {@code d2} represents
{@code -0.0}, or vice versa, the {@code equal} test has the value {@code false},
- * even though {@code +0.0 == -0.0} has the value {@code true}. This
allows hashtables to operate properly.
+ * even though {@code +0.0 == -0.0} has the value {@code true}. This
allows hashtables to operate properly.</li>
* </ul>
*
* @param obj the object to compare with, null returns false.
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
b/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
index 0ca2de0b1..f9df38d30 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
@@ -188,9 +188,9 @@ public double doubleValue() {
* </p>
* <ul>
* <li>If {@code f1} and {@code f2} both represent {@code Float.NaN}, then
the {@code equals} method returns {@code true}, even though
- * {@code Float.NaN == Float.NaN} has the value {@code false}.
+ * {@code Float.NaN == Float.NaN} has the value {@code false}.</li>
* <li>If {@code f1} represents {@code +0.0f} while {@code f2} represents
{@code -0.0f}, or vice versa, the {@code equal} test has the value {@code
false},
- * even though {@code 0.0f == -0.0f} has the value {@code true}.
+ * even though {@code 0.0f == -0.0f} has the value {@code true}.</li>
* </ul>
* <p>
* This definition allows hashtables to operate properly.
diff --git
a/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
b/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
index 493a81866..2fb8660ef 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
@@ -166,7 +166,7 @@ public static <T> Constructor<T>
getMatchingAccessibleConstructor(final Class<T>
* <li>the number of actual and formal
parameters differ; or</li>
* <li>an unwrapping conversion for
primitive arguments fails; or</li>
* <li>after possible unwrapping, a
parameter value cannot be converted to the corresponding formal parameter type
by a
- * method invocation conversion; if
this constructor pertains to an enum type.
+ * method invocation conversion; if
this constructor pertains to an enum type.</li>
* </ul>
* @throws InstantiationException Thrown if the class that declares
the underlying constructor represents an abstract class.
* @throws InvocationTargetException Thrown if the underlying
constructor throws an exception.
@@ -203,7 +203,7 @@ public static <T> T invokeConstructor(final Class<T> cls,
final Object... args)
* <li>the number of actual and formal
parameters differ; or</li>
* <li>an unwrapping conversion for
primitive arguments fails; or</li>
* <li>after possible unwrapping, a
parameter value cannot be converted to the corresponding formal parameter type
by a
- * method invocation conversion; if
this constructor pertains to an enum type.
+ * method invocation conversion; if
this constructor pertains to an enum type.</li>
* </ul>
* @throws InstantiationException Thrown if the class that declares
the underlying constructor represents an abstract class.
* @throws InvocationTargetException Thrown if the underlying
constructor throws an exception.
@@ -244,7 +244,7 @@ public static <T> T invokeConstructor(final Class<T> cls,
final Object[] args, f
* <li>the number of actual and formal
parameters differ; or</li>
* <li>an unwrapping conversion for
primitive arguments fails; or</li>
* <li>after possible unwrapping, a
parameter value cannot be converted to the corresponding formal parameter type
by a
- * method invocation conversion; if
this constructor pertains to an enum type.
+ * method invocation conversion; if
this constructor pertains to an enum type.</li>
* </ul>
* @throws InstantiationException Thrown if the class that declares
the underlying constructor represents an abstract class.
* @throws InvocationTargetException Thrown if the underlying
constructor throws an exception.
@@ -282,7 +282,7 @@ public static <T> T invokeExactConstructor(final Class<T>
cls, final Object... a
* <li>the number of actual and formal
parameters differ; or</li>
* <li>an unwrapping conversion for
primitive arguments fails; or</li>
* <li>after possible unwrapping, a
parameter value cannot be converted to the corresponding formal parameter type
by a
- * method invocation conversion; if
this constructor pertains to an enum type.
+ * method invocation conversion; if
this constructor pertains to an enum type.</li>
* </ul>
* @throws InstantiationException Thrown if the class that declares
the underlying constructor represents an abstract class.
* @throws InvocationTargetException Thrown if the underlying
constructor throws an exception.
diff --git a/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
b/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
index b98bd7125..204e0b763 100644
--- a/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
+++ b/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
@@ -575,9 +575,9 @@ public String toString() {
* has the value {@code true} if and only if one of the following
statements holds:
* <ul>
* <li>The bit initially has the value {@code true}, and the corresponding
bit in the argument has the value
- * {@code false}.
+ * {@code false}.</li>
* <li>The bit initially has the value {@code false}, and the
corresponding bit in the argument has the value
- * {@code true}.
+ * {@code true}.</li>
* </ul>
*
* @param set a bit set
@@ -593,9 +593,9 @@ public FluentBitSet xor(final BitSet set) {
* has the value {@code true} if and only if one of the following
statements holds:
* <ul>
* <li>The bit initially has the value {@code true}, and the corresponding
bit in the argument has the value
- * {@code false}.
+ * {@code false}.</li>
* <li>The bit initially has the value {@code false}, and the
corresponding bit in the argument has the value
- * {@code true}.
+ * {@code true}.</li>
* </ul>
*
* @param set a bit set
