From 8000d695901ea64b99584a37b6a765561179c727 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sun, 24 May 2020 16:02:55 -0400 Subject: [PATCH] Javadoc. --- src/main/java/org/apache/commons/csv/CSVFormat.java | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java index e0258f34..c00f993f 100644 --- a/src/main/java/org/apache/commons/csv/CSVFormat.java +++ b/src/main/java/org/apache/commons/csv/CSVFormat.java @@ -1261,21 +1261,19 @@ public final class CSVFormat implements Serializable { } /** - * Prints to the specified output. + * Prints to the specified output, returns a {@code CSVPrinter} which the caller MUST close. * *

* See also {@link CSVPrinter}. *

* - * @param out - * the output. - * @param charset - * A charset. + * @param out the output. + * @param charset A charset. * @return a printer to an output. - * @throws IOException - * thrown if the optional header cannot be printed. + * @throws IOException thrown if the optional header cannot be printed. * @since 1.5 */ + @SuppressWarnings("resource") public CSVPrinter print(final Path out, final Charset charset) throws IOException { return print(Files.newBufferedWriter(out, charset)); }