commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bernd Eckenfels (JIRA)" <j...@apache.org>
Subject [jira] [Resolved] (VFS-519) Javadoc is wrong in some places
Date Wed, 19 Nov 2014 04:20:34 GMT

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

Bernd Eckenfels resolved VFS-519.
---------------------------------
       Resolution: Fixed
    Fix Version/s: 2.1
         Assignee: Bernd Eckenfels

Thanks for the patch, applied it with
http://svn.apache.org/r1640485

Will apply the additional unit test after cleanup.

(I am not sure about the `{@code null}` lets see of somebody comments on it :) 


> 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
>            Assignee: Bernd Eckenfels
>            Priority: Minor
>              Labels: documentation, patch
>             Fix For: 2.1
>
>         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)

Mime
View raw message