Uploaded image for project: 'Commons VFS'
  1. Commons VFS
  2. VFS-519

Javadoc is wrong in some places

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.1

      Description

      • FileSystemManager.resolveFile(File, String) says that the first parameter may be null. When I pass null, a NullPointerException is thrown.
      • FileSystem.getLastModTimeAccuracy: the @return clause is not grammatically correct.
      • SftpFileSystemConfigBuilder.setCompression: mentions the "jsch documentation"; first, jsch does not have documentation, second, the reference should be a little more specific.
      • SftpFileSystemConfigBuilder.getCompression: should be aligned with the setCompression documentation: when I pass "zlib,none", it is not returned as "the compression algorithm", but as a comma-separated list of compression algorithms.
      • SftpFileSystemConfigBuilder.setTimeout does not mention the time unit. It is milliseconds.
      • FtpFileSystemConfigBuilder.setTimeout does not mention the time unit. Same for getSoTimeout

        Attachments

        1. VFS-519.patch
          11 kB
          Roland Illig

          Activity

            People

            • Assignee:
              b.eckenfels Bernd Eckenfels
              Reporter:
              rillig Roland Illig
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: