From f990526b5201edaf0c459b9364f331b2399c66ae Mon Sep 17 00:00:00 2001 From: "Taro L. Saito" Date: Thu, 22 Sep 2011 15:47:29 +0900 Subject: [PATCH] Fixes issue 30. Add "make javadoc" target --- .hgsubstate | 2 +- Makefile | 3 +++ src/main/java/org/xerial/snappy/SnappyLoader.java | 9 +++++---- src/main/java/org/xerial/snappy/SnappyNative.java | 6 +++--- src/main/java/org/xerial/snappy/SnappyNativeAPI.java | 2 ++ 5 files changed, 14 insertions(+), 8 deletions(-) diff --git a/.hgsubstate b/.hgsubstate index 9c6523a..993f3f4 100644 --- a/.hgsubstate +++ b/.hgsubstate @@ -1 +1 @@ -77d1002a0dd1ee7fd1551e001f365926db40dbe2 wiki +7eafb7683a3741d8747c7a78ca2fedf32cd19e69 wiki diff --git a/Makefile b/Makefile index 671d964..7ad5cc6 100644 --- a/Makefile +++ b/Makefile @@ -94,3 +94,6 @@ clean-native-linux32: clean-native-win32: $(MAKE) clean-native OS_NAME=Windows OS_ARCH=x86 + +javadoc: + $(MVN) javadoc:javadoc -DreportOutputDirectory=wiki/apidocs diff --git a/src/main/java/org/xerial/snappy/SnappyLoader.java b/src/main/java/org/xerial/snappy/SnappyLoader.java index 3433e5c..4a33396 100755 --- a/src/main/java/org/xerial/snappy/SnappyLoader.java +++ b/src/main/java/org/xerial/snappy/SnappyLoader.java @@ -44,10 +44,11 @@ import java.util.List; import java.util.Properties; /** - * This class loads a native library of snappy-java (snappyjava.dll, - * libsnappy.so, etc.) according to the user platform (os.name and - * os.arch). The natively compiled libraries bundled to snappy-java - * contain the codes of the original snappy and JNI programs to access Snappy. + * Internal only - Do not use this class. This class loads a native + * library of snappy-java (snappyjava.dll, libsnappy.so, etc.) according to the + * user platform (os.name and os.arch). The natively compiled + * 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 * your own native library created by 'make native' command. diff --git a/src/main/java/org/xerial/snappy/SnappyNative.java b/src/main/java/org/xerial/snappy/SnappyNative.java index 7c527ee..9b42064 100755 --- a/src/main/java/org/xerial/snappy/SnappyNative.java +++ b/src/main/java/org/xerial/snappy/SnappyNative.java @@ -28,9 +28,9 @@ import java.io.IOException; import java.nio.ByteBuffer; /** - * JNI interface of the {@link SnappyNativeAPI} implementation. The native - * method in this class is defined in SnappyNative.h (genereted by javah) and - * SnappyNative.cpp + * Internal only - Do not use this class. JNI interface of the + * {@link SnappyNativeAPI} implementation. The native method in this class is + * defined in SnappyNative.h (genereted by javah) and SnappyNative.cpp * *

* DO NOT USE THIS CLASS since the direct use of this class might break the diff --git a/src/main/java/org/xerial/snappy/SnappyNativeAPI.java b/src/main/java/org/xerial/snappy/SnappyNativeAPI.java index 36989d9..6bf9fcc 100755 --- a/src/main/java/org/xerial/snappy/SnappyNativeAPI.java +++ b/src/main/java/org/xerial/snappy/SnappyNativeAPI.java @@ -28,6 +28,8 @@ import java.io.IOException; import java.nio.ByteBuffer; /** + * Internal only - Do not use this class. + * * Interface to access the native code of Snappy. Although this class members * are public, do not use them directly. Use {@link Snappy} API instead. *