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 9e6ffa9f5bb642ab0a577b364f2e95835347bc61 Author: Gary Gregory <[email protected]> AuthorDate: Thu Nov 20 13:36:59 2025 +0000 Fix Javadoc - Javadoc 8 can't find @link, newer version can, use @code instead - Sentences end in a period --- .../compressors/lz77support/LZ77Compressor.java | 28 +++++++++++----------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java b/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java index 8eef16911..4f58abf56 100644 --- a/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java +++ b/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java @@ -103,9 +103,9 @@ public AbstractReference(final BlockType blockType, final int offset, final int } /** - * Gets the offset of the reference. + * Gets the length of the reference. * - * @return the length + * @return the length of the reference. */ public int getLength() { return length; @@ -114,7 +114,7 @@ public int getLength() { /** * Gets the offset of the reference. * - * @return the offset + * @return the offset of the reference. */ public int getOffset() { return offset; @@ -179,7 +179,7 @@ public enum BlockType { /** * Constructs a new typeless instance. * - * @deprecated Use {@link #Block(BlockType)}. + * @deprecated Use {@code LZ77Compressor.Block#Block(BlockType)}. */ @Deprecated public Block() { @@ -223,8 +223,8 @@ public interface Callback { /** * Consumes a block. * - * @param b the block to consume - * @throws IOException in case of an error + * @param b the block to consume. + * @throws IOException in case of an error. */ void accept(Block b) throws IOException; } @@ -402,8 +402,8 @@ private void compress() throws IOException { /** * Feeds bytes into the compressor which in turn may emit zero or more blocks to the callback during the execution of this method. * - * @param data the data to compress - must not be null - * @throws IOException if the callback throws an exception + * @param data the data to compress - must not be null. + * @throws IOException if the callback throws an exception. */ public void compress(final byte[] data) throws IOException { compress(data, 0, data.length); @@ -412,12 +412,12 @@ public void compress(final byte[] data) throws IOException { /** * Feeds bytes into the compressor which in turn may emit zero or more blocks to the callback during the execution of this method. * - * @param data the data to compress - must not be null - * @param off the start offset of the data - * @param len the number of bytes to compress - * @throws NullPointerException if data is {@code null} + * @param data the data to compress - must not be null. + * @param off the start offset of the data. + * @param len the number of bytes to compress. + * @throws NullPointerException if data is {@code null}. * @throws IndexOutOfBoundsException if {@code off} or {@code len} are negative, or if {@code off + len} is bigger than {@code data.length}. - * @throws IOException if the callback throws an exception + * @throws IOException if the callback throws an exception. */ public void compress(final byte[] data, int off, int len) throws IOException { IOUtils.checkFromIndexSize(data, off, len); @@ -588,7 +588,7 @@ private int nextHash(final int oldHash, final byte nextByte) { * </p> * * @param data the data to fill the window with. - * @throws IllegalStateException if the compressor has already started to accept data + * @throws IllegalStateException if the compressor has already started to accept data. */ public void prefill(final byte[] data) { if (currentPosition != 0 || lookahead != 0) {
