You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Christoph Schneegans (JIRA)" <ji...@apache.org> on 2014/04/10 14:43:14 UTC
[jira] [Updated] (IO-436) Improper JavaDoc comment for
FilenameUtils.indexOfExtension
[ https://issues.apache.org/jira/browse/IO-436?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Christoph Schneegans updated IO-436:
------------------------------------
Description:
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
was:
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
> 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
> Labels: documentation
>
> 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)