Skip to content

Commit

Permalink
Fix Javadoc doclint WARNING messages on Java 17.
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Mar 21, 2022
1 parent a9f9ba4 commit 0486d06
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 9 deletions.
2 changes: 2 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -734,6 +734,7 @@
<addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
</manifest>
</archive>
<doclint>all</doclint>
</configuration>
<executions>
<execution>
Expand Down Expand Up @@ -856,6 +857,7 @@
<addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
</manifest>
</archive>
<doclint>all</doclint>
</configuration>
</plugin>
<plugin>
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/lang3/JavaVersion.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -193,7 +193,7 @@ public boolean atLeast(final JavaVersion requiredVersion) {
* <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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

/**
Expand Down
1 change: 0 additions & 1 deletion src/main/java/org/apache/commons/lang3/SystemUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -1833,7 +1833,6 @@ public static boolean isJavaAwtHeadless() {
* <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
Expand Down
5 changes: 4 additions & 1 deletion src/main/java/org/apache/commons/lang3/builder/Diff.java
Original file line number Diff line number Diff line change
Expand Up @@ -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;

/**
Expand All @@ -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(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,10 @@ protected FastDateFormat createInstance(final String pattern, final TimeZone tim
}
};

/** Our fast printer. */
private final FastDatePrinter printer;

/** Our fast parser. */
private final FastDateParser parser;

/**
Expand Down
23 changes: 18 additions & 5 deletions src/main/java/org/apache/commons/lang3/time/FastDateParser.java
Original file line number Diff line number Diff line change
Expand Up @@ -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();

/**
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ public final class FluentBitSet implements Cloneable, Serializable {

private static final long serialVersionUID = 1L;

/**
* Working BitSet.
*/
private final BitSet bitSet;

/**
Expand Down

0 comments on commit 0486d06

Please sign in to comment.