svn commit: r1306316 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java

[se...@apache.org]

Author: sebb
Date: Wed Mar 28 13:35:38 2012
New Revision: 1306316

URL: http://svn.apache.org/viewvc?rev=1306316&view=rev
Log:
CSV-84 Clarify comment handling
Document how comment behaves

Modified:
    commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java

Modified: commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
URL: http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java?rev=1306316&r1=1306315&r2=1306316&view=diff
==============================================================================
--- commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java (original)
+++ commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java Wed Mar 28 13:35:38 2012
@@ -264,6 +264,9 @@ public class CSVFormat implements Serial
     /**
      * Returns a copy of this format using the specified character as the comment start marker.
      * 
+     * Note that the comment introducer character is only recognised
+     * at the start of a line.
+     * 
      * @param commentStart the comment start marker
      * @return A copy of this format using the specified character as the comment start marker
      * @throws IllegalArgumentException thrown if the specified character is a line break
@@ -279,6 +282,9 @@ public class CSVFormat implements Serial
     /**
      * Specifies whether comments are supported by this format.
      * 
+     * Note that the comment introducer character is only recognised
+     * at the start of a line.
+     * 
      * @return <tt>true</tt> is comments are supported, <tt>false</tt> otherwise
      */
     public boolean isCommentingEnabled() {