Skip to content
This repository was archived by the owner on Jun 3, 2026. It is now read-only.

Commit 7f277bc

Browse files
committed
adding java doc optimization for method setHeaderComments()
1 parent 9668d46 commit 7f277bc

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ public Builder setHeader(final String... header) {
521521
}
522522

523523
/**
524-
* 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.
524+
* 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.
525525
*
526526
* <pre>
527527
* builder.setHeaderComments(&quot;Generated by Apache Commons CSV.&quot;, Instant.now());
@@ -536,7 +536,7 @@ public Builder setHeaderComments(final Object... headerComments) {
536536
}
537537

538538
/**
539-
* 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.
539+
* 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.
540540
*
541541
* <pre>
542542
* Builder.setHeaderComments(&quot;Generated by Apache Commons CSV.&quot;, Instant.now());

0 commit comments

Comments
 (0)