* Fixed cross-referencing in reference manual (except C++ operator() ).

* Fixed display of struct and class definitions (except classes with base class specified).
* Fixed formatting and referencing errors in several documentation files.
This commit is contained in:
Andrey Kamaev
2011-08-12 22:18:04 +00:00
parent 6b88d7a898
commit 431daf59b6
4 changed files with 102 additions and 89 deletions

View File

@@ -1,5 +1,5 @@
Dynamic Structures
==================
==================
.. highlight:: c
@@ -452,17 +452,17 @@ Finds an edge in a graph.
.. ocv:cfunction:: CvGraphEdge* cvFindGraphEdge( const CvGraph* graph, int start_idx, int end_idx )
::
#define cvGraphFindEdge cvFindGraphEdge
..
:param graph: Graph
:param start_idx: Index of the starting vertex of the edge
:param end_idx: Index of the ending vertex of the edge. For an unoriented graph, the order of the vertex parameters does not matter.
::
#define cvGraphFindEdge cvFindGraphEdge
..
The function finds the graph edge connecting two specified vertices and returns a pointer to it or NULL if the edge does not exist.
@@ -472,17 +472,17 @@ Finds an edge in a graph by using its pointer.
.. ocv:cfunction:: CvGraphEdge* cvFindGraphEdgeByPtr( const CvGraph* graph, const CvGraphVtx* startVtx, const CvGraphVtx* endVtx )
::
#define cvGraphFindEdgeByPtr cvFindGraphEdgeByPtr
..
:param graph: Graph
:param startVtx: Pointer to the starting vertex of the edge
:param endVtx: Pointer to the ending vertex of the edge. For an unoriented graph, the order of the vertex parameters does not matter.
::
#define cvGraphFindEdgeByPtr cvFindGraphEdgeByPtr
..
The function finds the graph edge connecting two specified vertices and returns pointer to it or NULL if the edge does not exists.
@@ -521,15 +521,16 @@ Returns a pointer to a sequence element according to its index.
.. ocv:cfunction:: char* cvGetSeqElem( const CvSeq* seq, int index )
:param seq: Sequence
:param index: Index of element
::
#define CV_GET_SEQ_ELEM( TYPE, seq, index ) (TYPE*)cvGetSeqElem( (CvSeq*)(seq), (index) )
..
:param seq: Sequence
:param index: Index of element
The function finds the element with the given
index in the sequence and returns the pointer to it. If the element
@@ -841,6 +842,12 @@ Allocates a text string in a storage block.
.. ocv:cfunction:: CvString cvMemStorageAllocString(CvMemStorage* storage, const char* ptr, int len=-1)
:param storage: Memory storage
:param ptr: The string
:param len: Length of the string (not counting the ending ``NUL`` ) . If the parameter is negative, the function computes the length.
::
typedef struct CvString
@@ -852,12 +859,6 @@ Allocates a text string in a storage block.
..
:param storage: Memory storage
:param ptr: The string
:param len: Length of the string (not counting the ending ``NUL`` ) . If the parameter is negative, the function computes the length.
The function creates copy of the string
in memory storage. It returns the structure that contains user-passed
or computed length of the string and pointer to the copied string.
@@ -1256,6 +1257,12 @@ Sorts sequence element using the specified comparison function.
.. ocv:cfunction:: void cvSeqSort( CvSeq* seq, CvCmpFunc func, void* userdata=NULL )
:param seq: The sequence to sort
:param func: The comparison function that returns a negative, zero, or positive value depending on the relationships among the elements (see the above declaration and the example below) - a similar function is used by ``qsort`` from C runline except that in the latter, ``userdata`` is not used
:param userdata: The user parameter passed to the compasion function; helps to avoid global variables in some cases
::
/* a < b ? -1 : a > b ? 1 : 0 */
@@ -1263,12 +1270,6 @@ Sorts sequence element using the specified comparison function.
..
:param seq: The sequence to sort
:param func: The comparison function that returns a negative, zero, or positive value depending on the relationships among the elements (see the above declaration and the example below) - a similar function is used by ``qsort`` from C runline except that in the latter, ``userdata`` is not used
:param userdata: The user parameter passed to the compasion function; helps to avoid global variables in some cases
The function sorts the sequence in-place using the specified criteria. Below is an example of using this function:
::