You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2017/02/04 14:01:03 UTC
commons-compress git commit: javadoc fixes
Repository: commons-compress
Updated Branches:
refs/heads/master ed3c605fc -> 7088ab0a8
javadoc fixes
Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/7088ab0a
Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/7088ab0a
Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/7088ab0a
Branch: refs/heads/master
Commit: 7088ab0a8880c723fa134e694cf87c7815f18fe9
Parents: ed3c605
Author: Stefan Bodewig <bo...@apache.org>
Authored: Sat Feb 4 15:00:48 2017 +0100
Committer: Stefan Bodewig <bo...@apache.org>
Committed: Sat Feb 4 15:00:48 2017 +0100
----------------------------------------------------------------------
.../commons/compress/compressors/lz4/XXHash32.java | 1 +
.../lz77support/AbstractLZ77CompressorInputStream.java | 2 +-
.../org/apache/commons/compress/utils/ByteUtils.java | 13 +++++++++++--
3 files changed, 13 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-compress/blob/7088ab0a/src/main/java/org/apache/commons/compress/compressors/lz4/XXHash32.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/compressors/lz4/XXHash32.java b/src/main/java/org/apache/commons/compress/compressors/lz4/XXHash32.java
index 8c17dc7..b3acd82 100644
--- a/src/main/java/org/apache/commons/compress/compressors/lz4/XXHash32.java
+++ b/src/main/java/org/apache/commons/compress/compressors/lz4/XXHash32.java
@@ -59,6 +59,7 @@ public class XXHash32 implements Checksum {
/**
* Creates an XXHash32 instance.
+ * @param seed the seed to use
*/
public XXHash32(int seed) {
this.seed = seed;
http://git-wip-us.apache.org/repos/asf/commons-compress/blob/7088ab0a/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
index af438e5..49372e4 100644
--- a/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
@@ -190,7 +190,7 @@ public abstract class AbstractLZ77CompressorInputStream extends CompressorInputS
/**
* Used by subclasses to signal the next block contains a back-reference with the given coordinates.
- * @param the offset of the back-reference
+ * @param offset the offset of the back-reference
* @param length the length of the back-reference
*/
protected final void startBackReference(int offset, long length) {
http://git-wip-us.apache.org/repos/asf/commons-compress/blob/7088ab0a/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/utils/ByteUtils.java b/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
index b6d08f7..308ee63 100644
--- a/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
+++ b/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
@@ -39,6 +39,8 @@ public final class ByteUtils {
/**
* The contract is similar to {@link InputStream#read()}, return
* the byte as an unsigned int, -1 if there are no more bytes.
+ * @return the supplied byte or -1 if there are no more bytes
+ * @throws IOException if supplying fails
*/
int getAsByte() throws IOException;
}
@@ -51,6 +53,8 @@ public final class ByteUtils {
/**
* The contract is similar to {@link OutputStream#write(int)},
* consume the lower eight bytes of the int as a byte.
+ * @param b the byte to consume
+ * @throws IOException if consuming fails
*/
void accept(int b) throws IOException;
}
@@ -58,6 +62,7 @@ public final class ByteUtils {
/**
* Reads the given byte array as a little endian long.
* @param bytes the byte array to convert
+ * @return the number read
*/
public static long fromLittleEndian(byte[] bytes) {
return fromLittleEndian(bytes, 0, bytes.length);
@@ -68,6 +73,7 @@ public final class ByteUtils {
* @param bytes the byte array to convert
* @param off the offset into the array that starts the value
* @param length the number of bytes representing the value
+ * @return the number read
* @throws IllegalArgumentException if len is bigger than eight
*/
public static long fromLittleEndian(byte[] bytes, final int off, final int length) {
@@ -83,6 +89,7 @@ public final class ByteUtils {
* Reads the given number of bytes from the given stream as a little endian long.
* @param in the stream to read from
* @param length the number of bytes representing the value
+ * @return the number read
* @throws IllegalArgumentException if len is bigger than eight
* @throws IOException if reading fails or the stream doesn't
* contain the given number of bytes anymore
@@ -109,6 +116,7 @@ public final class ByteUtils {
*
* @param supplier the supplier for bytes
* @param length the number of bytes representing the value
+ * @return the number read
* @throws IllegalArgumentException if len is bigger than eight
* @throws IOException if the supplier fails or doesn't supply the
* given number of bytes anymore
@@ -130,6 +138,7 @@ public final class ByteUtils {
* Reads the given number of bytes from the given input as little endian long.
* @param in the input to read from
* @param length the number of bytes representing the value
+ * @return the number read
* @throws IllegalArgumentException if len is bigger than eight
* @throws IOException if reading fails or the stream doesn't
* contain the given number of bytes anymore
@@ -148,9 +157,9 @@ public final class ByteUtils {
/**
* Inserts the given value into the array as a little endian
* sequence of the given length starting at the given offset.
- * @param array the array to write into
+ * @param b the array to write into
* @param value the value to insert
- * @param offset the offset into the array that receives the first byte
+ * @param off the offset into the array that receives the first byte
* @param length the number of bytes to use to represent the value
*/
public static void toLittleEndian(final byte[] b, final long value, final int off, final int length) {