[commons-io] branch master updated: [IO-564] Pick up Javadoc from super for override write() methods in AbstractByteArrayOutputStream and ByteArrayOutputStream

[gg...@apache.org]

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 cddd19d0 [IO-564] Pick up Javadoc from super for override write() methods in AbstractByteArrayOutputStream and ByteArrayOutputStream
cddd19d0 is described below

commit cddd19d0826091713993727fafff11ac3849b088
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon Jun 20 14:29:42 2022 -0400

    [IO-564] Pick up Javadoc from super for override write() methods in
    AbstractByteArrayOutputStream and ByteArrayOutputStream
---
 src/changes/changes.xml                              |  3 +++
 .../io/output/AbstractByteArrayOutputStream.java     | 20 +++++---------------
 2 files changed, 8 insertions(+), 15 deletions(-)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index e96bf217..205a673e 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -183,6 +183,9 @@ The <action> type attribute can be add,update,fix,remove.
       <action issue="IO-772" dev="ggregory" type="fix" due-to="Dan Ziemba, Gary Gregory">
         Confusing Javadoc on IOUtils#resourceToURL() and other resource* methods.
       </action>
+      <action issue="IO-564" dev="ggregory" type="fix" due-to=", Gary Gregory">
+        Pick up Javadoc from super for override write() methods in AbstractByteArrayOutputStream and ByteArrayOutputStream.
+      </action>
       <!-- ADD -->
       <action type="add" dev="ggregory" due-to="Gary Gregory">
         Add GitHub coverage.yml.
diff --git a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
index 9480793d..96548a89 100644
--- a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
@@ -95,12 +95,12 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream {
     private boolean reuseBuffers = true;
 
     /**
-     * Closing a {@link ByteArrayOutputStream} has no effect. The methods in
-     * this class can be called after the stream has been closed without
-     * generating an {@link IOException}.
+     * Does nothing.
      *
-     * @throws IOException never (this method should not declare this exception
-     * but it has to now due to backwards compatibility)
+     * The methods in this class can be called after the stream has been closed without generating an {@link IOException}.
+     *
+     * @throws IOException never (this method should not declare this exception but it has to now due to backwards
+     *         compatibility)
      */
     @Override
     public void close() throws IOException {
@@ -291,12 +291,6 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream {
         return new String(toByteArray(), enc);
     }
 
-    /**
-     * Writes the bytes to the byte array.
-     * @param b the bytes to write
-     * @param off The start offset
-     * @param len The number of bytes to write
-     */
     @Override
     public abstract void write(final byte[] b, final int off, final int len);
 
@@ -313,10 +307,6 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream {
      */
     public abstract int write(final InputStream in) throws IOException;
 
-    /**
-     * Write a byte to byte array.
-     * @param b the byte to write
-     */
     @Override
     public abstract void write(final int b);