[commons-io] 17/24: Javadoc

[ggregory]

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

commit 09ce9ed005fbe3a2140ffe67d6cb5cdfe2d1e1f5
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri May 19 10:38:38 2023 -0400

    Javadoc
---
 .../org/apache/commons/io/output/FileWriterWithEncoding.java | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

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 7fffeb21..27bdb603 100644
--- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
+++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
@@ -28,6 +28,7 @@ import java.util.Objects;
 import org.apache.commons.io.Charsets;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
@@ -83,8 +84,17 @@ public class FileWriterWithEncoding extends ProxyWriter {
 
         /**
          * Constructs a new instance.
+         * <p>
+         * This builder use the aspects File, CharsetEncoder, and append.
+         * </p>
+         * <p>
+         * You must provide an origin that can be converted to a File by this 
builder, otherwise, this call will throw an
+         * {@link UnsupportedOperationException}.
+         * </p>
          *
-         * @throws UnsupportedOperationException if the origin cannot be 
converted to a File.
+         * @return a new instance.
+         * @throws UnsupportedOperationException if the origin cannot provide 
a File.
+         * @see AbstractOrigin#getFile()
          */
         @SuppressWarnings("resource")
         @Override