commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Christoph Schneegans (JIRA)" <j...@apache.org>
Subject [jira] [Created] (IO-436) Improper JavaDoc comment for FilenameUtils.indexOfExtension
Date Thu, 10 Apr 2014 12:35:16 GMT
Christoph Schneegans created IO-436:
---------------------------------------

             Summary: Improper JavaDoc comment for FilenameUtils.indexOfExtension
                 Key: IO-436
                 URL: https://issues.apache.org/jira/browse/IO-436
             Project: Commons IO
          Issue Type: Bug
          Components: Utilities
    Affects Versions: 2.4
            Reporter: Christoph Schneegans
            Priority: Trivial


The method FilenameUtils.indexOfExtension contains this JavaDoc comment:

  * @param filename  the filename to find the last path separator in, null returns -1
  * @return the index of the last separator character, or -1 if there
  * is no such character

This comment was obviously copied from the FilenameUtils.indexOfLastSeparator method, where
it makes perfect sense.

The JavaDoc comment for FilenameUtils.indexOfExtension should rather read e.g. as follows:

  * @param filename  the filename to find the last extension separator in, null returns -1
  * @return the index of the last extension separator character, or -1 if there
  * is no such character



--
This message was sent by Atlassian JIRA
(v6.2#6252)

Mime
View raw message