commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Roland Illig (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (VFS-519) Javadoc is wrong in some places
Date Sun, 18 May 2014 22:41:38 GMT

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

Roland Illig updated VFS-519:
-----------------------------

    Attachment: VFS-519.patch

This patch corrects some Javadoc and removes irrelevant {{final}} modifiers.

I changed the order of the {{@param}} tags in the method resolveFile(FileObject, String),
because I expect the Javadoc to be in the same order as the parameters.

I removed the {{final}} modifier for the parameters, since they are useless in an interface
declaration.

The NullPointerException in the resolveFile method should probably be fixed in a separate
issue. It seems weird to me that the Javadoc text looks the same, but the implementation is
different.

The rest of the patch should be straight-forward.


> 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
>              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.2#6252)

Mime
View raw message