[jira] [Updated] (VFS-519) Javadoc is wrong in some places

["Bernd Eckenfels (JIRA)" <ji...@apache.org>]

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

Bernd Eckenfels updated VFS-519:
--------------------------------
    Priority: Minor  (was: Major)

> Javadoc is wrong in some places
> -------------------------------
>
>                 Key: VFS-519
>                 URL: https://issues.apache.org/jira/browse/VFS-519
>             Project: Commons VFS
>          Issue Type: Bug
>            Reporter: Roland Illig
>            Priority: Minor
>              Labels: documentation
>         Attachments: VFS-519.patch
>
>
> * {{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}}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)