(commons-compress) 02/02: 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

commit cf7e15a59a7adca7f4b2618b938fa703be1ea408
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jan 5 08:15:45 2025 -0500

    Javadoc
---
 .../compress/compressors/brotli/BrotliCompressorInputStream.java    | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git 
a/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliCompressorInputStream.java
 
b/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliCompressorInputStream.java
index f83da7689..c37b29c93 100644
--- 
a/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliCompressorInputStream.java
+++ 
b/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliCompressorInputStream.java
@@ -38,6 +38,12 @@ public class BrotliCompressorInputStream extends 
CompressorInputStream implement
     private final BoundedInputStream countingInputStream;
     private final BrotliInputStream brotliInputStream;
 
+    /**
+     * Construct a new instance.
+     *
+     * @param inputStream underlying data source.
+     * @throws IOException in case of corrupted data or source stream problems.
+     */
     public BrotliCompressorInputStream(final InputStream inputStream) throws 
IOException {
         brotliInputStream = new BrotliInputStream(countingInputStream = 
BoundedInputStream.builder().setInputStream(inputStream).get());
     }