Uploaded image for project: 'Commons IO'
  1. Commons IO
  2. IO-436

Improper JavaDoc comment for FilenameUtils.indexOfExtension

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 2.4
    • Fix Version/s: 2.5
    • Component/s: Utilities
    • Labels:

      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

        Attachments

          Activity

            People

            • Assignee:
              ggregory Gary Gregory
              Reporter:
              christoph.schneegans Christoph Schneegans
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: