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

[gg...@apache.org]

Author: ggregory
Date: Sun May 22 05:22:22 2016
New Revision: 1745011

URL: http://svn.apache.org/viewvc?rev=1745011&view=rev
Log:
Javadoc.

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=1745011&r1=1745010&r2=1745011&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 Sun May 22 05:22:22 2016
@@ -864,15 +864,15 @@ public final class CSVFormat implements
     }
 
     /**
-     * Prints the string as the next value on the line. The value will be escaped or encapsulated as needed. Useful when
-     * one wants to avoid creating CSVPrinters.
+     * Prints the {@code value} as the next value on the line to {@code out}. The value will be escaped or encapsulated
+     * as needed. Useful when one wants to avoid creating CSVPrinters.
      *
      * @param value
-     *            value to be output.
+     *            value to output.
      * @param out
      *            where to print the value
      * @param newRecord
-     *            is this a new record
+     *            if this a new record
      * @throws IOException
      *             If an I/O error occurs
      * @since 1.4
@@ -1063,7 +1063,6 @@ public final class CSVFormat implements
      *
      * @param out
      *            where to write
-     *
      * @throws IOException
      *             If an I/O error occurs
      * @since 1.4
@@ -1078,14 +1077,16 @@ public final class CSVFormat implements
     }
 
     /**
-     * Prints the given values a single record of delimiter separated values followed by the record separator.
+     * Prints the given {@code values} to {@code out} as a single record of delimiter separated values followed by the
+     * record separator.
      *
      * <p>
-     * The values will be quoted if needed. Quotes and newLine characters will be escaped. This method adds the record
+     * The values will be quoted if needed. Quotes and new-line characters will be escaped. This method adds the record
      * separator to the output after printing the record, so there is no need to call {@link #println(Appendable)}.
      * </p>
      *
-     * @param out where to write
+     * @param out
+     *            where to write
      * @param values
      *            values to output.
      * @throws IOException