Clearify the meaning of isConsistent

britter · britter · commit 414467458894 · 2014-07-15T17:17:04.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1610761 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/commons/csv/CSVRecord.java b/src/main/java/org/apache/commons/csv/CSVRecord.java
@@ -130,8 +130,12 @@ public long getRecordNumber() {
     }
 
     /**
-     * Returns true if this record is consistent, false if not. Currently, the only check is matching the record size to
-     * the header size. Some programs can export files that fails this test but still produce parsable files.
+     * Tells whether the record size matches the header size.
+     *
+     * <p>
+     * Returns true if the sizes for this record match and false if not. Some programs can export files that fail this
+     * test but still produce parsable files.
+     * </p>
      *
      * @return true of this record is valid, false if not
      */

Original file line number	Diff line number	Diff line change
`@@ -130,8 +130,12 @@ public long getRecordNumber() {`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`/**`
`133`		`- * Returns true if this record is consistent, false if not. Currently, the only check is matching the record size to`
`134`		`- * the header size. Some programs can export files that fails this test but still produce parsable files.`
	`133`	`+ * Tells whether the record size matches the header size.`
	`134`	`+ *`
	`135`	`+ * <p>`
	`136`	`+ * Returns true if the sizes for this record match and false if not. Some programs can export files that fail this`
	`137`	`+ * test but still produce parsable files.`
	`138`	`+ * </p>`
`135`	`139`	`*`
`136`	`140`	`* @return true of this record is valid, false if not`
`137`	`141`	`*/`