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:
parent
3c7be9458f
commit
f0b4fc5109
|
@ -162,14 +162,15 @@ public final class CSVFormat implements Serializable {
|
||||||
/**
|
/**
|
||||||
* Standard comma separated format, as for {@link #RFC4180} but allowing empty lines.
|
* Standard comma separated format, as for {@link #RFC4180} but allowing empty lines.
|
||||||
*
|
*
|
||||||
* <p>Settings are:
|
* <p>
|
||||||
|
* Settings are:
|
||||||
|
* </p>
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>withDelimiter(',')</li>
|
* <li>withDelimiter(',')</li>
|
||||||
* <li>withQuoteChar('"')</li>
|
* <li>withQuoteChar('"')</li>
|
||||||
* <li>withRecordSeparator("\r\n")</li>
|
* <li>withRecordSeparator("\r\n")</li>
|
||||||
* <li>withIgnoreEmptyLines(true)</li>
|
* <li>withIgnoreEmptyLines(true)</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
* </p>
|
|
||||||
*/
|
*/
|
||||||
public static final CSVFormat DEFAULT = new CSVFormat(COMMA, DOUBLE_QUOTE_CHAR, null, null, null,
|
public static final CSVFormat DEFAULT = new CSVFormat(COMMA, DOUBLE_QUOTE_CHAR, null, null, null,
|
||||||
false, true, CRLF, null, null, false, false);
|
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>.
|
* 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>
|
* <ul>
|
||||||
* <li>withDelimiter(',')</li>
|
* <li>withDelimiter(',')</li>
|
||||||
* <li>withQuoteChar('"')</li>
|
* <li>withQuoteChar('"')</li>
|
||||||
* <li>withRecordSeparator("\r\n")</li>
|
* <li>withRecordSeparator("\r\n")</li>
|
||||||
* <li>withIgnoreEmptyLines(false)</li>
|
* <li>withIgnoreEmptyLines(false)</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
* </p>
|
|
||||||
*/
|
*/
|
||||||
public static final CSVFormat RFC4180 = DEFAULT.withIgnoreEmptyLines(false);
|
public static final CSVFormat RFC4180 = DEFAULT.withIgnoreEmptyLines(false);
|
||||||
|
|
||||||
|
@ -202,13 +204,13 @@ public final class CSVFormat implements Serializable {
|
||||||
*
|
*
|
||||||
* <p>
|
* <p>
|
||||||
* Settings are:
|
* Settings are:
|
||||||
|
* </p>
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>withDelimiter(',')</li>
|
* <li>withDelimiter(',')</li>
|
||||||
* <li>withQuoteChar('"')</li>
|
* <li>withQuoteChar('"')</li>
|
||||||
* <li>withRecordSeparator("\r\n")</li>
|
* <li>withRecordSeparator("\r\n")</li>
|
||||||
* <li>withIgnoreEmptyLines(false)</li>
|
* <li>withIgnoreEmptyLines(false)</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
* </p>
|
|
||||||
* <p>
|
* <p>
|
||||||
* Note: this is currently the same as {@link #RFC4180}.
|
* Note: this is currently the same as {@link #RFC4180}.
|
||||||
* </p>
|
* </p>
|
||||||
|
@ -218,14 +220,15 @@ public final class CSVFormat implements Serializable {
|
||||||
/**
|
/**
|
||||||
* Tab-delimited format.
|
* Tab-delimited format.
|
||||||
*
|
*
|
||||||
* <p>Settings are:
|
* <p>
|
||||||
|
* Settings are:
|
||||||
|
* </p>
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>withDelimiter('\t')</li>
|
* <li>withDelimiter('\t')</li>
|
||||||
* <li>withQuoteChar('"')</li>
|
* <li>withQuoteChar('"')</li>
|
||||||
* <li>withRecordSeparator("\r\n")</li>
|
* <li>withRecordSeparator("\r\n")</li>
|
||||||
* <li>withIgnoreSurroundingSpaces(true)</li>
|
* <li>withIgnoreSurroundingSpaces(true)</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
* </p>
|
|
||||||
*/
|
*/
|
||||||
public static final CSVFormat TDF =
|
public static final CSVFormat TDF =
|
||||||
DEFAULT
|
DEFAULT
|
||||||
|
@ -242,6 +245,7 @@ public final class CSVFormat implements Serializable {
|
||||||
*
|
*
|
||||||
* <p>
|
* <p>
|
||||||
* Settings are:
|
* Settings are:
|
||||||
|
* </p>
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>withDelimiter('\t')</li>
|
* <li>withDelimiter('\t')</li>
|
||||||
* <li>withQuoteChar(null)</li>
|
* <li>withQuoteChar(null)</li>
|
||||||
|
@ -249,7 +253,6 @@ public final class CSVFormat implements Serializable {
|
||||||
* <li>withIgnoreEmptyLines(false)</li>
|
* <li>withIgnoreEmptyLines(false)</li>
|
||||||
* <li>withEscape('\\')</li>
|
* <li>withEscape('\\')</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
* </p>
|
|
||||||
* @see <a href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html">
|
* @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>
|
* http://dev.mysql.com/doc/refman/5.1/en/load-data.html</a>
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -387,21 +387,21 @@ public final class CSVPrinter implements Flushable, Closeable {
|
||||||
*
|
*
|
||||||
* <p>Given the following data structure:</p>
|
* <p>Given the following data structure:</p>
|
||||||
* <pre>
|
* <pre>
|
||||||
* <source>
|
* <code>
|
||||||
* List<String[]> data = ...
|
* List<String[]> data = ...
|
||||||
* data.add(new String[]{ "A", "B", "C" });
|
* data.add(new String[]{ "A", "B", "C" });
|
||||||
* data.add(new String[]{ "1", "2", "3" });
|
* data.add(new String[]{ "1", "2", "3" });
|
||||||
* data.add(new String[]{ "A1", "B2", "C3" });
|
* data.add(new String[]{ "A1", "B2", "C3" });
|
||||||
* </source>
|
* </code>
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
* <p>Calling this method will print:</p>
|
* <p>Calling this method will print:</p>
|
||||||
* <pre>
|
* <pre>
|
||||||
* <source>
|
* <code>
|
||||||
* A, B, C
|
* A, B, C
|
||||||
* 1, 2, 3
|
* 1, 2, 3
|
||||||
* A1, B2, C3
|
* A1, B2, C3
|
||||||
* </source>
|
* </code>
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
* @param values
|
* @param values
|
||||||
|
@ -430,21 +430,21 @@ public final class CSVPrinter implements Flushable, Closeable {
|
||||||
*
|
*
|
||||||
* <p>Given the following data structure:</p>
|
* <p>Given the following data structure:</p>
|
||||||
* <pre>
|
* <pre>
|
||||||
* <source>
|
* <code>
|
||||||
* String[][] data = new String[3][]
|
* String[][] data = new String[3][]
|
||||||
* data[0] = String[]{ "A", "B", "C" };
|
* data[0] = String[]{ "A", "B", "C" };
|
||||||
* data[1] = new String[]{ "1", "2", "3" };
|
* data[1] = new String[]{ "1", "2", "3" };
|
||||||
* data[2] = new String[]{ "A1", "B2", "C3" };
|
* data[2] = new String[]{ "A1", "B2", "C3" };
|
||||||
* </source>
|
* </code>
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
* <p>Calling this method will print:</p>
|
* <p>Calling this method will print:</p>
|
||||||
* <pre>
|
* <pre>
|
||||||
* <source>
|
* <code>
|
||||||
* A, B, C
|
* A, B, C
|
||||||
* 1, 2, 3
|
* 1, 2, 3
|
||||||
* A1, B2, C3
|
* A1, B2, C3
|
||||||
* </source>
|
* </code>
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
* @param values
|
* @param values
|
||||||
|
|
Loading…
Reference in New Issue