mirror of
https://github.com/xerial/snappy-java.git
synced 2025-07-28 00:14:15 +02:00
Fix javadoc comments
This commit is contained in:
parent
9cc5ea85c9
commit
2906673651
6
pom.xml
6
pom.xml
@ -81,7 +81,11 @@
|
|||||||
<plugin>
|
<plugin>
|
||||||
<groupId>org.apache.maven.plugins</groupId>
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
<artifactId>maven-javadoc-plugin</artifactId>
|
<artifactId>maven-javadoc-plugin</artifactId>
|
||||||
<version>2.7</version>
|
<version>2.8</version>
|
||||||
|
<configuration>
|
||||||
|
<charset>UTF-8</charset>
|
||||||
|
<locale>en_US</locale>
|
||||||
|
</configuration>
|
||||||
<executions>
|
<executions>
|
||||||
<execution>
|
<execution>
|
||||||
<id>attach-javadocs</id>
|
<id>attach-javadocs</id>
|
||||||
|
@ -33,7 +33,16 @@ import java.io.OutputStream;
|
|||||||
import java.util.Arrays;
|
import java.util.Arrays;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Preamble header for {@link SnappyOutputStream}
|
* Preamble header for {@link SnappyOutputStream}.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* The magic header is the following 8 bytes data:
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* -126, 'S', 'N', 'A', 'P', 'P', 'Y', 0
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* </p>
|
||||||
*
|
*
|
||||||
* @author leo
|
* @author leo
|
||||||
*
|
*
|
||||||
|
@ -34,10 +34,6 @@ import java.io.InputStream;
|
|||||||
* @author leo
|
* @author leo
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
/**
|
|
||||||
* @author leo
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
public class SnappyInputStream extends InputStream
|
public class SnappyInputStream extends InputStream
|
||||||
{
|
{
|
||||||
private boolean finishedReading = false;
|
private boolean finishedReading = false;
|
||||||
@ -132,7 +128,7 @@ public class SnappyInputStream extends InputStream
|
|||||||
* @param array
|
* @param array
|
||||||
* @param byteOffset
|
* @param byteOffset
|
||||||
* @param byteLength
|
* @param byteLength
|
||||||
* @return
|
* @return written bytes
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
*/
|
*/
|
||||||
public int rawRead(Object array, int byteOffset, int byteLength) throws IOException {
|
public int rawRead(Object array, int byteOffset, int byteLength) throws IOException {
|
||||||
|
@ -453,7 +453,7 @@ public class SnappyLoader
|
|||||||
* This version data is used as a suffix of a dll file extracted from the
|
* This version data is used as a suffix of a dll file extracted from the
|
||||||
* jar.
|
* jar.
|
||||||
*
|
*
|
||||||
* @return
|
* @return the version string
|
||||||
*/
|
*/
|
||||||
public static String getVersion() {
|
public static String getVersion() {
|
||||||
|
|
||||||
|
@ -32,8 +32,10 @@ import java.nio.ByteBuffer;
|
|||||||
* method in this class is defined in SnappyNative.h (genereted by javah) and
|
* method in this class is defined in SnappyNative.h (genereted by javah) and
|
||||||
* SnappyNative.cpp
|
* SnappyNative.cpp
|
||||||
*
|
*
|
||||||
* NEVER USE THIS CLASS DIRECTLY since it breaks the native library code
|
* <p>
|
||||||
* loading.
|
* <b> DO NOT USE THIS CLASS DIRECTLY since the direct use of this class might
|
||||||
|
* break the native library code loading in {@link SnappyLoader}. </b>
|
||||||
|
* </p>
|
||||||
*
|
*
|
||||||
* @author leo
|
* @author leo
|
||||||
*
|
*
|
||||||
|
@ -28,7 +28,8 @@ import java.io.IOException;
|
|||||||
import java.nio.ByteBuffer;
|
import java.nio.ByteBuffer;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Interface to access the native code of Snappy.
|
* Interface to access the native code of Snappy. Although this class members
|
||||||
|
* are public, do not use them directly. Use {@link Snappy} API instead.
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @author leo
|
* @author leo
|
||||||
|
@ -38,7 +38,6 @@ import java.io.OutputStream;
|
|||||||
* <ol>
|
* <ol>
|
||||||
* <li>snappy codec header defined in {@link SnappyCodec}
|
* <li>snappy codec header defined in {@link SnappyCodec}
|
||||||
* <li>a pair of (compressed data size, compressed data...)
|
* <li>a pair of (compressed data size, compressed data...)
|
||||||
* <li>a pair of (compressed data size, compressed data...)
|
|
||||||
* <li>...
|
* <li>...
|
||||||
* </ol>
|
* </ol>
|
||||||
*
|
*
|
||||||
|
Loading…
x
Reference in New Issue
Block a user