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

fixed several documentation errors

Browse Source
This commit is contained in:
Andrey Kamaev
2012-06-25 12:56:46 +00:00
parent d85ef03a42
commit 7b806f6008
5 changed files with 82 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
modules/core/doc/dynamic_structures.rst
View File

@@ -588,11 +588,11 @@ GetSetElem
----------
Finds a set element by its index.
.. ocv:cfunction:: CvSetElem* cvGetSetElem( const CvSet* set_header, int index )
.. ocv:cfunction:: CvSetElem* cvGetSetElem( const CvSet* set_header, int idx )
:param set_header: Set
:param index: Index of the set element within a sequence
:param idx: Index of the set element within a sequence
The function finds a set element by its index. The function returns the pointer to it or 0 if the index is invalid or the corresponding node is free. The function supports negative indices as it uses
:ocv:cfunc:`GetSeqElem`

4
modules/core/doc/xml_yaml_persistence.rst
View File

@@ -167,7 +167,7 @@ The constructors.
* **FileStorage::WRITE** Open the file for writing.
* **FileStorage::APPEND** Open the file for appending.
* **FileStorage::MEMORY** Read data from ``source`` or write data to the internal buffer (which is returned by ``FileStorage::release``)
:param encoding: Encoding of the file. Note that UTF-16 XML encoding is not supported currently and you should use 8-bit encoding instead of it.
@@ -199,7 +199,7 @@ FileStorage::release
--------------------
Closes the file and releases all the memory buffers.
.. ocv:function:: string FileStorage::release()
.. ocv:function:: void FileStorage::release()
Call this method after all I/O operations with the storage are finished. If the storage was opened for writing data and ``FileStorage::WRITE`` was specified