[jira] [Commented] (CSV-133) incorrect / obsolete JavaDoc for CSVParser

["Chen Guoping (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CSV-133?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17036660#comment-17036660 ] 

Chen Guoping commented on CSV-133:
----------------------------------

The JavaDoc involved in this issue has been updated. Can this issue be closed?

> incorrect / obsolete JavaDoc for CSVParser
> ------------------------------------------
>
>                 Key: CSV-133
>                 URL: https://issues.apache.org/jira/browse/CSV-133
>             Project: Commons CSV
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 1.0, 1.1
>            Reporter: Holger Stratmann
>            Priority: Trivial
>              Labels: documentation
>   Original Estimate: 10m
>  Remaining Estimate: 10m
>
> In CSV-131, you asked for more reports, so here we go :)
> The JavaDoc for {{public static CSVParser parse(final File file, final Charset charset, final CSVFormat format)}} seems to be obsolete. It says 
> {quote}
> <p><strong>Note:</strong> This method internally creates a FileReader using \{@link java.io.FileReader#FileReader(java.io.File)\} which in turn relies on the default encoding of the JVM that is executing the code. If this is insufficient create a URL to the file and use \{@link #parse(URL, Charset, CSVFormat)\}</p>
> {quote}
> ... which is clearly no longer the case since the method now takes a charset as a parameter and creates a "FileInputStreamReader" with this charset.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)