Correct JavaDoc

britter · britter · commit ef39a01a22fa · 2014-10-09T20:05:26.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1630581 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -887,8 +887,8 @@ public CSVFormat withHeader(final String... header) {
      * CSVFormat format = aformat.withHeaderComments(&quot;Generated by Apache Commons CSV 1.1.&quot;, 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)

Original file line number	Diff line number	Diff line change
`@@ -887,8 +887,8 @@ public CSVFormat withHeader(final String... header) {`
`887`	`887`	`* CSVFormat format = aformat.withHeaderComments("Generated by Apache Commons CSV 1.1.", new Date());`
`888`	`888`	`* </pre>`
`889`	`889`	`*`
`890`		`- * @param header`
`891`		`- * the header, {@code null} if disabled, empty if parsed automatically, user specified otherwise.`
	`890`	`+ * @param headerComments`
	`891`	`+ * the headerComments which will be printed by the Printer before the actual CSV data.`
`892`	`892`	`*`
`893`	`893`	`* @return A new CSVFormat that is equal to this but with the specified header`
`894`	`894`	`* @see #withSkipHeaderRecord(boolean)`