tyler.durden
/
snappy-java
mirror of https://github.com/xerial/snappy-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix comments

This commit is contained in:
Taro L. Saito 2014-06-26 14:34:03 +09:00
parent 492be99787
commit 075be36859
3 changed files with 7 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/java/org/xerial/snappy/Snappy.java
View File

@ -37,7 +37,7 @@ import java.util.Properties;
* Note: if the native libraries cannot be loaded, an ExceptionInInitializerError * Note: if the native libraries cannot be loaded, an ExceptionInInitializerError
* will be thrown at first use of this class. * will be thrown at first use of this class.
* *
* @author leo * @author Taro L. Saito
* *
*/ */
public class Snappy public class Snappy

4
src/main/java/org/xerial/snappy/SnappyFramedInputStream.java
View File

@ -55,12 +55,12 @@ public final class SnappyFramedInputStream extends InputStream implements
private boolean closed; private boolean closed;
/** /**
* Indicates if we have reached the EOF on {@link #in}. * Indicates if we have reached the EOF on {@link #input}.
*/ */
private boolean eof; private boolean eof;
/** /**
* The position in {@link buffer} to read to. * The position in {@link #input} buffer to read to.
*/ */
private int valid; private int valid;

16
src/main/java/org/xerial/snappy/SnappyFramedOutputStream.java
View File

@ -371,17 +371,13 @@ public final class SnappyFramedOutputStream extends OutputStream implements
} }
/** /**
* {@link #calculateCRC32C(byte[], int, int) Calculates} the crc, compresses * {@link SnappyFramed#maskedCrc32c(byte[], int, int)} the crc, compresses
* the data, determines if the compression ratio is acceptable and calls * the data, determines if the compression ratio is acceptable and calls
* {@link #writeBlock(OutputStream, byte[], int, int, boolean, int)} to * {@link #writeBlock(java.nio.channels.WritableByteChannel, java.nio.ByteBuffer, boolean, int)} to
* actually write the frame. * actually write the frame.
* *
* @param input * @param buffer
* The byte[] containing the raw data to be compressed.
* @param offset
* The offset into <i>input</i> where the data starts.
* @param length
* The amount of data in <i>input</i>.
* @throws IOException * @throws IOException
*/ */
private void writeCompressed(ByteBuffer buffer) throws IOException { private void writeCompressed(ByteBuffer buffer) throws IOException {
@ -419,10 +415,6 @@ public final class SnappyFramedOutputStream extends OutputStream implements
* The {@link OutputStream} to write to. * The {@link OutputStream} to write to.
* @param data * @param data
* The data to write. * The data to write.
* @param offset
* The offset in <i>data</i> to start at.
* @param length
* The length of <i>data</i> to use.
* @param compressed * @param compressed
* Indicates if <i>data</i> is the compressed or raw content. * Indicates if <i>data</i> is the compressed or raw content.
* This is based on whether the compression ratio desired is * This is based on whether the compression ratio desired is