[commons-io] branch master updated: Javadoc.

[gg...@apache.org]

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 6332875  Javadoc.
6332875 is described below

commit 6332875ad9f7f82bb7d9415d18a8265065e32321
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 2 19:06:13 2020 -0400

    Javadoc.
---
 .../io/comparator/LastModifiedFileComparator.java  | 22 ++++++++++------------
 1 file changed, 10 insertions(+), 12 deletions(-)

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 9e7a73a..cf47a1b 100644
--- a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
@@ -28,14 +28,14 @@ import java.util.Comparator;
  * by their last modified date/time.
  * <p>
  * Example of sorting a list of files using the
- * {@link #LASTMODIFIED_COMPARATOR} singleton instance:
+ * {@link #INSTANCE} singleton instance:
  * <pre>
  *       List&lt;File&gt; list = ...
  *       ((AbstractFileComparator) LastModifiedFileComparator.LASTMODIFIED_COMPARATOR).sort(list);
  * </pre>
  * <p>
  * Example of doing a <i>reverse</i> sort of an array of files using the
- * {@link #LASTMODIFIED_REVERSE} singleton instance:
+ * {@link #INSTANCE_REVERSE} singleton instance:
  * <pre>
  *       File[] array = ...
  *       ((AbstractFileComparator) LastModifiedFileComparator.LASTMODIFIED_REVERSE).sort(array);
@@ -48,22 +48,20 @@ public class LastModifiedFileComparator extends AbstractFileComparator implement
 
     private static final long serialVersionUID = 7372168004395734046L;
 
-    /** Last modified comparator instance */
+    /** Last modified comparator instance. */
     public static final Comparator<File> LASTMODIFIED_COMPARATOR = new LastModifiedFileComparator();
 
-    /** Reverse last modified comparator instance */
+    /** Reverse last modified comparator instance. */
     public static final Comparator<File> LASTMODIFIED_REVERSE = new ReverseFileComparator(LASTMODIFIED_COMPARATOR);
 
     /**
-     * Compare the last the last modified date/time of two files.
-     *
-     * @param file1 The first file to compare
-     * @param file2 The second file to compare
-     * @return a negative value if the first file's lastmodified date/time
-     * is less than the second, zero if the lastmodified date/time are the
-     * same and a positive value if the first files lastmodified date/time
-     * is greater than the second file.
+     * Compares the last the last modified date/time of two files.
      *
+     * @param file1 The first file to compare.
+     * @param file2 The second file to compare.
+     * @return a negative value if the first file's last modified date/time is less than the second, zero if the last
+     *         modified date/time are the same and a positive value if the first files last modified date/time is
+     *         greater than the second file.
      */
     @Override
     public int compare(final File file1, final File file2) {