Skip to content

Commit 1a5163c

Browse files
author
Gary Gregory
committed
Javadoc cleanups.
1 parent 8c0a834 commit 1a5163c

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

src/main/java/org/apache/commons/io/comparator/ReverseFileComparator.java

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@
2121
import java.util.Comparator;
2222

2323
/**
24-
* Reverses the result of comparing two objects using
25-
* the delegate {@link Comparator}.
24+
* Reverses the result of comparing two {@link File} objects using the delegate {@link Comparator}.
2625
*
2726
* @since 1.4
2827
*/
@@ -34,7 +33,7 @@ class ReverseFileComparator extends AbstractFileComparator implements Serializab
3433
/**
3534
* Construct an instance with the specified delegate {@link Comparator}.
3635
*
37-
* @param delegate The comparator to delegate to
36+
* @param delegate The comparator to delegate to.
3837
*/
3938
public ReverseFileComparator(final Comparator<File> delegate) {
4039
if (delegate == null) {
@@ -44,22 +43,22 @@ public ReverseFileComparator(final Comparator<File> delegate) {
4443
}
4544

4645
/**
47-
* Compare using the delegate Comparator, but reversing the result.
46+
* Compares using the delegate Comparator, reversing the result.
4847
*
49-
* @param file1 The first file to compare
50-
* @param file2 The second file to compare
51-
* @return the result from the delegate {@link Comparator#compare(Object, Object)}
52-
* reversing the value (i.e. positive becomes negative and vice versa)
48+
* @param file1 The first file to compare.
49+
* @param file2 The second file to compare.
50+
* @return the result from the delegate {@link Comparator#compare(Object, Object)} reversing the value (i.e.
51+
* positive becomes negative and vice versa).
5352
*/
5453
@Override
5554
public int compare(final File file1, final File file2) {
5655
return delegate.compare(file2, file1); // parameters switched round
5756
}
5857

5958
/**
60-
* String representation of this file comparator.
59+
* Returns the String representation of this file comparator.
6160
*
62-
* @return String representation of this file comparator
61+
* @return String representation of this file comparator.
6362
*/
6463
@Override
6564
public String toString() {

0 commit comments

Comments
 (0)