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

Fix JavaDoc problems 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1617076 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benedikt Ritter 2014-08-10 09:23:01 +00:00
parent 3c7be9458f
commit f0b4fc5109
2 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -162,14 +162,15 @@ public final class CSVFormat implements Serializable {
/**
* Standard comma separated format, as for {@link #RFC4180} but allowing empty lines.
*
* <p>Settings are:
* <p>
* Settings are:
* </p>
* <ul>
* <li>withDelimiter(',')</li>
* <li>withQuoteChar('"')</li>
* <li>withRecordSeparator("\r\n")</li>
* <li>withIgnoreEmptyLines(true)</li>
* </ul>
* </p>
*/
public static final CSVFormat DEFAULT = new CSVFormat(COMMA, DOUBLE_QUOTE_CHAR, null, null, null,
false, true, CRLF, null, null, false, false);
@ -177,14 +178,15 @@ public final class CSVFormat implements Serializable {
/**
* Comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>.
*
* <p>Settings are:
* <p>
* Settings are:
* </p>
* <ul>
* <li>withDelimiter(',')</li>
* <li>withQuoteChar('"')</li>
* <li>withRecordSeparator("\r\n")</li>
* <li>withIgnoreEmptyLines(false)</li>
* </ul>
* </p>
*/
public static final CSVFormat RFC4180 = DEFAULT.withIgnoreEmptyLines(false);
@ -202,13 +204,13 @@ public final class CSVFormat implements Serializable {
*
* <p>
* Settings are:
* </p>
* <ul>
* <li>withDelimiter(',')</li>
* <li>withQuoteChar('"')</li>
* <li>withRecordSeparator("\r\n")</li>
* <li>withIgnoreEmptyLines(false)</li>
* </ul>
* </p>
* <p>
* Note: this is currently the same as {@link #RFC4180}.
* </p>
@ -218,14 +220,15 @@ public final class CSVFormat implements Serializable {
/**
* Tab-delimited format.
*
* <p>Settings are:
* <p>
* Settings are:
* </p>
* <ul>
* <li>withDelimiter('\t')</li>
* <li>withQuoteChar('"')</li>
* <li>withRecordSeparator("\r\n")</li>
* <li>withIgnoreSurroundingSpaces(true)</li>
* </ul>
* </p>
*/
public static final CSVFormat TDF =
DEFAULT
@ -242,6 +245,7 @@ public final class CSVFormat implements Serializable {
*
* <p>
* Settings are:
* </p>
* <ul>
* <li>withDelimiter('\t')</li>
* <li>withQuoteChar(null)</li>
@ -249,7 +253,6 @@ public final class CSVFormat implements Serializable {
* <li>withIgnoreEmptyLines(false)</li>
* <li>withEscape('\\')</li>
* </ul>
* </p>
* @see <a href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html">
* http://dev.mysql.com/doc/refman/5.1/en/load-data.html</a>
*/

16
src/main/java/org/apache/commons/csv/CSVPrinter.java
View File

@ -387,21 +387,21 @@ public final class CSVPrinter implements Flushable, Closeable {
*
* <p>Given the following data structure:</p>
* <pre>
* <source>
* <code>
* List&lt;String[]&gt; data = ...
* data.add(new String[]{ "A", "B", "C" });
* data.add(new String[]{ "1", "2", "3" });
* data.add(new String[]{ "A1", "B2", "C3" });
* </source>
* </code>
* </pre>
*
* <p>Calling this method will print:</p>
* <pre>
* <source>
* <code>
* A, B, C
* 1, 2, 3
* A1, B2, C3
* </source>
* </code>
* </pre>
*
* @param values
@ -430,21 +430,21 @@ public final class CSVPrinter implements Flushable, Closeable {
*
* <p>Given the following data structure:</p>
* <pre>
* <source>
* <code>
* String[][] data = new String[3][]
* data[0] = String[]{ "A", "B", "C" };
* data[1] = new String[]{ "1", "2", "3" };
* data[2] = new String[]{ "A1", "B2", "C3" };
* </source>
* </code>
* </pre>
*
* <p>Calling this method will print:</p>
* <pre>
* <source>
* <code>
* A, B, C
* 1, 2, 3
* A1, B2, C3
* </source>
* </code>
* </pre>
*
* @param values