You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2013/03/20 06:16:26 UTC
svn commit: r1458636 -
/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
Author: ggregory
Date: Wed Mar 20 05:16:26 2013
New Revision: 1458636
URL: http://svn.apache.org/r1458636
Log:
Javadoc fixes.
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=1458636&r1=1458635&r2=1458636&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 20 05:16:26 2013
@@ -125,10 +125,11 @@ public class CSVFormat implements Serial
.build();
/**
- * Creates a new CSV format builds.
+ * Creates a new CSV format builder.
*
* @param delimiter
* the char used for value separation, must not be a line break character
+ * @return a new CSV format builder.
* @throws IllegalArgumentException if the delimiter is a line break character
*/
public static CSVFormatBuilder newBuilder(final char delimiter) {
@@ -140,13 +141,14 @@ public class CSVFormat implements Serial
}
/**
- * Standard comma separated format, as for {@link #RFC4180} but allowing blank lines.
+ * Creates a standard comma separated format builder, as for {@link #RFC4180} but allowing empty lines.
* <ul>
* <li>withDelimiter(',')</li>
* <li>withQuoteChar('"')</li>
* <li>withEmptyLinesIgnored(true)</li>
* <li>withLineSeparator(CRLF)</li>
* </ul>
+ * @return a standard comma separated format builder, as for {@link #RFC4180} but allowing empty lines.
*/
public static CSVFormatBuilder newBuilder() {
return new CSVFormatBuilder(COMMA, DOUBLE_QUOTE_CHAR, null, null, null, false, true, CRLF, null);