Author: britter
Date: Thu Oct 9 20:05:26 2014
New Revision: 1630581
URL: http://svn.apache.org/r1630581
Log:
Correct 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=1630581&r1=1630580&r2=1630581&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
Thu Oct 9 20:05:26 2014
@@ -887,8 +887,8 @@ public final class CSVFormat implements
* 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.
+ * @param headerComments
+ * the headerComments which will be printed by the Printer
before the actual CSV data.
*
* @return A new CSVFormat that is equal to this but with the specified
header
* @see #withSkipHeaderRecord(boolean)
