[
https://issues.apache.org/jira/browse/IO-343?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13443249#comment-13443249
]
Gary D. Gregory commented on IO-343:
------------------------------------
This patch breaks compatibility so it could only be considered for a major
release. I am not sure we want that now.
Fixing the Javadoc to match the code is OK to do in trunk now but this patch
does not do that.
What needs to be decided as usual is if it is the code or the docs that should
be fixed.
> JavaDoc is inconsistent with real code
> --------------------------------------
>
> Key: IO-343
> URL: https://issues.apache.org/jira/browse/IO-343
> Project: Commons IO
> Issue Type: Bug
> Affects Versions: 2.4
> Reporter: Igor Lash
> Priority: Minor
> Attachments: patch.txt
>
>
> 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.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
