[CSV-130] CSVFormat#withHeader doesn't work well with #printComment, add withHeaderComments(String...). Javadoc.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1623987 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

src/main/java/org/apache/commons/csv/CSVFormat.java

@@ -880,10 +880,12 @@ public CSVFormat withHeader(final String... header) {
     }
 
     /**
-     * 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(&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.