svn commit: r1300678 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java

[se...@apache.org]

Author: sebb
Date: Wed Mar 14 18:34:23 2012
New Revision: 1300678

URL: http://svn.apache.org/viewvc?rev=1300678&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=1300678&r1=1300677&r2=1300678&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 18:34:23 2012
@@ -64,12 +64,12 @@ public class CSVFormat implements Serial
      */
     public static final CSVFormat EXCEL = new CSVFormat(',', '"', DISABLED, DISABLED, false, false, false, false, "\r\n");
 
-    /** Tabulation delimited format. */
+    /** Tab-delimited format, with quote; leading and trailing spaces ignored. */
     public static final CSVFormat TDF = new CSVFormat('\t', '"', DISABLED, DISABLED, true, true, false, true, "\r\n");
 
     /**
      * Default MySQL format used by the <tt>SELECT INTO OUTFILE</tt> and
-     * <tt>LOAD DATA INFILE</tt> operations. This is a tabulation delimited
+     * <tt>LOAD DATA INFILE</tt> operations. This is a tab-delimited
      * format with a LF character as the line separator. Values are not quoted
      * and special characters are escaped with '\'.
      * 
@@ -89,6 +89,7 @@ public class CSVFormat implements Serial
      * @param trailingSpacesIgnored     <tt>true</tt> when trailing whitespaces should be ignored
      * @param unicodeEscapesInterpreted <tt>true</tt> when unicode escapes should be interpreted
      * @param emptyLinesIgnored         <tt>true</tt> when the parser should skip emtpy lines
+     * @param lineSeparator             the line separator to use.
      */
     CSVFormat(
             char delimiter,
@@ -352,7 +353,7 @@ public class CSVFormat implements Serial
     }
 
     /**
-     * Returns the line separator delimiting the records.
+     * Returns the line separator delimiting output records.
      * 
      * @return the line separator
      */
@@ -361,10 +362,11 @@ public class CSVFormat implements Serial
     }
 
     /**
-     * Returns a copy of this format using the specified line separator.
+     * Returns a copy of this format using the specified output line separator.
      * 
-     * @param lineSeparator the line separator
-     * @return A copy of this format using the specified line separator
+     * @param lineSeparator the line separator to be used for output.
+     * 
+     * @return A copy of this format using the specified output line separator
      */
     public CSVFormat withLineSeparator(String lineSeparator) {
         return new CSVFormat(delimiter, encapsulator, commentStart, escape, leadingSpacesIgnored, trailingSpacesIgnored, unicodeEscapesInterpreted, emptyLinesIgnored, lineSeparator);