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

Fixes issue 30. Add "make javadoc" target

This commit is contained in:
Taro L. Saito 2011-09-22 15:47:29 +09:00
parent ebf661dc74
commit f990526b52
5 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.hgsubstate
View File

@ -1 +1 @@
77d1002a0dd1ee7fd1551e001f365926db40dbe2 wiki 7eafb7683a3741d8747c7a78ca2fedf32cd19e69 wiki

3
Makefile
View File

@ -94,3 +94,6 @@ clean-native-linux32:
clean-native-win32: clean-native-win32:
$(MAKE) clean-native OS_NAME=Windows OS_ARCH=x86 $(MAKE) clean-native OS_NAME=Windows OS_ARCH=x86
javadoc:
$(MVN) javadoc:javadoc -DreportOutputDirectory=wiki/apidocs

9
src/main/java/org/xerial/snappy/SnappyLoader.java
View File

@ -44,10 +44,11 @@ import java.util.List;
import java.util.Properties; import java.util.Properties;
/** /**
* This class loads a native library of snappy-java (snappyjava.dll, * <b>Internal only - Do not use this class.</b> This class loads a native
* libsnappy.so, etc.) according to the user platform (<i>os.name</i> and * library of snappy-java (snappyjava.dll, libsnappy.so, etc.) according to the
* <i>os.arch</i>). The natively compiled libraries bundled to snappy-java * user platform (<i>os.name</i> and <i>os.arch</i>). The natively compiled
* contain the codes of the original snappy and JNI programs to access Snappy. * libraries bundled to snappy-java contain the codes of the original snappy and
* JNI programs to access Snappy.
* *
* In default, no configuration is required to use snappy-java, but you can load * In default, no configuration is required to use snappy-java, but you can load
* your own native library created by 'make native' command. * your own native library created by 'make native' command.

6
src/main/java/org/xerial/snappy/SnappyNative.java
View File

@ -28,9 +28,9 @@ import java.io.IOException;
import java.nio.ByteBuffer; import java.nio.ByteBuffer;
/** /**
* JNI interface of the {@link SnappyNativeAPI} implementation. The native * <b>Internal only - Do not use this class.</b> JNI interface of the
* method in this class is defined in SnappyNative.h (genereted by javah) and * {@link SnappyNativeAPI} implementation. The native method in this class is
* SnappyNative.cpp * defined in SnappyNative.h (genereted by javah) and SnappyNative.cpp
* *
* <p> * <p>
* <b> DO NOT USE THIS CLASS since the direct use of this class might break the * <b> DO NOT USE THIS CLASS since the direct use of this class might break the

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

@ -28,6 +28,8 @@ import java.io.IOException;
import java.nio.ByteBuffer; import java.nio.ByteBuffer;
/** /**
* <b>Internal only - Do not use this class.</b>
*
* Interface to access the native code of Snappy. Although this class members * Interface to access the native code of Snappy. Although this class members
* are public, do not use them directly. Use {@link Snappy} API instead. * are public, do not use them directly. Use {@link Snappy} API instead.
* *