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-io.git
The following commit(s) were added to refs/heads/master by this push: new e7b0b92 Fix Javadoc 17 errors. e7b0b92 is described below commit e7b0b9231cd815ef4907f65c43e676fd83ed38d5 Author: Gary Gregory <gardgreg...@gmail.com> AuthorDate: Sat Sep 11 09:02:47 2021 -0700 Fix Javadoc 17 errors. --- src/main/java/org/apache/commons/io/FileUtils.java | 1 - .../org/apache/commons/io/comparator/DefaultFileComparator.java | 4 +++- .../org/apache/commons/io/comparator/DirectoryFileComparator.java | 4 +++- .../org/apache/commons/io/comparator/ExtensionFileComparator.java | 4 +++- .../apache/commons/io/comparator/LastModifiedFileComparator.java | 4 +++- .../java/org/apache/commons/io/comparator/NameFileComparator.java | 4 +++- .../java/org/apache/commons/io/comparator/PathFileComparator.java | 6 ++++-- src/main/java/org/apache/commons/io/input/TailerListener.java | 4 ++-- 8 files changed, 21 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/apache/commons/io/FileUtils.java b/src/main/java/org/apache/commons/io/FileUtils.java index 3fea3b1..519edc5 100644 --- a/src/main/java/org/apache/commons/io/FileUtils.java +++ b/src/main/java/org/apache/commons/io/FileUtils.java @@ -1923,7 +1923,6 @@ public class FileUtils { * <p> * The resulting iterator MUST be consumed in its entirety in order to close its underlying stream. * </p> - * <p> * * @param directory the directory to search in * @param extensions an array of extensions, ex. {"java","xml"}. If this diff --git a/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java b/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java index 7f54c30..e85a1f8 100644 --- a/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java @@ -25,9 +25,11 @@ import java.util.Comparator; * <p> * This comparator can be used to sort lists or arrays of files * by using the default file comparison. + * </p> * <p> * Example of sorting a list of files using the * {@link #DEFAULT_COMPARATOR} singleton instance: + * </p> * <pre> * List<File> list = ... * ((AbstractFileComparator) DefaultFileComparator.DEFAULT_COMPARATOR).sort(list); @@ -35,11 +37,11 @@ import java.util.Comparator; * <p> * Example of doing a <i>reverse</i> sort of an array of files using the * {@link #DEFAULT_REVERSE} singleton instance: + * </p> * <pre> * File[] array = ... * ((AbstractFileComparator) DefaultFileComparator.DEFAULT_REVERSE).sort(array); * </pre> - * <p> * * @since 1.4 */ diff --git a/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java b/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java index fc79432..b72ed86 100644 --- a/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java @@ -24,9 +24,11 @@ import java.util.Comparator; * Compare two files using the {@link File#isDirectory()} method. * <p> * This comparator can be used to sort lists or arrays by directories and files. + * </p> * <p> * Example of sorting a list of files/directories using the * {@link #DIRECTORY_COMPARATOR} singleton instance: + * </p> * <pre> * List<File> list = ... * ((AbstractFileComparator) DirectoryFileComparator.DIRECTORY_COMPARATOR).sort(list); @@ -34,11 +36,11 @@ import java.util.Comparator; * <p> * Example of doing a <i>reverse</i> sort of an array of files/directories using the * {@link #DIRECTORY_REVERSE} singleton instance: + * </p> * <pre> * File[] array = ... * ((AbstractFileComparator) DirectoryFileComparator.DIRECTORY_REVERSE).sort(array); * </pre> - * <p> * * @since 2.0 */ diff --git a/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java b/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java index f5503cd..1e3edad 100644 --- a/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java @@ -32,9 +32,11 @@ import org.apache.commons.io.IOCase; * system dependent case sensitive way. A number of singleton instances * are provided for the various case sensitivity options (using {@link IOCase}) * and the reverse of those options. + * </p> * <p> * Example of a <i>case-sensitive</i> file extension sort using the * {@link #EXTENSION_COMPARATOR} singleton instance: + * </p> * <pre> * List<File> list = ... * ((AbstractFileComparator) ExtensionFileComparator.EXTENSION_COMPARATOR).sort(list); @@ -42,11 +44,11 @@ import org.apache.commons.io.IOCase; * <p> * Example of a <i>reverse case-insensitive</i> file extension sort using the * {@link #EXTENSION_INSENSITIVE_REVERSE} singleton instance: + * </p> * <pre> * File[] array = ... * ((AbstractFileComparator) ExtensionFileComparator.EXTENSION_INSENSITIVE_REVERSE).sort(array); * </pre> - * <p> * * @since 1.4 */ diff --git a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java index bd2d350..60d4517 100644 --- a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java @@ -28,9 +28,11 @@ import org.apache.commons.io.FileUtils; * <p> * This comparator can be used to sort lists or arrays of files * by their last modified date/time. + * </p> * <p> * Example of sorting a list of files using the * {@link #LASTMODIFIED_COMPARATOR} singleton instance: + * </p> * <pre> * List<File> list = ... * ((AbstractFileComparator) LastModifiedFileComparator.LASTMODIFIED_COMPARATOR).sort(list); @@ -38,11 +40,11 @@ import org.apache.commons.io.FileUtils; * <p> * Example of doing a <i>reverse</i> sort of an array of files using the * {@link #LASTMODIFIED_REVERSE} singleton instance: + * </p> * <pre> * File[] array = ... * ((AbstractFileComparator) LastModifiedFileComparator.LASTMODIFIED_REVERSE).sort(array); * </pre> - * <p> * * @since 1.4 */ diff --git a/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java b/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java index f5731ca..898e227 100644 --- a/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java @@ -30,9 +30,11 @@ import org.apache.commons.io.IOCase; * system dependent case sensitive way. A number of singleton instances * are provided for the various case sensitivity options (using {@link IOCase}) * and the reverse of those options. + * </p> * <p> * Example of a <i>case-sensitive</i> file name sort using the * {@link #NAME_COMPARATOR} singleton instance: + * </p> * <pre> * List<File> list = ... * ((AbstractFileComparator) NameFileComparator.NAME_COMPARATOR).sort(list); @@ -40,11 +42,11 @@ import org.apache.commons.io.IOCase; * <p> * Example of a <i>reverse case-insensitive</i> file name sort using the * {@link #NAME_INSENSITIVE_REVERSE} singleton instance: + * </p> * <pre> * File[] array = ... * ((AbstractFileComparator) NameFileComparator.NAME_INSENSITIVE_REVERSE).sort(array); * </pre> - * <p> * * @since 1.4 */ diff --git a/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java b/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java index a02a29d..bb8e13d 100644 --- a/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java @@ -30,9 +30,11 @@ import org.apache.commons.io.IOCase; * system dependent case sensitive way. A number of singleton instances * are provided for the various case sensitivity options (using {@link IOCase}) * and the reverse of those options. + * </p> * <p> * Example of a <i>case-sensitive</i> file path sort using the * {@link #PATH_COMPARATOR} singleton instance: + * </p> * <pre> * List<File> list = ... * ((AbstractFileComparator) PathFileComparator.PATH_COMPARATOR).sort(list); @@ -40,12 +42,12 @@ import org.apache.commons.io.IOCase; * <p> * Example of a <i>reverse case-insensitive</i> file path sort using the * {@link #PATH_INSENSITIVE_REVERSE} singleton instance: + * </p> * <pre> * File[] array = ... * ((AbstractFileComparator) PathFileComparator.PATH_INSENSITIVE_REVERSE).sort(array); * </pre> - * <p> - * + * * @since 1.4 */ public class PathFileComparator extends AbstractFileComparator implements Serializable { diff --git a/src/main/java/org/apache/commons/io/input/TailerListener.java b/src/main/java/org/apache/commons/io/input/TailerListener.java index 3fb8cba..de8de20 100644 --- a/src/main/java/org/apache/commons/io/input/TailerListener.java +++ b/src/main/java/org/apache/commons/io/input/TailerListener.java @@ -53,8 +53,8 @@ public interface TailerListener { * Handles a line from a Tailer. * <p> * <b>Note:</b> this is called from the tailer thread. - * @param line the line. * </p> + * @param line the line. */ void handle(String line); @@ -62,8 +62,8 @@ public interface TailerListener { * Handles an Exception. * <p> * <b>Note:</b> this is called from the tailer thread. - * @param ex the exception. * </p> + * @param ex the exception. */ void handle(Exception ex);