On 13 April 2013 18:55, <brit...@apache.org> wrote:

> Author: britter
> Date: Sat Apr 13 17:55:16 2013
> New Revision: 1467666
>
> URL: http://svn.apache.org/r1467666
> Log:
> Change JavaDoc to match actual parameter name
>
> Modified:
>
> commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
>
> Modified:
> commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
> URL:
> http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java?rev=1467666&r1=1467665&r2=1467666&view=diff
>
> ==============================================================================
> ---
> commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
> (original)
> +++
> commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
> Sat Apr 13 17:55:16 2013
> @@ -98,7 +98,7 @@ public class CSVFormat implements Serial
>           * @param nullToString TODO
>           * @param header
>           *            the header
> -         * @param recordSeparator
> +         * @param lineSeparator
>           *            the line separator to use for output
>

Is it really a line separator?
Or is is a record separator?

It seems to me more like a record separator; often the chosen record
separator is a new-line (or CRLF).

The private field in which the value is stored is called "recordSeparator"
but the API uses lineSeparator.

I think the name "recordSeparator" is more appropriate.

          * @throws IllegalArgumentException if the delimiter is a line
> break character
>           */
>
>
>

Reply via email to