From a0ce328f98cdbd1518ca92cfb535e7c5c24af42a Mon Sep 17 00:00:00 2001 From: Alexander Smorkalov Date: Tue, 3 Jul 2012 09:19:04 +0000 Subject: [PATCH] Internal docs about service were moved to opencv_extra. --- android/service/doc/AsyncServiceHelper.rst | 26 --------- android/service/doc/IOpenCVEngine.rst | 54 ------------------ android/service/doc/NativeHelper.rst | 5 -- android/service/doc/OpenCVEngineInterface.rst | 57 ------------------- android/service/doc/StaticHelper.rst | 24 -------- 5 files changed, 166 deletions(-) delete mode 100644 android/service/doc/AsyncServiceHelper.rst delete mode 100644 android/service/doc/IOpenCVEngine.rst delete mode 100644 android/service/doc/NativeHelper.rst delete mode 100644 android/service/doc/OpenCVEngineInterface.rst delete mode 100644 android/service/doc/StaticHelper.rst diff --git a/android/service/doc/AsyncServiceHelper.rst b/android/service/doc/AsyncServiceHelper.rst deleted file mode 100644 index b63ba424b..000000000 --- a/android/service/doc/AsyncServiceHelper.rst +++ /dev/null @@ -1,26 +0,0 @@ -******************************************* -Java Asynchronious OpenCV Helper (internal) -******************************************* - -.. highlight:: java -.. module:: org.opencv.android - :platform: Android - :synopsis: Implements Android dependent Java classes -.. Class:: AsyncServiceHelper - -Helper class provides implementation of asynchronious OpenCV initialization with Android OpenCV Engine Service. - -.. note:: This is imternal class. Does not use it directly. Use OpenCVLoader.initAsync() instead! - -int initOpenCV() ----------------- - -.. method:: int initOpenCV(String Version, Context AppContext, LoaderCallbackInterface Callback) - - Tries to init OpenCV library using OpenCV Engine Service. Callback method will be called, when initialisation finishes - - :param Version: Version of OpenCV - :param AppContext: Application context for service connection - :param CallBack: Object that implements LoaderCallbackInterface. See Helper callback interface - :rtype: boolean - :return: Return true if initialization starts successfully \ No newline at end of file diff --git a/android/service/doc/IOpenCVEngine.rst b/android/service/doc/IOpenCVEngine.rst deleted file mode 100644 index 638095832..000000000 --- a/android/service/doc/IOpenCVEngine.rst +++ /dev/null @@ -1,54 +0,0 @@ -*************************************** -Native OpenCV Manager service interface -*************************************** - -.. highlight:: cpp -.. module:: IOpenCVEngine.h - :platform: Android - :synopsis: Defines OpenCV Manager interface for Android Binder component -.. Class:: OpenCVEngine - -OpenCVEngine class provides Binder interface to OpenCV Manager Service - -int getEngineVersion() ----------------------- - -.. method:: int GetEngineVersion() - - Gets OpenCV Manager version - - :rtype: int - :return: Returns OpenCV Manager version - -android::String16 getLibPathByVersion() ---------------------------------------- - -.. method:: android::String16 GetLibPathByVersion(android::String16 version) - - Gets path to native OpenCV libraries - - :param version: OpenCV Library version - :rtype: String; - :return: Returns path to OpenCV native libs or empty string if OpenCV was not found - -android::String16 getLibraryList() ----------------------------------- - -.. method:: android::String16 GetLibraryList(android::String16 version) - - Gets list of OpenCV native libraries in loading order - - :param version: OpenCV Library version - :rtype: String; - :return: Returns OpenCV libraries names separated by semicolon symbol in loading order - -boolean installVersion() ------------------------- - -.. method:: boolean InstallVersion(android::String16 version) - - Trys to install defined version of OpenCV - - :param version: OpenCV Library version - :rtype: String - :return: Returns true if installation successful or package has been already installed diff --git a/android/service/doc/NativeHelper.rst b/android/service/doc/NativeHelper.rst deleted file mode 100644 index c4ac69eef..000000000 --- a/android/service/doc/NativeHelper.rst +++ /dev/null @@ -1,5 +0,0 @@ -******************** -Native OpenCV Helper -******************** - -.. highlight:: cpp \ No newline at end of file diff --git a/android/service/doc/OpenCVEngineInterface.rst b/android/service/doc/OpenCVEngineInterface.rst deleted file mode 100644 index 05d316bd7..000000000 --- a/android/service/doc/OpenCVEngineInterface.rst +++ /dev/null @@ -1,57 +0,0 @@ -********************************* -Java OpenCV OpenCVEngineInterface -********************************* - -.. highlight:: java -.. module:: org.opencv.engine - :platform: Android - :synopsis: Defines OpenCV Manager interface for Android. -.. Class:: OpenCVEngineInterface - -OpenCVEngineInterface class provides Java interface to OpenCV Manager Service. Is synchronous with native OpenCVEngine class - -.. note:: Do not use this class directly. Use OpenCVLoader instead! - -int getEngineVersion() ----------------------- - -.. method:: int GetEngineVersion() - - Get OpenCV Manager version - - :rtype: int - :return: Return OpenCV Manager version - -String getLibPathByVersion() ----------------------------- - -.. method:: String GetLibPathByVersion(String version) - - Find already installed OpenCV library - - :param version: OpenCV library version - :rtype: String - :return: Return path to OpenCV native libs or empty string if OpenCV was not found - -String getLibraryList() ------------------------ - -.. method:: String GetLibraryList(String version) - - Get list of OpenCV native libraries in loading order separated by ";" symbol - - :param version: OpenCV library version - :rtype: String - :return: Return OpenCV libraries names separated by symbol ";" in loading order - -boolean installVersion() ------------------------- - -.. method:: boolean InstallVersion(String version) - - Try to install defined version of OpenCV from Google Play (Android Market). - - :param version: OpenCV library version - :rtype: String - :return: Return true if installation was successful or OpenCV package has been already installed - \ No newline at end of file diff --git a/android/service/doc/StaticHelper.rst b/android/service/doc/StaticHelper.rst deleted file mode 100644 index 5cf4b283d..000000000 --- a/android/service/doc/StaticHelper.rst +++ /dev/null @@ -1,24 +0,0 @@ -************************************ -Java Static OpenCV Helper (internal) -************************************ - -.. highlight:: java -.. module:: org.opencv.android - :platform: Android - :synopsis: Implements Android dependent Java classes -.. Class:: StaticHelper - -Helper class provides implementation of static OpenCV initialization. All OpenCV libraries must be included to application package. - -.. note:: This is internal class. Does not use it directly. Use OpenCVLoader.initDebug() instead! - -int initOpenCV() ----------------- - -.. method:: int initOpenCV() - - Tries to init OpenCV library using libraries from application package. Method uses libopencv_info.so library for getting - list of libraries in loading order. Method loads libopencv_java.so, if info library is not present. - - :rtype: boolean - :return: Return true if initialization was successful \ No newline at end of file