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

some more fixes in Algorithm methods declarations

Browse Source
This commit is contained in:
Vadim Pisarevsky 2012-05-24 11:50:54 +00:00
parent 0fe0a88108
commit 513080ea12
1 changed files with 12 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
modules/core/doc/basic_structures.rst
View File

@ -2357,7 +2357,7 @@ Algorithm::get
-------------- --------------
Returns the algorithm parameter Returns the algorithm parameter
.. ocv:function:: template<typename _Tp> typename ParamType<_Tp>::member_type get(const string& name) const .. ocv:function:: template<typename _Tp> typename ParamType<_Tp>::member_type Algorithm::get(const string& name) const
:param name: The parameter name. :param name: The parameter name.
@ -2378,13 +2378,13 @@ Algorithm::set
-------------- --------------
Sets the algorithm parameter Sets the algorithm parameter
.. ocv:function:: void set(const string& name, int value) .. ocv:function:: void Algorithm::set(const string& name, int value)
.. ocv:function:: void set(const string& name, double value) .. ocv:function:: void Algorithm::set(const string& name, double value)
.. ocv:function:: void set(const string& name, bool value) .. ocv:function:: void Algorithm::set(const string& name, bool value)
.. ocv:function:: void set(const string& name, const string& value) .. ocv:function:: void Algorithm::set(const string& name, const string& value)
.. ocv:function:: void set(const string& name, const Mat& value) .. ocv:function:: void Algorithm::set(const string& name, const Mat& value)
.. ocv:function:: void set(const string& name, const vector<Mat>& value) .. ocv:function:: void Algorithm::set(const string& name, const vector<Mat>& value)
.. ocv:function:: void set(const string& name, const Ptr<Algorithm>& value) .. ocv:function:: void Algorithm::set(const string& name, const Ptr<Algorithm>& value)
:param name: The parameter name. :param name: The parameter name.
:param value: The parameter value. :param value: The parameter value.
@ -2396,7 +2396,7 @@ Algorithm::write
---------------- ----------------
Stores algorithm parameters in a file storage Stores algorithm parameters in a file storage
.. ocv:function:: void write(FileStorage& fs) const .. ocv:function:: void Algorithm::write(FileStorage& fs) const
:param fs: File storage. :param fs: File storage.
@ -2413,7 +2413,7 @@ Algorithm::read
--------------- ---------------
Reads algorithm parameters from a file storage Reads algorithm parameters from a file storage
.. ocv:function:: void read(const FileNode& fn) .. ocv:function:: void Algorithm::read(const FileNode& fn)
:param fn: File node of the file storage. :param fn: File node of the file storage.
@ -2423,7 +2423,7 @@ Algorithm::getList
------------------ ------------------
Returns the list of registered algorithms Returns the list of registered algorithms
.. ocv:function:: void getList(vector<string>& algorithms) .. ocv:function:: void Algorithm::getList(vector<string>& algorithms)
:param algorithms: The output vector of algorithm names. :param algorithms: The output vector of algorithm names.
@ -2436,22 +2436,11 @@ This static method returns the list of registered algorithms in alphabetical ord
cout << algorithms[i] << endl; cout << algorithms[i] << endl;
Algorithm::getList
------------------
Returns the list of registered algorithms
.. ocv:function:: void read(vector<string>& algorithms)
:param algorithms: The output vector of algorithm names.
This static method returns the list of registered algorithms in alphabetical order.
Algorithm::create Algorithm::create
----------------- -----------------
Creates algorithm instance by name Creates algorithm instance by name
.. ocv:function:: template<typename _Tp> Ptr<_Tp> create(const string& name) .. ocv:function:: template<typename _Tp> Ptr<_Tp> Algorithm::create(const string& name)
:param name: The algorithm name, one of the names returned by ``Algorithm::getList()``. :param name: The algorithm name, one of the names returned by ``Algorithm::getList()``.