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 0486d06 Fix Javadoc doclint WARNING messages on Java 17.
0486d06 is described below
commit 0486d069b51ab19faee3402c5bb806a769f88694
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Mar 21 10:55:13 2022 -0400
Fix Javadoc doclint WARNING messages on Java 17.
---
pom.xml | 2 ++
.../java/org/apache/commons/lang3/JavaVersion.java | 4 ++--
.../commons/lang3/NotImplementedException.java | 1 +
.../java/org/apache/commons/lang3/SystemUtils.java | 1 -
.../org/apache/commons/lang3/builder/Diff.java | 5 ++++-
.../commons/lang3/text/ExtendedMessageFormat.java | 7 +++++++
.../apache/commons/lang3/time/FastDateFormat.java | 3 +++
.../apache/commons/lang3/time/FastDateParser.java | 23 +++++++++++++++++-----
.../apache/commons/lang3/util/FluentBitSet.java | 3 +++
9 files changed, 40 insertions(+), 9 deletions(-)
diff --git a/pom.xml b/pom.xml
index a28b732..22f4975 100644
--- a/pom.xml
+++ b/pom.xml
@@ -734,6 +734,7 @@
<addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
</manifest>
</archive>
+ <doclint>all</doclint>
</configuration>
<executions>
<execution>
@@ -856,6 +857,7 @@
<addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
</manifest>
</archive>
+ <doclint>all</doclint>
</configuration>
</plugin>
<plugin>
diff --git a/src/main/java/org/apache/commons/lang3/JavaVersion.java
b/src/main/java/org/apache/commons/lang3/JavaVersion.java
index 2493951..fc9a723 100644
--- a/src/main/java/org/apache/commons/lang3/JavaVersion.java
+++ b/src/main/java/org/apache/commons/lang3/JavaVersion.java
@@ -180,7 +180,7 @@ public enum JavaVersion {
* <p>Whether this version of Java is at least the version of Java passed
in.</p>
*
* <p>For example:<br>
- * {@code myVersion.atLeast(JavaVersion.JAVA_1_4)}<p>
+ * {@code myVersion.atLeast(JavaVersion.JAVA_1_4)}</p>
*
* @param requiredVersion the version to check against, not null
* @return true if this version is equal to or greater than the specified
version
@@ -193,7 +193,7 @@ public enum JavaVersion {
* <p>Whether this version of Java is at most the version of Java passed
in.</p>
*
* <p>For example:<br>
- * {@code myVersion.atMost(JavaVersion.JAVA_1_4)}<p>
+ * {@code myVersion.atMost(JavaVersion.JAVA_1_4)}</p>
*
* @param requiredVersion the version to check against, not null
* @return true if this version is equal to or greater than the specified
version
diff --git
a/src/main/java/org/apache/commons/lang3/NotImplementedException.java
b/src/main/java/org/apache/commons/lang3/NotImplementedException.java
index 2ad7463..2a9f508 100644
--- a/src/main/java/org/apache/commons/lang3/NotImplementedException.java
+++ b/src/main/java/org/apache/commons/lang3/NotImplementedException.java
@@ -44,6 +44,7 @@ public class NotImplementedException extends
UnsupportedOperationException {
private static final long serialVersionUID = 20131021L;
+ /** A resource for more information regarding the lack of implementation.
*/
private final String code;
/**
diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java
b/src/main/java/org/apache/commons/lang3/SystemUtils.java
index 5e4a9c1..7e0f566 100644
--- a/src/main/java/org/apache/commons/lang3/SystemUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java
@@ -1833,7 +1833,6 @@ public class SystemUtils {
* <p>
* Is the Java version at least the requested version.
* </p>
- * <p>
*
* @param requiredVersion the required version, for example 1.31f
* @return {@code true} if the actual version is equal or greater than the
required version
diff --git a/src/main/java/org/apache/commons/lang3/builder/Diff.java
b/src/main/java/org/apache/commons/lang3/builder/Diff.java
index 7b062d0..47509b6 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Diff.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Diff.java
@@ -44,7 +44,10 @@ public abstract class Diff<T> extends Pair<T, T> {
private static final long serialVersionUID = 1L;
+ /** The field type. */
private final Type type;
+
+ /** The field name. */
private final String fieldName;
/**
@@ -53,7 +56,7 @@ public abstract class Diff<T> extends Pair<T, T> {
* </p>
*
* @param fieldName
- * the name of the field
+ * the field name
*/
protected Diff(final String fieldName) {
this.type = ObjectUtils.defaultIfNull(
diff --git
a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
index 65a4a6c..4a66471 100644
--- a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
+++ b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
@@ -81,7 +81,14 @@ public class ExtendedMessageFormat extends MessageFormat {
private static final char START_FE = '{';
private static final char QUOTE = '\'';
+ /**
+ * To pattern string.
+ */
private String toPattern;
+
+ /**
+ * Our registry of FormatFactory.
+ */
private final Map<String, ? extends FormatFactory> registry;
/**
diff --git a/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
b/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
index ecc7f64..893b477 100644
--- a/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
+++ b/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
@@ -106,7 +106,10 @@ public class FastDateFormat extends Format implements
DateParser, DatePrinter {
}
};
+ /** Our fast printer. */
private final FastDatePrinter printer;
+
+ /** Our fast parser. */
private final FastDateParser parser;
/**
diff --git a/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
b/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
index fea3347..8b70a25 100644
--- a/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
+++ b/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
@@ -83,19 +83,32 @@ public class FastDateParser implements DateParser,
Serializable {
static final Locale JAPANESE_IMPERIAL = new Locale("ja", "JP", "JP");
- // defining fields
+ /** Input pattern. */
private final String pattern;
+
+ /** Input TimeZone. */
private final TimeZone timeZone;
+
+ /** Input Locale. */
private final Locale locale;
+
+ /**
+ * Century from Date.
+ */
private final int century;
+
+ /**
+ * Start year from Date.
+ */
private final int startYear;
- // derived fields
+ /** Initialized from Calendar. */
private transient List<StrategyAndWidth> patterns;
- // comparator used to sort regex alternatives
- // alternatives should be ordered longer first, and shorter last.
('february' before 'feb')
- // all entries must be lowercase by locale.
+ /**
+ * comparator used to sort regex alternatives. Alternatives should be
ordered longer first, and shorter last.
+ * ('february' before 'feb'). All entries must be lower-case by locale.
+ */
private static final Comparator<String> LONGER_FIRST_LOWERCASE =
Comparator.reverseOrder();
/**
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 11416c0..3c1d0d2 100644
--- a/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
+++ b/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
@@ -32,6 +32,9 @@ public final class FluentBitSet implements Cloneable,
Serializable {
private static final long serialVersionUID = 1L;
+ /**
+ * Working BitSet.
+ */
private final BitSet bitSet;
/**
