Apache
/
commons-csv
mirror of https://github.com/apache/commons-csv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

adding java doc optimization for method setHeaderComments()

This commit is contained in:
gbidsilva 2023-08-24 17:25:52 +05:30
parent 9668d4628e
commit 7f277bc5f2
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/main/java/org/apache/commons/csv/CSVFormat.java
View File

@ -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.
*
* <pre>
* builder.setHeaderComments(&quot;Generated by Apache Commons CSV.&quot;, 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.
*
* <pre>
* Builder.setHeaderComments(&quot;Generated by Apache Commons CSV.&quot;, Instant.now());