diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java index 81b6f19369..275c0dae05 100644 --- a/src/main/java/org/apache/commons/csv/CSVFormat.java +++ b/src/main/java/org/apache/commons/csv/CSVFormat.java @@ -1383,12 +1383,12 @@ private CSVFormat(final Builder builder) { * @param nullString the line separator to use for output. * @param headerComments the comments to be printed by the Printer before the actual CSV data. * @param header the header - * @param skipHeaderRecord TODO Doc me. - * @param allowMissingColumnNames TODO Doc me. - * @param ignoreHeaderCase TODO Doc me. - * @param trim TODO Doc me. - * @param trailingDelimiter TODO Doc me. - * @param autoFlush TODO Doc me. + * @param skipHeaderRecord if {@code true} the header row will be skipped + * @param allowMissingColumnNames if {@code true} the missing column names are allowed when parsing the header line + * @param ignoreHeaderCase if {@code true} header names will be accessed ignoring case when parsing input + * @param trim if {@code true} next record value will be trimmed + * @param trailingDelimiter if {@code true} the trailing delimiter wil be added before record separator (if set) + * @param autoFlush if {@code true} the underlying stream will be flushed before closing * @param duplicateHeaderMode the behavior when handling duplicate headers * @throws IllegalArgumentException if the delimiter is a line break character. */ @@ -1601,7 +1601,7 @@ public boolean getIgnoreEmptyLines() { /** * Gets whether header names will be accessed ignoring case when parsing input. * - * @return {@code true} if header names cases are ignored, {@code false} if they are case sensitive. + * @return {@code true} if header names cases are ignored, {@code false} if they are case-sensitive. * @since 1.3 */ public boolean getIgnoreHeaderCase() { @@ -1797,7 +1797,7 @@ public CSVPrinter print(final Appendable out) throws IOException { } /** - * Prints to the specified output. + * Prints to the specified {@code File} with given {@code Charset}. * *

* See also {@link CSVPrinter}. @@ -1869,7 +1869,8 @@ private synchronized void print(final Object object, final CharSequence value, f } /** - * Prints to the specified output, returns a {@code CSVPrinter} which the caller MUST close. + * Prints to the specified {@code Path} with given {@code Charset}, + * returns a {@code CSVPrinter} which the caller MUST close. * *

* See also {@link CSVPrinter}. diff --git a/src/main/java/org/apache/commons/csv/CSVRecord.java b/src/main/java/org/apache/commons/csv/CSVRecord.java index 0e70ad7519..71d5f9534a 100644 --- a/src/main/java/org/apache/commons/csv/CSVRecord.java +++ b/src/main/java/org/apache/commons/csv/CSVRecord.java @@ -88,7 +88,7 @@ public String get(final int i) { } /** - * Returns a value by name. If multiple instances of the header name exists, only the last occurence is returned. + * Returns a value by name. If multiple instances of the header name exists, only the last occurrence is returned. * *

* Note: This requires a field mapping obtained from the original parser. @@ -312,7 +312,7 @@ public List toList() { /** * Copies this record into a new Map of header name to record value. If multiple instances of a header name exists, - * only the last occurence is mapped. + * only the last occurrence is mapped. * *

* Editing the map does not update this instance.