This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git


The following commit(s) were added to refs/heads/master by this push:
     new f94af4ae Javadoc
f94af4ae is described below

commit f94af4ae6ed41d379a3dba10d389b6ec1a5394fc
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Jan 13 09:49:26 2024 -0500

    Javadoc
---
 .../java/org/apache/commons/io/output/DeferredFileOutputStream.java | 2 ++
 .../java/org/apache/commons/io/output/FileWriterWithEncoding.java   | 6 ++++--
 src/main/java/org/apache/commons/io/output/LockableFileWriter.java  | 2 ++
 .../org/apache/commons/io/output/UncheckedFilterOutputStream.java   | 2 ++
 .../java/org/apache/commons/io/output/UncheckedFilterWriter.java    | 2 ++
 .../commons/io/output/UnsynchronizedByteArrayOutputStream.java      | 2 ++
 src/main/java/org/apache/commons/io/output/WriterOutputStream.java  | 2 ++
 src/main/java/org/apache/commons/io/output/XmlStreamWriter.java     | 2 ++
 8 files changed, 18 insertions(+), 2 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java 
b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
index 3382bdcd..045eae4a 100644
--- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
@@ -41,6 +41,7 @@ import org.apache.commons.io.file.PathUtils;
  */
 public class DeferredFileOutputStream extends ThresholdingOutputStream {
 
+    // @formatter:off
     /**
      * Builds a new {@link DeferredFileOutputStream} instance.
      * <p>
@@ -62,6 +63,7 @@ public class DeferredFileOutputStream extends 
ThresholdingOutputStream {
      *
      * @since 2.12.0
      */
+    // @formatter:on
     public static class Builder extends 
AbstractStreamBuilder<DeferredFileOutputStream, Builder> {
 
         private int threshold;
diff --git 
a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java 
b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
index 751f0e36..d583b232 100644
--- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
+++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
@@ -51,13 +51,14 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
  */
 public class FileWriterWithEncoding extends ProxyWriter {
 
+    // @formatter:off
     /**
      * Builds a new {@link FileWriterWithEncoding} instance.
      * <p>
      * Using a CharsetEncoder:
      * </p>
      * <pre>{@code
-     * FileWriterWithEncoding s = FileWriterWithEncoding.builder()
+     * FileWriterWithEncoding w = FileWriterWithEncoding.builder()
      *   .setPath(path)
      *   .setAppend(false)
      *   .setCharsetEncoder(StandardCharsets.UTF_8.newEncoder())
@@ -67,7 +68,7 @@ public class FileWriterWithEncoding extends ProxyWriter {
      * Using a Charset:
      * </p>
      * <pre>{@code
-     * FileWriterWithEncoding s = FileWriterWithEncoding.builder()
+     * FileWriterWithEncoding w = FileWriterWithEncoding.builder()
      *   .setPath(path)
      *   .setAppend(false)
      *   .setCharsetEncoder(StandardCharsets.UTF_8)
@@ -76,6 +77,7 @@ public class FileWriterWithEncoding extends ProxyWriter {
      *
      * @since 2.12.0
      */
+    // @formatter:on
     public static class Builder extends 
AbstractStreamBuilder<FileWriterWithEncoding, Builder> {
 
         private boolean append;
diff --git a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java 
b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
index b33abc81..acc28f7d 100644
--- a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
+++ b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
@@ -50,6 +50,7 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
  */
 public class LockableFileWriter extends Writer {
 
+    // @formatter:off
     /**
      * Builds a new {@link LockableFileWriter} instance.
      * <p>
@@ -65,6 +66,7 @@ public class LockableFileWriter extends Writer {
      *
      * @since 2.12.0
      */
+    // @formatter:on
     public static class Builder extends 
AbstractStreamBuilder<LockableFileWriter, Builder> {
 
         private boolean append;
diff --git 
a/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java 
b/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
index 91f115db..aadc6240 100644
--- 
a/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
+++ 
b/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
@@ -38,6 +38,7 @@ import org.apache.commons.io.function.Uncheck;
  */
 public final class UncheckedFilterOutputStream extends FilterOutputStream {
 
+    // @formatter:off
     /**
      * Builds a new {@link UncheckedFilterOutputStream} instance.
      * <p>
@@ -57,6 +58,7 @@ public final class UncheckedFilterOutputStream extends 
FilterOutputStream {
      *   .get();}
      * </pre>
      */
+    // @formatter:on
     public static class Builder extends 
AbstractStreamBuilder<UncheckedFilterOutputStream, Builder> {
 
         /**
diff --git 
a/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java 
b/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java
index f152f487..f126917c 100644
--- a/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java
+++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java
@@ -38,6 +38,7 @@ import org.apache.commons.io.function.Uncheck;
  */
 public final class UncheckedFilterWriter extends FilterWriter {
 
+    // @formatter:off
     /**
      * Builds a new {@link UncheckedFilterWriter} instance.
      * <p>
@@ -57,6 +58,7 @@ public final class UncheckedFilterWriter extends FilterWriter 
{
      *   .get();}
      * </pre>
      */
+    // @formatter:on
     public static class Builder extends 
AbstractStreamBuilder<UncheckedFilterWriter, Builder> {
 
         /**
diff --git 
a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
 
b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
index 232e7186..d68978c6 100644
--- 
a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
+++ 
b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
@@ -37,6 +37,7 @@ import 
org.apache.commons.io.input.UnsynchronizedByteArrayInputStream;
 //@NotThreadSafe
 public final class UnsynchronizedByteArrayOutputStream extends 
AbstractByteArrayOutputStream {
 
+    // @formatter:off
     /**
      * Builds a new {@link UnsynchronizedByteArrayOutputStream} instance.
      * <p>
@@ -56,6 +57,7 @@ public final class UnsynchronizedByteArrayOutputStream 
extends AbstractByteArray
      *   .get();}
      * </pre>
      */
+    // @formatter:on
     public static class Builder extends 
AbstractStreamBuilder<UnsynchronizedByteArrayOutputStream, Builder> {
 
         /**
diff --git a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java 
b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java
index bc2c5c21..e5621875 100644
--- a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java
@@ -78,6 +78,7 @@ import org.apache.commons.io.charset.CharsetDecoders;
  */
 public class WriterOutputStream extends OutputStream {
 
+    // @formatter:off
     /**
      * Builds a new {@link WriterOutputStream} instance.
      * <p>
@@ -94,6 +95,7 @@ public class WriterOutputStream extends OutputStream {
      *
      * @since 2.12.0
      */
+    // @formatter:on
     public static class Builder extends 
AbstractStreamBuilder<WriterOutputStream, Builder> {
 
         private CharsetDecoder charsetDecoder;
diff --git a/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java 
b/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java
index 6f732a72..858a0087 100644
--- a/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java
+++ b/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java
@@ -46,6 +46,7 @@ import org.apache.commons.io.input.XmlStreamReader;
  */
 public class XmlStreamWriter extends Writer {
 
+    // @formatter:off
     /**
      * Builds a new {@link XmlStreamWriter} instance.
      * <p>
@@ -60,6 +61,7 @@ public class XmlStreamWriter extends Writer {
      *
      * @since 2.12.0
      */
+    // @formatter:off
     public static class Builder extends AbstractStreamBuilder<XmlStreamWriter, 
Builder> {
 
         /**

Reply via email to