Apache/commons-csv
1
0
Fork 0
mirror of https://github.com/apache/commons-csv.git synced 2025-02-10 03:56:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Javadoc: Use the active voice and change one verb.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1397999 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2012-10-14 03:43:47 +00:00
parent eb472cb82a
commit 1b4474c0a0
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,7 +27,7 @@ import java.io.Flushable;
import java.io.IOException; import java.io.IOException;
/** /**
* Print values as a comma separated list. * Prints values as a comma separated list.
*/ */
public class CSVPrinter { public class CSVPrinter {
@ -39,7 +39,7 @@ public class CSVPrinter {
private boolean newLine = true; private boolean newLine = true;
/** /**
* Create a printer that will print values to the given stream following the CSVFormat. * Creates a printer that will print values to the given stream following the CSVFormat.
* <p/> * <p/>
* Currently, only a pure encapsulation format or a pure escaping format is supported. Hybrid formats * Currently, only a pure encapsulation format or a pure escaping format is supported. Hybrid formats
* (encapsulation and escaping with a different character) are not supported. * (encapsulation and escaping with a different character) are not supported.
@ -62,7 +62,7 @@ public class CSVPrinter {
// ====================================================== // ======================================================
/** /**
* Output a blank line * Outputs a blank line
*/ */
public void println() throws IOException { public void println() throws IOException {
out.append(format.getLineSeparator()); out.append(format.getLineSeparator());
@ -70,7 +70,7 @@ public class CSVPrinter {
} }
/** /**
* Flush the underlying stream. * Flushes the underlying stream.
* *
* @throws IOException * @throws IOException
*/ */
@ -81,7 +81,7 @@ public class CSVPrinter {
} }
/** /**
* Print a single line of comma separated values. The values will be quoted if needed. Quotes and newLine * Prints a single line of comma separated values. The values will be quoted if needed. Quotes and newLine
* characters will be escaped. * characters will be escaped.
* *
* @param values * @param values
@ -95,7 +95,7 @@ public class CSVPrinter {
} }
/** /**
* Put a comment on a new line among the comma separated values. Comments will always begin on a new line and * Prints a comment on a new line among the comma separated values. Comments will always begin on a new line and
* occupy a least one full line. The character specified to start comments and a space will be inserted at the * occupy a least one full line. The character specified to start comments and a space will be inserted at the
* beginning of each new line in the comment. * beginning of each new line in the comment.
* <p/> * <p/>
@ -277,7 +277,7 @@ public class CSVPrinter {
} }
/** /**
* Print the string as the next value on the line. The value will be escaped or encapsulated as needed if * Prints the string as the next value on the line. The value will be escaped or encapsulated as needed if
* checkForEscape==true * checkForEscape==true
* *
* @param value * @param value
@ -299,7 +299,7 @@ public class CSVPrinter {
} }
/** /**
* Print the string as the next value on the line. The value will be escaped or encapsulated as needed. * Prints the string as the next value on the line. The value will be escaped or encapsulated as needed.
* *
* @param value * @param value
* value to be outputted. * value to be outputted.