diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java index 275c0dae..9711293c 100644 --- a/src/main/java/org/apache/commons/csv/CSVFormat.java +++ b/src/main/java/org/apache/commons/csv/CSVFormat.java @@ -521,7 +521,7 @@ public final class CSVFormat implements Serializable { } /** - * Sets the header comments set to the given values. The comments will be printed first, before the headers. This setting is ignored by the parser. + * Sets the header comments set to the given values. The comments will be printed first with the provided comment marker set by {@link Builder#setCommentMarker(char)}, before the headers. This setting is ignored by the parser. * *
* builder.setHeaderComments("Generated by Apache Commons CSV.", Instant.now()); @@ -536,7 +536,7 @@ public final class CSVFormat implements Serializable { } /** - * Sets the header comments set to the given values. The comments will be printed first, before the headers. This setting is ignored by the parser. + * Sets the header comments set to the given values. The comments will be printed first with the provided comment marker set by {@link Builder#setCommentMarker(char)}, before the headers. This setting is ignored by the parser. * ** Builder.setHeaderComments("Generated by Apache Commons CSV.", Instant.now());