commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject [commons-io] branch master updated: Javadoc cleanups.
Date Sun, 02 Aug 2020 23:02:45 GMT
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 1a5163c  Javadoc cleanups.
1a5163c is described below

commit 1a5163c13d1abd8167348671bb7d51b1d9f580e1
Author: Gary Gregory <gardgregory@gmail.com>
AuthorDate: Sun Aug 2 19:02:38 2020 -0400

    Javadoc cleanups.
---
 .../commons/io/comparator/ReverseFileComparator.java  | 19 +++++++++----------
 1 file changed, 9 insertions(+), 10 deletions(-)

diff --git a/src/main/java/org/apache/commons/io/comparator/ReverseFileComparator.java b/src/main/java/org/apache/commons/io/comparator/ReverseFileComparator.java
index 5d3925f..d0ddcc2 100644
--- a/src/main/java/org/apache/commons/io/comparator/ReverseFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/ReverseFileComparator.java
@@ -21,8 +21,7 @@ import java.io.Serializable;
 import java.util.Comparator;
 
 /**
- * Reverses the result of comparing two objects using
- * the delegate {@link Comparator}.
+ * Reverses the result of comparing two {@link File} objects using the delegate {@link Comparator}.
  *
  * @since 1.4
  */
@@ -34,7 +33,7 @@ class ReverseFileComparator extends AbstractFileComparator implements Serializab
     /**
      * Construct an instance with the specified delegate {@link Comparator}.
      *
-     * @param delegate The comparator to delegate to
+     * @param delegate The comparator to delegate to.
      */
     public ReverseFileComparator(final Comparator<File> delegate) {
         if (delegate == null) {
@@ -44,12 +43,12 @@ class ReverseFileComparator extends AbstractFileComparator implements
Serializab
     }
 
     /**
-     * Compare using the delegate Comparator, but reversing the result.
+     * Compares using the delegate Comparator, reversing the result.
      *
-     * @param file1 The first file to compare
-     * @param file2 The second file to compare
-     * @return the result from the delegate {@link Comparator#compare(Object, Object)}
-     * reversing the value (i.e. positive becomes negative and vice versa)
+     * @param file1 The first file to compare.
+     * @param file2 The second file to compare.
+     * @return the result from the delegate {@link Comparator#compare(Object, Object)} reversing
the value (i.e.
+     *         positive becomes negative and vice versa).
      */
     @Override
     public int compare(final File file1, final File file2) {
@@ -57,9 +56,9 @@ class ReverseFileComparator extends AbstractFileComparator implements Serializab
     }
 
     /**
-     * String representation of this file comparator.
+     * Returns the String representation of this file comparator.
      *
-     * @return String representation of this file comparator
+     * @return String representation of this file comparator.
      */
     @Override
     public String toString() {


Mime
View raw message