Repository: commons-csv Updated Branches: refs/heads/master becfae1e4 -> 4a8f34023
Javadoc. Project: http://git-wip-us.apache.org/repos/asf/commons-csv/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-csv/commit/4a8f3402 Tree: http://git-wip-us.apache.org/repos/asf/commons-csv/tree/4a8f3402 Diff: http://git-wip-us.apache.org/repos/asf/commons-csv/diff/4a8f3402 Branch: refs/heads/master Commit: 4a8f3402399ae092507347a51de5c9f6fa5c5e8b Parents: becfae1 Author: Gary Gregory <ggreg...@apache.org> Authored: Thu Jul 20 19:26:10 2017 -0700 Committer: Gary Gregory <ggreg...@apache.org> Committed: Thu Jul 20 19:26:10 2017 -0700 ---------------------------------------------------------------------- .../java/org/apache/commons/csv/CSVParser.java | 22 +++++++++----------- 1 file changed, 10 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-csv/blob/4a8f3402/src/main/java/org/apache/commons/csv/CSVParser.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/src/main/java/org/apache/commons/csv/CSVParser.java index 0d2c187..22a7f1b 100644 --- a/src/main/java/org/apache/commons/csv/CSVParser.java +++ b/src/main/java/org/apache/commons/csv/CSVParser.java @@ -161,8 +161,8 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable { * Creates a CSV parser using the given {@link CSVFormat}. * * <p> - * If you do not read all records from the given {@code reader}, you should - * call {@link #close()} on the parser, unless you close the {@code reader}. + * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser, + * unless you close the {@code reader}. * </p> * * @param inputStream @@ -171,12 +171,11 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable { * a Charset. * @param format * the CSVFormat used for CSV parsing. Must not be null. + * @return a new CSVParser configured with the given reader and format. * @throws IllegalArgumentException - * If the parameters of the format are inconsistent or if either - * reader or format are null. + * If the parameters of the format are inconsistent or if either reader or format are null. * @throws IOException - * If there is a problem reading the header or skipping the - * first record + * If there is a problem reading the header or skipping the first record * @since 1.5 */ @SuppressWarnings("resource") @@ -212,20 +211,19 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable { * Creates a CSV parser using the given {@link CSVFormat} * * <p> - * If you do not read all records from the given {@code reader}, you should - * call {@link #close()} on the parser, unless you close the {@code reader}. + * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser, + * unless you close the {@code reader}. * </p> * * @param reader * a Reader containing CSV-formatted input. Must not be null. * @param format * the CSVFormat used for CSV parsing. Must not be null. + * @return a new CSVParser configured with the given reader and format. * @throws IllegalArgumentException - * If the parameters of the format are inconsistent or if either - * reader or format are null. + * If the parameters of the format are inconsistent or if either reader or format are null. * @throws IOException - * If there is a problem reading the header or skipping the - * first record + * If there is a problem reading the header or skipping the first record * @since 1.5 */ public static CSVParser parse(Reader reader, final CSVFormat format) throws IOException {
