[commons-csv] 04/04: Javadoc

[ggregory]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git

commit 547c5a24a329c306d41075cadb292e5eeebddac8
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Sep 30 11:00:49 2023 -0400

    Javadoc
---
 .../java/org/apache/commons/csv/CSVFormat.java     | 27 ++++++++++++++--------
 1 file changed, 18 insertions(+), 9 deletions(-)

diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java 
b/src/main/java/org/apache/commons/csv/CSVFormat.java
index 6c504bc9..43d9c64f 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -1413,31 +1413,40 @@ public final class CSVFormat implements Serializable {
 
     private final boolean autoFlush;
 
-    private final Character commentMarker; // null if commenting is disabled
+    /** null if commenting is disabled. */
+    private final Character commentMarker;
 
     private final String delimiter;
 
-    private final Character escapeCharacter; // null if escaping is disabled
+    /** null if escaping is disabled. */
+    private final Character escapeCharacter;
 
-    private final String[] headers; // array of header column names
+    /** Array of header column names. */
+    private final String[] headers;
 
-    private final String[] headerComments; // array of header comment lines
+    /** Array of header comment lines. */
+    private final String[] headerComments;
 
     private final boolean ignoreEmptyLines;
 
-    private final boolean ignoreHeaderCase; // should ignore header names case
+    /** Should ignore header names case. */
+    private final boolean ignoreHeaderCase;
 
-    private final boolean ignoreSurroundingSpaces; // Should leading/trailing 
spaces be ignored around values?
+    /** TODO Should leading/trailing spaces be ignored around values?. */
+    private final boolean ignoreSurroundingSpaces;
 
-    private final String nullString; // the string to be used for null values
+    /** The string to be used for null values. */
+    private final String nullString;
 
-    private final Character quoteCharacter; // null if quoting is disabled
+    /** null if quoting is disabled. */
+    private final Character quoteCharacter;
 
     private final String quotedNullString;
 
     private final QuoteMode quoteMode;
 
-    private final String recordSeparator; // for outputs
+    /** For output. */
+    private final String recordSeparator;
 
     private final boolean skipHeaderRecord;