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 b2536ca08 Use Javadoc @code
b2536ca08 is described below
commit b2536ca0846e2539f865bafd180a1f4aaa753d4b
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Jul 29 16:34:25 2024 -0400
Use Javadoc @code
- Whitespace
- Close HTML tags
---
.../commons/compress/archivers/ar/package-info.java | 2 +-
.../compress/compressors/lz4/package-info.java | 6 +++---
.../compress/compressors/lz77support/Parameters.java | 20 ++++----------------
.../compress/compressors/pack200/package-info.java | 18 +++++++++---------
.../compress/compressors/snappy/package-info.java | 6 +++---
.../harmony/archive/internal/nls/Messages.java | 4 ++--
6 files changed, 22 insertions(+), 34 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ar/package-info.java
b/src/main/java/org/apache/commons/compress/archivers/ar/package-info.java
index 001e25591..3adbcf84e 100644
--- a/src/main/java/org/apache/commons/compress/archivers/ar/package-info.java
+++ b/src/main/java/org/apache/commons/compress/archivers/ar/package-info.java
@@ -20,7 +20,7 @@
/**
* Provides stream classes for reading and writing archives using the AR
format.
* <p>
- * The ar format is used - among many other things - for Debian
<code>.deb</code> packages.
+ * The ar format is used - among many other things - for Debian {@code .deb}
packages.
* </p>
*/
package org.apache.commons.compress.archivers.ar;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lz4/package-info.java
b/src/main/java/org/apache/commons/compress/compressors/lz4/package-info.java
index f5a86529e..493ba7d6d 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lz4/package-info.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lz4/package-info.java
@@ -20,13 +20,13 @@
/**
* Provides stream classes for the <a
href="https://lz4.github.io/lz4/";>LZ4</a> algorithm.
* <p>
- * The block LZ4 format which only contains the compressed data is supported
by the <code>BlockLZ4Compressor*putStream</code> classes while the frame format
is
- * implemented by <code>FramedLZ4Compressor*putStream</code>. The
implementation in Commons Compress is based on the specifications "Last
revised: 2015-03-26"
+ * The block LZ4 format which only contains the compressed data is supported
by the {@code BlockLZ4Compressor*putStream} classes while the frame format is
+ * implemented by {@code FramedLZ4Compressor*putStream}. The implementation in
Commons Compress is based on the specifications "Last revised: 2015-03-26"
* for the block format and version "1.5.1 (31/03/2015)" for the frame format.
* </p>
* <p>
* Only the frame format can be auto-detected this means you have to speficy
the format explicitly if you want to read a block LZ4 stream via
- * <code>CompressorStreamFactory</code>.
+ * {@code CompressorStreamFactory}.
* </p>
*/
package org.apache.commons.compress.compressors.lz4;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
b/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
index d912005f7..ce965d62d 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
@@ -22,10 +22,12 @@ package org.apache.commons.compress.compressors.lz77support;
* Parameters of the {@link LZ77Compressor compressor}.
*/
public final class Parameters {
+
/**
* Builder for {@link Parameters} instances.
*/
public static class Builder {
+
private final int windowSize;
private int minBackReferenceLength, maxBackReferenceLength, maxOffset,
maxLiteralLength;
private Integer niceBackReferenceLength, maxCandidates, lazyThreshold;
@@ -61,7 +63,6 @@ public final class Parameters {
/**
* Changes the default setting for "nice back-reference length" and
"maximum number of candidates" for improved compression ratio at the cost of
* compression speed.
- *
* <p>
* Use this method after configuring "maximum back-reference length".
* </p>
@@ -78,7 +79,6 @@ public final class Parameters {
/**
* Changes the default setting for "nice back-reference length" and
"maximum number of candidates" for improved compression speed at the cost of
* compression ratio.
- *
* <p>
* Use this method after configuring "maximum back-reference length".
* </p>
@@ -95,12 +95,10 @@ public final class Parameters {
/**
* Sets whether lazy matching should be performed.
- *
* <p>
* Lazy matching means that after a back-reference for a certain
position has been found the compressor will try to find a longer match for the
next
* position.
* </p>
- *
* <p>
* Lazy matching is enabled by default and disabled when tuning for
speed.
* </p>
@@ -115,7 +113,6 @@ public final class Parameters {
/**
* Sets the threshold for lazy matching.
- *
* <p>
* Even if lazy matching is enabled it will not be performed if the
length of the back-reference found for the current position is longer than this
* value.
@@ -131,7 +128,6 @@ public final class Parameters {
/**
* Sets the maximal length of a back-reference.
- *
* <p>
* It is recommended to not use this method directly but rather tune a
pre-configured builder created by a format specific factory like
* {@link
org.apache.commons.compress.compressors.snappy.SnappyCompressorOutputStream#createParameterBuilder}.
@@ -149,7 +145,6 @@ public final class Parameters {
/**
* Sets the maximal length of a literal block.
- *
* <p>
* It is recommended to not use this method directly but rather tune a
pre-configured builder created by a format specific factory like
* {@link
org.apache.commons.compress.compressors.snappy.SnappyCompressorOutputStream#createParameterBuilder}.
@@ -166,7 +161,6 @@ public final class Parameters {
/**
* Sets the maximum number of back-reference candidates that should be
consulted.
- *
* <p>
* This settings can be used to tune the tradeoff between compression
speed and compression ratio.
* </p>
@@ -181,15 +175,13 @@ public final class Parameters {
/**
* Sets the maximal offset of a back-reference.
- *
* <p>
* It is recommended to not use this method directly but rather tune a
pre-configured builder created by a format specific factory like
* {@link
org.apache.commons.compress.compressors.snappy.SnappyCompressorOutputStream#createParameterBuilder}.
* </p>
*
* @param maxOffset maximal offset of a back-reference. A non-positive
value as well as values bigger than {@code windowSize - 1} are interpreted as
- * <code>windowSize
- * - 1</code> .
+ * {@code windowSize * - 1}.
* @return the builder
*/
public Builder withMaxOffset(final int maxOffset) {
@@ -199,10 +191,9 @@ public final class Parameters {
/**
* Sets the minimal length of a back-reference.
- *
* <p>
* Ensures {@code maxBackReferenceLength} is not smaller than {@code
minBackReferenceLength}.
- *
+ * </p>
* <p>
* It is recommended to not use this method directly but rather tune a
pre-configured builder created by a format specific factory like
* {@link
org.apache.commons.compress.compressors.snappy.SnappyCompressorOutputStream#createParameterBuilder}.
@@ -226,11 +217,9 @@ public final class Parameters {
/**
* Sets the "nice length" of a back-reference.
- *
* <p>
* When a back-references if this size has been found, stop searching
for longer back-references.
* </p>
- *
* <p>
* This settings can be used to tune the tradeoff between compression
speed and compression ratio.
* </p>
@@ -252,7 +241,6 @@ public final class Parameters {
/**
* Initializes the builder for the compressor's parameters with a {@code
minBackReferenceLength} of 3 and {@code max*Length} equal to
* {@code windowSize - 1}.
- *
* <p>
* It is recommended to not use this method directly but rather tune a
pre-configured builder created by a format specific factory like
* {@link
org.apache.commons.compress.compressors.snappy.SnappyCompressorOutputStream#createParameterBuilder}.
diff --git
a/src/main/java/org/apache/commons/compress/compressors/pack200/package-info.java
b/src/main/java/org/apache/commons/compress/compressors/pack200/package-info.java
index 010443d1d..c6a67c39f 100644
---
a/src/main/java/org/apache/commons/compress/compressors/pack200/package-info.java
+++
b/src/main/java/org/apache/commons/compress/compressors/pack200/package-info.java
@@ -32,14 +32,14 @@
* <a
href="https://download.oracle.com/javase/1.5.0/docs/api/java/util/jar/Pack200.html";>API
documentation of Pack200</a>.
* </p>
* <p>
- * The streams of this package work on non-deflated streams, i.e. archives
like those created with the <code>--no-gzip</code> option of the JDK's
- * <code>pack200</code> command line tool. If you want to work on deflated
streams you must use an additional stream layer - for example by using Apache
Commons
+ * The streams of this package work on non-deflated streams, i.e. archives
like those created with the {@code --no-gzip} option of the JDK's
+ * {@code pack200} command line tool. If you want to work on deflated streams
you must use an additional stream layer - for example by using Apache Commons
* Compress' gzip package.
* </p>
* <p>
- * The Pack200 API provided by the Java class library doesn't lend itself to
real stream processing. <code>Pack200CompressorInputStream</code> will
uncompress
- * its input immediately and then provide an <code>InputStream</code> to a
cached result. Likewise <code>Pack200CompressorOutputStream</code> will not
write
- * anything to the given OutputStream until <code>finish</code> or
<code>close</code> is called - at which point the cached output written so far
gets
+ * The Pack200 API provided by the Java class library doesn't lend itself to
real stream processing. {@code Pack200CompressorInputStream} will uncompress
+ * its input immediately and then provide an {@code InputStream} to a cached
result. Likewise {@code Pack200CompressorOutputStream} will not write
+ * anything to the given OutputStream until {@code finish} or {@code close} is
called - at which point the cached output written so far gets
* compressed.
* </p>
* <p>
@@ -47,14 +47,14 @@
* switch to the temporary file option if your archives are really big.
* </p>
* <p>
- * Given there always is an intermediate result the <code>getBytesRead</code>
and <code>getCount</code> methods of <code>Pack200CompressorInputStream</code>
are
+ * Given there always is an intermediate result the {@code getBytesRead} and
{@code getCount} methods of {@code Pack200CompressorInputStream} are
* meaningless (read from the real stream or from the intermediate result?)
and always return 0.
* </p>
* <p>
* During development of the initial version several attempts have been made
to use a real streaming API based for example on
- * <code>Piped(In|Out)putStream</code> or explicit stream pumping like Commons
Exec's <code>InputStreamPumper</code> but they have all failed because they rely
- * on the output end to be consumed completely or else the
<code>(un)pack</code> will block forever. Especially for
<code>Pack200InputStream</code> it is very
- * likely that it will be wrapped in a <code>ZipArchiveInputStream</code>
which will never read the archive completely as it is not interested in the ZIP
+ * {@code Piped(In|Out)putStream} or explicit stream pumping like Commons
Exec's {@code InputStreamPumper} but they have all failed because they rely
+ * on the output end to be consumed completely or else the {@code (un)pack}
will block forever. Especially for {@code Pack200InputStream} it is very
+ * likely that it will be wrapped in a {@code ZipArchiveInputStream} which
will never read the archive completely as it is not interested in the ZIP
* central directory data at the end of the JAR archive.
* </p>
*/
diff --git
a/src/main/java/org/apache/commons/compress/compressors/snappy/package-info.java
b/src/main/java/org/apache/commons/compress/compressors/snappy/package-info.java
index ba0e95b9a..cfc8e5495 100644
---
a/src/main/java/org/apache/commons/compress/compressors/snappy/package-info.java
+++
b/src/main/java/org/apache/commons/compress/compressors/snappy/package-info.java
@@ -20,13 +20,13 @@
/**
* Provides stream classes for the <a
href="https://github.com/google/snappy";>Snappy</a> algorithm.
* <p>
- * The raw Snappy format which only contains the compressed data is supported
by the <code>SnappyCompressor*putStream</code> classes while the so called
- * "framing format" is implemented by
<code>FramedSnappyCompressor*putStream</code>. Note there have been different
versions of the framing format
+ * The raw Snappy format which only contains the compressed data is supported
by the {@code SnappyCompressor*putStream} classes while the so called
+ * "framing format" is implemented by {@code
FramedSnappyCompressor*putStream}. Note there have been different versions of
the framing format
* specification, the implementation in Commons Compress is based on the
specification "Last revised: 2013-10-25".
* </p>
* <p>
* Only the "framing format" can be auto-detected this means you have to
speficy the format explicitly if you want to read a "raw" Snappy stream via
- * <code>CompressorStreamFactory</code>.
+ * {@code CompressorStreamFactory}.
* </p>
*/
package org.apache.commons.compress.compressors.snappy;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/Messages.java
b/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/Messages.java
index 068990f60..97e3fe82e 100644
---
a/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/Messages.java
+++
b/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/Messages.java
@@ -36,9 +36,9 @@ import java.util.ResourceBundle;
/**
* This class retrieves strings from a resource bundle and returns them,
formatting them with MessageFormat when required.
* <p>
- * It is used by the system classes to provide national language support, by
looking up messages in the <code>
+ * It is used by the system classes to provide national language support, by
looking up messages in the {@code
* org.apache.commons.compress.harmony.archive.internal.nls.messages
- * </code> resource bundle. Note that if this file is not available, or an
invalid key is looked up, or resource bundle support is not available, the key
itself
+ * } resource bundle. Note that if this file is not available, or an invalid
key is looked up, or resource bundle support is not available, the key itself
* will be returned as the associated message. This means that the
<em>KEY</em> should a reasonable human-readable (english) string.
*/
public class Messages {
