[IO-343] org.apache.commons.io.comparator Javadoc is inconsistent with real code

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.4
• Fix Version/s: 2.5
• Assignee: Unassigned
• Reporter: Igor Lash
• Created: 22/Aug/12 07:20
• Updated: 08/Nov/16 17:59
• Resolved: 17/Apr/13 23:54

Description

Package org.apache.commons.io.comparator has a lot of inconsistent JavaDocs.
For example this class org.apache.commons.io.comparator.NameFileComparator
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java?view=markup
has JavaDocs
List<File> list = ...
NameFileComparator.NAME_COMPARATOR.sort(list); ....

File[] array = ...
NameFileComparator.NAME_INSENSITIVE_REVERSE.sort(array);

but this will not work because all static members of NameFileComparator declared as Comparator<File> for example
public static final Comparator<File> NAME_REVERSE = new ReverseComparator(NAME_COMPARATOR);
public static final Comparator<File> NAME_INSENSITIVE_REVERSE = new ReverseComparator(NAME_INSENSITIVE_COMPARATOR);

and Comparator class doesn't have the sort() method.