commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Benedikt Ritter <benerit...@googlemail.com>
Subject Re: svn commit: r1300699 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
Date Wed, 14 Mar 2012 19:55:50 GMT
Am 14. März 2012 20:48 schrieb  <sebb@apache.org>:
> Author: sebb
> Date: Wed Mar 14 19:48:12 2012
> New Revision: 1300699
>
> URL: http://svn.apache.org/viewvc?rev=1300699&view=rev
> Log:
> Javadoc
>
> 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=1300699&r1=1300698&r2=1300699&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 Wed
Mar 14 19:48:12 2012
> @@ -225,7 +225,7 @@ public class CSVFormat implements Serial
>     }
>
>     /**
> -     * Tells if comments are supported by this format.
> +     * Specifies whether comments are supported by this format.
>      *
>      * @return <tt>true</tt> is comments are supported, <tt>false</tt>
otherwise
>      */
> @@ -313,7 +313,8 @@ public class CSVFormat implements Serial
>     }
>
>     /**
> -     * Tells if unicode escape sequences (i.e <span>\</span>u1234) are
turned into their corresponding character.
> +     * Tells if unicode escape sequences (e.g. <span>\</span>u1234) are
turned into their corresponding character

how about changing this to "[...] (e.g. {@literal \u1234}) are [...]"?
would be better readable in the source.

> +     * when parsing input.
>      *
>      * @return <tt>true</tt> if unicode escape sequences are interpreted,
<tt>false</tt> if they are left as is.
>      */
> @@ -333,9 +334,9 @@ public class CSVFormat implements Serial
>     }
>
>     /**
> -     * Tells if the empty lines between the records are ignored.
> +     * Specifies whether empty lines between records are ignored when parsing input.
>      *
> -     * @return <tt>true</tt> if empty lines between records are ignore,
<tt>false</tt> if they are turned into empty records.
> +     * @return <tt>true</tt> if empty lines between records are ignored,
<tt>false</tt> if they are turned into empty records.
>      */
>     public boolean isEmptyLinesIgnored() {
>         return emptyLinesIgnored;
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message