Author: ggregory
Date: Wed Sep 10 12:50:47 2014
New Revision: 1623987
URL: http://svn.apache.org/r1623987
Log:
[CSV-130] CSVFormat#withHeader doesn't work well with #printComment, add
withHeaderComments(String...). 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=1623987&r1=1623986&r2=1623987&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 Sep 10 12:50:47 2014
@@ -880,10 +880,12 @@ public final class CSVFormat implements
}
/**
- * Sets the header comments of the format. The comments will be printed
first, before the headers.
+ * Sets the header comments of the format. The comments will be printed
first, before the headers. This setting is
+ * ignored by the parser.
*
* <pre>
- * CSVFormat format = aformat.withHeaderComments("Generated by Apache
Commons CSV 1.1.", new Date());</pre>
+ * CSVFormat format = aformat.withHeaderComments("Generated by Apache
Commons CSV 1.1.", new Date());
+ * </pre>
*
* @param header
* the header, {@code null} if disabled, empty if parsed
automatically, user specified otherwise.
