Apache
/
commons-csv
mirror of https://github.com/apache/commons-csv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CSV-84 Clarify comment handling 

Document how comment behaves

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1306316 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sebastian Bazley 2012-03-28 13:35:38 +00:00
parent f299569070
commit 6a91c05061
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/main/java/org/apache/commons/csv/CSVFormat.java
View File

@ -264,6 +264,9 @@ public class CSVFormat implements Serializable {
/**
* 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 Serializable {
/**
* 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() {