(commons-compress) branch master updated: 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-compress.git


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

commit 1a26c501f5581ff42ca10b8fdf0189983fd2ec2d
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Mar 20 20:15:31 2025 -0400

    Javadoc
---
 .../compressors/zstandard/ZstdCompressorInputStream.java       | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorInputStream.java
 
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorInputStream.java
index 1ca1e716d..2eae58e1d 100644
--- 
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorInputStream.java
+++ 
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorInputStream.java
@@ -40,14 +40,20 @@ public class ZstdCompressorInputStream extends 
CompressorInputStream implements
     private final BoundedInputStream countingStream;
     private final ZstdInputStream decIS;
 
+    /**
+     * Constructs a new input stream that decompresses zstd-compressed data 
from the specific input stream.
+     *
+     * @param in         the input stream of compressed data.
+     * @throws IOException if an I/O error occurs.
+     */
     public ZstdCompressorInputStream(final InputStream in) throws IOException {
         this.decIS = new ZstdInputStream(countingStream = 
BoundedInputStream.builder().setInputStream(in).get());
     }
 
     /**
-     * Creates a new input stream that decompresses zstd-compressed data from 
the specific input stream
+     * Constructs a new input stream that decompresses zstd-compressed data 
from the specific input stream.
      *
-     * @param in         the input stream of compressed data
+     * @param in         the input stream of compressed data.
      * @param bufferPool a configuration of zstd-jni that allows users to 
customize how buffers are recycled. Either a {@link 
com.github.luben.zstd.NoPool} or a
      *                   {@link com.github.luben.zstd.RecyclingBufferPool} is 
allowed here.
      * @throws IOException if an I/O error occurs.