doc/check_docs2.py warnings fixes

pull/3297/head
Alexander Smorkalov 10 years ago
parent 7018f94959
commit 11c81067dc
  1. 4
      modules/core/doc/drawing_functions.rst
  2. 16
      modules/highgui/doc/reading_and_writing_images_and_video.rst
  3. 2
      modules/imgproc/doc/filtering.rst
  4. 4
      modules/nonfree/doc/feature_detection.rst

@ -375,7 +375,7 @@ arrowedLine
----------------
Draws a arrow segment pointing from the first point to the second one.
.. ocv:function:: void arrowedLine(Mat& img, Point pt1, Point pt2, const Scalar& color, int thickness=1, int lineType=8, int shift=0, double tipLength=0.1)
.. ocv:function:: void arrowedLine(Mat& img, Point pt1, Point pt2, const Scalar& color, int thickness=1, int line_type=8, int shift=0, double tipLength=0.1)
:param img: Image.
@ -387,7 +387,7 @@ Draws a arrow segment pointing from the first point to the second one.
:param thickness: Line thickness.
:param lineType: Type of the line:
:param line_type: Type of the line:
* **8** (or omitted) - 8-connected line.

@ -115,7 +115,7 @@ The function ``imread`` loads an image from the specified file and returns it. I
.. note:: In the case of color images, the decoded images will have the channels stored in ``B G R`` order.
imwrite
-----------
-------
Saves an image to a specified file.
.. ocv:function:: bool imwrite( const string& filename, InputArray img, const vector<int>& params=vector<int>() )
@ -235,7 +235,7 @@ The class provides C++ API for capturing video from cameras or for reading video
VideoCapture::VideoCapture
------------------------------
--------------------------
VideoCapture constructors.
.. ocv:function:: VideoCapture::VideoCapture()
@ -261,7 +261,7 @@ VideoCapture constructors.
VideoCapture::open
---------------------
------------------
Open video file or a capturing device for video capturing
.. ocv:function:: bool VideoCapture::open(const string& filename)
@ -303,7 +303,7 @@ The C function also deallocates memory and clears ``*capture`` pointer.
VideoCapture::grab
---------------------
------------------
Grabs the next frame from video file or capturing device.
.. ocv:function:: bool VideoCapture::grab()
@ -331,7 +331,7 @@ Decodes and returns the grabbed video frame.
.. ocv:cfunction:: IplImage* cvRetrieveFrame( CvCapture* capture, int streamIdx=0 )
.. ocv:pyoldfunction:: cv.RetrieveFrame(capture) -> image
.. ocv:pyoldfunction:: cv.RetrieveFrame(capture [, index]) -> image
The methods/functions decode and return the just grabbed frame. If no frames has been grabbed (camera has been disconnected, or there are no more frames in video file), the methods return false and the functions return NULL pointer.
@ -339,7 +339,7 @@ The methods/functions decode and return the just grabbed frame. If no frames has
VideoCapture::read
----------------------
------------------
Grabs, decodes and returns the next video frame.
.. ocv:function:: VideoCapture& VideoCapture::operator >> (Mat& image)
@ -358,7 +358,7 @@ The methods/functions combine :ocv:func:`VideoCapture::grab` and :ocv:func:`Vide
VideoCapture::get
---------------------
-----------------
Returns the specified ``VideoCapture`` property
.. ocv:function:: double VideoCapture::get(int propId)
@ -414,7 +414,7 @@ Returns the specified ``VideoCapture`` property
**Note**: When querying a property that is not supported by the backend used by the ``VideoCapture`` class, value 0 is returned.
VideoCapture::set
---------------------
-----------------
Sets a property in the ``VideoCapture``.
.. ocv:function:: bool VideoCapture::set( int propId, double value )

@ -418,7 +418,7 @@ Applies the adaptive bilateral filter to an image.
.. ocv:function:: void adaptiveBilateralFilter( InputArray src, OutputArray dst, Size ksize, double sigmaSpace, double maxSigmaColor = 20.0, Point anchor=Point(-1, -1), int borderType=BORDER_DEFAULT )
.. ocv:pyfunction:: cv2.adaptiveBilateralFilter(src, ksize, sigmaSpace[, dst[, anchor[, borderType]]]) -> dst
.. ocv:pyfunction:: cv2.adaptiveBilateralFilter(src, ksize, sigmaSpace[, dst[, maxSigmaColor[, anchor[, borderType]]]]) -> dst
:param src: The source image

@ -110,9 +110,9 @@ Detects keypoints and computes SURF descriptors for them.
.. ocv:pyfunction:: cv2.SURF.detect(image[, mask]) -> keypoints
.. ocv:pyfunction:: cv2.SURF.detectAndCompute(image[, mask]) -> keypoints, descriptors
.. ocv:pyfunction:: cv2.SURF.detectAndCompute(image, mask[, descriptors[, useProvidedKeypoints]]) -> keypoints, descriptors
.. ocv:cfunction:: void cvExtractSURF( const CvArr* image, const CvArr* mask, CvSeq** keypoints, CvSeq** descriptors, CvMemStorage* storage, CvSURFParams params )
.. ocv:cfunction:: void cvExtractSURF(const CvArr* image, const CvArr* mask, CvSeq** keypoints, CvSeq** descriptors, CvMemStorage* storage, CvSURFParams params)
.. ocv:pyoldfunction:: cv.ExtractSURF(image, mask, storage, params)-> (keypoints, descriptors)

Loading…
Cancel
Save