Skip to content

Commit 9bafed6

Browse files
committed
Clarify JavaDoc for builder factory method, also remove trailing white spaces
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1460134 13f79535-47bb-0310-9956-ffa450edef68
1 parent 77c6382 commit 9bafed6

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

src/main/java/org/apache/commons/csv/CSVFormat.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ public static CSVFormatBuilder newBuilder(final char delimiter) {
141141
*
142142
* @param format
143143
* The format to use values from
144-
* @return a new CSVFormatBuilder
144+
* @return a new CSVFormatBuilder
145145
*/
146146
public static CSVFormatBuilder newBuilder(final CSVFormat format) {
147147
return new CSVFormatBuilder(format);
@@ -155,6 +155,9 @@ public static CSVFormatBuilder newBuilder(final CSVFormat format) {
155155
* <li>withEmptyLinesIgnored(true)</li>
156156
* <li>withLineSeparator(CRLF)</li>
157157
* </ul>
158+
*
159+
* Shortcut for {@code CSVFormat.newBuilder(CSVFormat.DEFAULT)}
160+
*
158161
* @return a standard comma separated format builder, as for {@link #RFC4180} but allowing empty lines.
159162
*/
160163
public static CSVFormatBuilder newBuilder() {
@@ -333,7 +336,7 @@ String[] getHeader() {
333336
*
334337
* @param in
335338
* the input stream
336-
* @throws IOException
339+
* @throws IOException
337340
*/
338341
public Iterable<CSVRecord> parse(final Reader in) throws IOException {
339342
return new CSVParser(in, this);
@@ -579,7 +582,7 @@ public static class CSVFormatBuilder {
579582

580583
/**
581584
* Builds a new CSVFormat configured with the values from this builder.
582-
*
585+
*
583586
* @return a new CSVFormat
584587
*/
585588
public CSVFormat build() {

0 commit comments

Comments
 (0)