(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 563c9d2fa4d2340902284fc044a7398fc15da5fb
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Jul 26 08:46:51 2025 -0400

    Javadoc
---
 .../commons/compress/harmony/pack200/Archive.java    | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java 
b/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
index c2017bdc4..86c4ca77f 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
@@ -30,8 +30,8 @@
 import java.util.zip.ZipEntry;
 
 /**
- * Archive is the main entry point to pack200 and represents a packed archive. 
An archive is constructed with either a JarInputStream and an output stream or a
- * JarFile as input and an OutputStream. Options can be set, then {@code 
pack()} is called, to pack the Jar file into a pack200 archive.
+ * Main entry point to pack200 and represents a packed archive. An archive is 
constructed with either a {@link JarInputStream} and an output stream or a
+ * {@link JarFile} as input and an OutputStream. Options can be set, then 
{@link #pack()} is called, to pack the Jar file into a pack200 archive.
  */
 public class Archive {
 
@@ -148,11 +148,11 @@ public int getPackedByteAmount() {
     private final PackingOptions options;
 
     /**
-     * Creates an Archive with the given input file and a stream for the output
+     * Creates an Archive with the given input file and a stream for the 
output.
      *
-     * @param jarFile      the input file
-     * @param outputStream TODO
-     * @param options      packing options (if null then defaults are used)
+     * @param jarFile      the input file.
+     * @param outputStream target output stream for the compressed data.
+     * @param options      packing options (if null then defaults are used).
      * @throws IOException If an I/O error occurs.
      */
     public Archive(final JarFile jarFile, OutputStream outputStream, 
PackingOptions options) throws IOException {
@@ -165,16 +165,16 @@ public Archive(final JarFile jarFile, OutputStream 
outputStream, PackingOptions
         }
         this.outputStream = new BufferedOutputStream(outputStream);
         this.jarFile = jarFile;
-        jarInputStream = null;
+        this.jarInputStream = null;
         PackingUtils.config(options);
     }
 
     /**
      * Creates an Archive with streams for the input and output.
      *
-     * @param inputStream  TODO
-     * @param outputStream TODO
-     * @param options      packing options (if null then defaults are used)
+     * @param inputStream  input stream of uncompressed JAR data.
+     * @param outputStream target output stream for the compressed data.
+     * @param options      packing options (if null then defaults are used).
      * @throws IOException If an I/O error occurs.
      */
     public Archive(final JarInputStream inputStream, OutputStream 
outputStream, PackingOptions options) throws IOException {