[commons-csv] branch master updated: Better Javadoc.

[gg...@apache.org]

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


The following commit(s) were added to refs/heads/master by this push:
     new 155a769  Better Javadoc.
155a769 is described below

commit 155a76906a1c65a95ac144cc6aa77b9c9a1cbbfe
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Dec 29 14:45:02 2020 -0500

    Better Javadoc.
---
 src/main/java/org/apache/commons/csv/CSVFormat.java | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
index 652b4b9..cd621bb 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -1626,9 +1626,9 @@ public final class CSVFormat implements Serializable {
     }
 
     /**
-     * Verifies the consistency of the parameters and throws an IllegalArgumentException if necessary.
+     * Verifies the validity and consistency of the attributes, and throws an IllegalArgumentException if necessary.
      *
-     * @throws IllegalArgumentException
+     * @throws IllegalArgumentException Throw when any attribute is invalid or inconsistent with other attributes.
      */
     private void validate() throws IllegalArgumentException {
         if (isLineBreak(delimiter)) {