Skip to content

Commit 563c9d2

Browse files
committed
Javadoc
1 parent ce73bd8 commit 563c9d2

File tree

1 file changed

+10
-10
lines changed
  • src/main/java/org/apache/commons/compress/harmony/pack200

1 file changed

+10
-10
lines changed

src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
import java.util.zip.ZipEntry;
3131

3232
/**
33-
* 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
34-
* JarFile as input and an OutputStream. Options can be set, then {@code pack()} is called, to pack the Jar file into a pack200 archive.
33+
* 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
34+
* {@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.
3535
*/
3636
public class Archive {
3737

@@ -148,11 +148,11 @@ public int getPackedByteAmount() {
148148
private final PackingOptions options;
149149

150150
/**
151-
* Creates an Archive with the given input file and a stream for the output
151+
* Creates an Archive with the given input file and a stream for the output.
152152
*
153-
* @param jarFile the input file
154-
* @param outputStream TODO
155-
* @param options packing options (if null then defaults are used)
153+
* @param jarFile the input file.
154+
* @param outputStream target output stream for the compressed data.
155+
* @param options packing options (if null then defaults are used).
156156
* @throws IOException If an I/O error occurs.
157157
*/
158158
public Archive(final JarFile jarFile, OutputStream outputStream, PackingOptions options) throws IOException {
@@ -165,16 +165,16 @@ public Archive(final JarFile jarFile, OutputStream outputStream, PackingOptions
165165
}
166166
this.outputStream = new BufferedOutputStream(outputStream);
167167
this.jarFile = jarFile;
168-
jarInputStream = null;
168+
this.jarInputStream = null;
169169
PackingUtils.config(options);
170170
}
171171

172172
/**
173173
* Creates an Archive with streams for the input and output.
174174
*
175-
* @param inputStream TODO
176-
* @param outputStream TODO
177-
* @param options packing options (if null then defaults are used)
175+
* @param inputStream input stream of uncompressed JAR data.
176+
* @param outputStream target output stream for the compressed data.
177+
* @param options packing options (if null then defaults are used).
178178
* @throws IOException If an I/O error occurs.
179179
*/
180180
public Archive(final JarInputStream inputStream, OutputStream outputStream, PackingOptions options) throws IOException {

0 commit comments

Comments
 (0)