Return-Path: 
 <issues-return-29036-apmail-commons-issues-archive=commons.apache.org@commons.apache.org>
X-Original-To: apmail-commons-issues-archive@minotaur.apache.org
Delivered-To: apmail-commons-issues-archive@minotaur.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 69A5CDBFC
	for <apmail-commons-issues-archive@minotaur.apache.org>;
 Mon, 27 Aug 2012 05:56:18 +0000 (UTC)
Received: (qmail 36158 invoked by uid 500); 27 Aug 2012 05:56:16 -0000
Delivered-To: apmail-commons-issues-archive@commons.apache.org
Received: (qmail 35598 invoked by uid 500); 27 Aug 2012 05:56:10 -0000
Mailing-List: contact issues-help@commons.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:issues-help@commons.apache.org>
List-Unsubscribe: <mailto:issues-unsubscribe@commons.apache.org>
List-Post: <mailto:issues@commons.apache.org>
List-Id: <issues.commons.apache.org>
Reply-To: issues@commons.apache.org
Delivered-To: mailing list issues@commons.apache.org
Received: (qmail 35420 invoked by uid 99); 27 Aug 2012 05:56:08 -0000
Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28)
    by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 27 Aug 2012 05:56:08 +0000
Date: Mon, 27 Aug 2012 16:56:08 +1100 (NCT)
From: "Igor Lash (JIRA)" <jira@apache.org>
To: issues@commons.apache.org
Message-ID: <2151643.615.1346046968629.JavaMail.jiratomcat@arcas>
In-Reply-To: <654385799.38712.1345620098174.JavaMail.jiratomcat@arcas>
Subject: [jira] [Updated] (IO-343) JavaDoc is inconsistent with real code
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394


     [ https://issues.apache.org/jira/browse/IO-343?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Igor Lash updated IO-343:
-------------------------

    Attachment: patch.txt

Fixing inconsistency between code and JavaDocs.
                
> 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&lt;File&gt; 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