generic-library/opencv
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fixed some language issues in OpenCV4Android Reference.

Browse Source
This commit is contained in:
Vsevolod Glumov 2012-09-14 11:10:53 +04:00
parent 538847e8a3
commit 1052a0b4eb
6 changed files with 39 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
android/service/doc/BaseLoaderCallback.rst
View File

@ -5,7 +5,7 @@ Base Loader Callback Interface implementation
.. highlight:: java .. highlight:: java
.. class:: BaseLoaderCallback .. class:: BaseLoaderCallback
Basic implementation of LoaderCallbackInterface. Implementation logic is described by diagram. Basic implementation of LoaderCallbackInterface. Logic of this implementation is well-described by the following scheme:
.. image:: img/AndroidAppUsageModel.png .. image:: img/AndroidAppUsageModel.png

10
android/service/doc/InstallCallbackInterface.rst
View File

@ -11,21 +11,21 @@ String getPackageName()
.. method:: String getPackageName() .. method:: String getPackageName()
Get name of a package to be installed Get name of a package to be installed.
:rtype: String :rtype: string;
:return: Return package name, i.e. "OpenCV Manager Service" or "OpenCV library" :return: returns package name, i.e. "OpenCV Manager Service" or "OpenCV library".
void install() void install()
-------------- --------------
.. method:: void install() .. method:: void install()
Installation of package is approved Installation of package has been approved.
void cancel() void cancel()
------------- -------------
.. method:: void cancel() .. method:: void cancel()
Installation if package was canceled Installation if package has been canceled.

20
android/service/doc/Intro.rst
View File

@ -9,7 +9,7 @@ Introduction
OpenCV Manager is an Android service targeted to manage OpenCV library binaries on end users devices. It allows sharing the OpenCV dynamic libraries of different versions between applications on the same device. The Manager provides the following benefits\: OpenCV Manager is an Android service targeted to manage OpenCV library binaries on end users devices. It allows sharing the OpenCV dynamic libraries of different versions between applications on the same device. The Manager provides the following benefits\:
#. Less memory usage. All apps use the same binaries from service and do not keep native libs inside them self; #. Less memory usage. All apps use the same binaries from service and do not keep native libs inside themselves;
#. Hardware specific optimizations for all supported platforms; #. Hardware specific optimizations for all supported platforms;
#. Trusted OpenCV library source. All packages with OpenCV are published on Google Play service; #. Trusted OpenCV library source. All packages with OpenCV are published on Google Play service;
#. Regular updates and bug fixes; #. Regular updates and bug fixes;
@ -21,18 +21,18 @@ Usage model for target user
First OpenCV app\: First OpenCV app\:
#. User downloads app dependent from OpenCV from Google Play or installs it manually; #. OpenCV app is downloaded as an dependency on Google Play marketplace or manually;
#. User starts application. Application asks user to install OpenCV Manager; #. When the app starts, it suggests installing OpenCV Manager;
#. User installs OpenCV Manager from Google Play Service; #. Then OpenCV Manager is downloaded and installed, using Google Play marketplace service.
#. User starts application. Application proposes to user to install OpenCV library for target device and runs Google Play; #. When started, the application suggests installing OpenCV library for the target device trough Google Play marketplace;
#. User runs app in the third time and gets what he or she wants. #. After installation is finished, the app may be launched to perform common tasks.
Next OpenCV app\: Next OpenCV app\:
#. User downloads app dependent from OpenCV from Google Play or installs it manually; #. OpenCV app is downloaded as an dependency on Google Play marketplace or manually;
#. User starts application. #. After the installation is finished, the app may be launched.
#. If selected version is not installed Manager asks user to install OpenCV library package and runs Google Play; #. If the selected version is not installed, OpenCV Manager suggests installing OpenCV library for the target device trough Google Play marketplace;
#. User runs app in the second time and gets what he or she wants. #. After installation is finished, the app may be launched to perform common tasks.
OpenCV Manager structure OpenCV Manager structure
------------------------ ------------------------

23
android/service/doc/JavaHelper.rst
View File

@ -5,32 +5,33 @@ Java OpenCV Loader
.. highlight:: java .. highlight:: java
.. Class:: OpenCVLoader .. Class:: OpenCVLoader
Helper class provides common initialization methods for OpenCV library Helper class provides common initialization methods for OpenCV library.
boolean initDebug() boolean initDebug()
------------------- -------------------
.. method:: static boolean initDebug() .. method:: static boolean initDebug()
Load and initialize OpenCV library from current application package. Roughly it is analog of system.loadLibrary("opencv_java") Loads and initializes OpenCV library from within current application package. Roughly it is analog of ``system.loadLibrary("opencv_java")``.
:rtype: boolean :rtype: boolean;
:return: Return true if initialization of OpenCV was successful :return: returns true if initialization of OpenCV was successful.
.. note:: This way is deprecated for production code. It is designed for experimantal and local development purposes only. If you want to publish your app use approach with async initialization .. note:: This method is deprecated for production code. It is designed for experimantal and local development purposes only. If you want to publish your app use approach with async initialization.
boolean initAsync() boolean initAsync()
------------------- -------------------
.. method:: static boolean initAsync(String Version, Context AppContext, LoaderCallbackInterface Callback) .. method:: static boolean initAsync(String Version, Context AppContext, LoaderCallbackInterface Callback)
Load and initialize OpenCV library using OpenCV Manager service. Loads and initializes OpenCV library using OpenCV Manager service.
:param Version: OpenCV Library version :param Version: OpenCV Library version.
:param AppContext: Application context for connecting to service :param AppContext: application context for connecting to the service.
:param Callback: Object, that implements LoaderCallbackInterface for handling Connection status. See BaseLoaderCallback. :param Callback: object, that implements LoaderCallbackInterface for handling connection status (see BaseLoaderCallback).
:rtype: boolean
:return: Return true if initialization of OpenCV starts successfully :rtype: boolean;
:return: returns true if initialization of OpenCV starts successfully.
OpenCV version constants OpenCV version constants
------------------------- -------------------------

12
android/service/doc/LoaderCallbackInterface.rst
View File

@ -5,32 +5,32 @@ Loader Callback Interface
.. highlight:: java .. highlight:: java
.. class:: LoaderCallbackInterface .. class:: LoaderCallbackInterface
Interface for callback object in case of asynchronous initialization of OpenCV Interface for a callback object in case of asynchronous initialization of OpenCV.
void onManagerConnected() void onManagerConnected()
------------------------- -------------------------
.. method:: void onManagerConnected(int status) .. method:: void onManagerConnected(int status)
Callback method that is called after OpenCV library initialization Callback method that is called after OpenCV Library initialization.
:param status: Status of initialization. See Initialization status constants :param status: status of initialization (see Initialization Status Constants).
void onPackageInstall() void onPackageInstall()
----------------------- -----------------------
.. method:: void onPackageInstall(InstallCallbackInterface Callback) .. method:: void onPackageInstall(InstallCallbackInterface Callback)
Callback method that is called in case when package installation is needed Callback method that is called in case when package installation is needed.
:param callback: Answer object with approve and cancel methods and package description :param callback: answer object with approve and cancel methods and package description.
Initialization status constants Initialization status constants
------------------------------- -------------------------------
.. data:: SUCCESS .. data:: SUCCESS
OpenCV initialization finished successfully OpenCV initialization finished successfully.
.. data:: RESTART_REQUIRED .. data:: RESTART_REQUIRED

10
android/service/doc/UseCases.rst
View File

@ -5,25 +5,25 @@ Engine use Cases
First application start First application start
----------------------- -----------------------
There is no OpenCV Manager and OpenCV libraries. There is no OpenCV Manager or OpenCV libraries:
.. image:: img/NoService.png .. image:: img/NoService.png
Second application start Second application start
------------------------ ------------------------
There is OpenCV Manager service, but there is no OpenCV library. There is an OpenCV Manager service, but there is no OpenCV library.
If OpenCV library installation approved\: If OpenCV library installation has been approved\:
.. image:: img/LibInstallAproved.png .. image:: img/LibInstallAproved.png
If OpenCV library installation canceled\: If OpenCV library installation has been canceled\:
.. image:: img/LibInstallCanceled.png .. image:: img/LibInstallCanceled.png
Regular application start Regular application start
------------------------- -------------------------
OpenCV Manager and OpenCV library has bee already installed. OpenCV Manager and OpenCV library has been already installed.
.. image:: img/LibInstalled.png .. image:: img/LibInstalled.png