(commons-compress) 02/04: 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 c80f8f1b82cb361a9c42784ada83a79877fa2dc0
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Dec 14 10:46:02 2024 -0500

    Javadoc
---
 .../commons/compress/compressors/xz/XZCompressorOutputStream.java     | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git 
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
 
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
index 660419cb3..975d8e0d8 100644
--- 
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
+++ 
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
@@ -26,7 +26,7 @@ import org.tukaani.xz.LZMA2Options;
 import org.tukaani.xz.XZOutputStream;
 
 /**
- * XZ compressor.
+ * Compresses an output stream using the XZ and LZMA2 compression options.
  *
  * <em>Calling flush()</em>
  * <p>
@@ -53,9 +53,11 @@ public class XZCompressorOutputStream extends 
CompressorOutputStream<XZOutputStr
      * Creates a new XZ compressor using the specified LZMA2 preset level.
      * <p>
      * The presets 0-3 are fast presets with medium compression. The presets 
4-6 are fairly slow presets with high compression. The default preset is 6.
+     * </p>
      * <p>
      * The presets 7-9 are like the preset 6 but use bigger dictionaries and 
have higher compressor and decompressor memory requirements. Unless the
      * uncompressed size of the file exceeds 8&nbsp;MiB, 16&nbsp;MiB, or 
32&nbsp;MiB, it is waste of memory to use the presets 7, 8, or 9, respectively.
+     * </p>
      *
      * @param outputStream the stream to wrap
      * @param preset       the preset