Fix discrepancies between function signatures in headers and documentation

diff --git a/doc/check_docs2.py b/doc/check_docs2.py
index 29e20f7..0a29b50 100755 (executable)
--- a/doc/check_docs2.py
+++ b/doc/check_docs2.py
@@ -116,8 +116,8 @@ def compareSignatures(f, s):
         sarg = arg[1]
         ftype = re.sub(r"\b(cv|std)::", "", (farg[0] or ""))
         stype = re.sub(r"\b(cv|std)::", "", (sarg[0] or ""))
-        ftype = re.sub(r" (&|\*)$", "\\1", ftype)
-        stype = re.sub(r" (&|\*)$", "\\1", stype)
+        ftype = re.sub(r"\s+(\*|&)$", "\\1", ftype)
+        stype = re.sub(r"\s+(\*|&)$", "\\1", stype)
         if ftype != stype:
             return False, "type of argument #" + str(idx+1) + " mismatch"
         fname = farg[1] or "arg" + str(idx)
@@ -153,7 +153,7 @@ def formatSignature(s):
             if idx > 0:
                 _str += ", "
             argtype = re.sub(r"\bcv::", "", arg[0])
-            argtype = re.sub(r" (&|\*)$", "\\1", argtype)
+            argtype = re.sub(r"\s+(\*|&)$", "\\1", arg[0])
             bidx = argtype.find('[')
             if bidx < 0:
                 _str += argtype + " "

diff --git a/modules/contrib/doc/retina/index.rst b/modules/contrib/doc/retina/index.rst
index 913f7d1..d80e457 100644 (file)
--- a/modules/contrib/doc/retina/index.rst
+++ b/modules/contrib/doc/retina/index.rst
@@ -208,7 +208,7 @@ Retina::getMagno
 Retina::getParameters
 +++++++++++++++++++++
 
-.. ocv:function:: Retina::RetinaParameters Retina::getParameters()
+.. ocv:function:: struct Retina::RetinaParameters Retina::getParameters()
 
     Retrieve the current parameters values in a *Retina::RetinaParameters* structure
 

diff --git a/modules/contrib/include/opencv2/contrib/retina.hpp b/modules/contrib/include/opencv2/contrib/retina.hpp
index 3ee291a..ab8bc36 100644 (file)
--- a/modules/contrib/include/opencv2/contrib/retina.hpp
+++ b/modules/contrib/include/opencv2/contrib/retina.hpp
@@ -203,10 +203,10 @@ public:
      */
     void setup(RetinaParameters newParameters);
 
-        /**
-         * @return the current parameters setup
-         */
-        struct Retina::RetinaParameters getParameters();
+    /**
+     * @return the current parameters setup
+     */
+    struct Retina::RetinaParameters getParameters();
 
     /**
      * parameters setup display method

diff --git a/modules/ocl/doc/feature_detection_and_description.rst b/modules/ocl/doc/feature_detection_and_description.rst
index aa2ed85..a6416d4 100644 (file)
--- a/modules/ocl/doc/feature_detection_and_description.rst
+++ b/modules/ocl/doc/feature_detection_and_description.rst
@@ -36,8 +36,8 @@ Finds edges in an image using the [Canny86]_ algorithm.
 .. seealso:: :ocv:func:`Canny`
 
 
-ocl::BruteForceMatcher_OCL
---------------------------
+ocl::BruteForceMatcher_OCL_base
+-------------------------------
 .. ocv:class:: ocl::BruteForceMatcher_OCL_base
 
 Brute-force descriptor matcher. For each descriptor in the first set, this matcher finds the closest descriptor in the second set by trying each one. This descriptor matcher supports masking permissible matches between descriptor sets. ::
@@ -162,7 +162,7 @@ Finds the best match for each descriptor from a query set with train descriptors
 
 .. ocv:function:: void ocl::BruteForceMatcher_OCL_base::match(const oclMat& query, std::vector<DMatch>& matches, const std::vector<oclMat>& masks = std::vector<oclMat>())
 
-.. ocv:function:: void ocl::BruteForceMatcher_OCL_base::matchCollection(const oclMat& query, const oclMat& trainCollection, oclMat& trainIdx, oclMat& imgIdx, oclMat& distance, const oclMat& masks)
+.. ocv:function:: void ocl::BruteForceMatcher_OCL_base::matchCollection( const oclMat& query, const oclMat& trainCollection, oclMat& trainIdx, oclMat& imgIdx, oclMat& distance, const oclMat& masks=oclMat() )
 
 .. seealso:: :ocv:func:`DescriptorMatcher::match`
 
@@ -175,15 +175,13 @@ Performs a GPU collection of train descriptors and masks in a suitable format fo
 .. ocv:function:: void ocl::BruteForceMatcher_OCL_base::makeGpuCollection(oclMat& trainCollection, oclMat& maskCollection, const vector<oclMat>& masks = std::vector<oclMat>())
 
 
-
 ocl::BruteForceMatcher_OCL_base::matchDownload
 ----------------------------------------------
 Downloads matrices obtained via :ocv:func:`ocl::BruteForceMatcher_OCL_base::matchSingle` or :ocv:func:`ocl::BruteForceMatcher_OCL_base::matchCollection` to vector with :ocv:class:`DMatch`.
 
-.. ocv:function:: void ocl::BruteForceMatcher_OCL_base::matchDownload(const oclMat& trainIdx, const oclMat& distance, std::vector<DMatch>&matches)
-
-.. ocv:function:: void ocl::BruteForceMatcher_OCL_base::matchDownload(const oclMat& trainIdx, oclMat& imgIdx, const oclMat& distance, std::vector<DMatch>&matches)
+.. ocv:function:: static void ocl::BruteForceMatcher_OCL_base::matchDownload( const oclMat& trainIdx, const oclMat& distance, std::vector<DMatch>& matches )
 
+.. ocv:function:: static void ocl::BruteForceMatcher_OCL_base::matchDownload( const oclMat& trainIdx, const oclMat& imgIdx, const oclMat& distance, std::vector<DMatch>& matches )
 
 
 ocl::BruteForceMatcher_OCL_base::matchConvert
@@ -310,7 +308,7 @@ If ``compactResult`` is ``true`` , the ``matches`` vector does not contain match
 ocl::HOGDescriptor
 ------------------
 
-.. ocv:class:: ocl::HOGDescriptor
+.. ocv:struct:: ocl::HOGDescriptor
 
 The class implements Histogram of Oriented Gradients ([Dalal2005]_) object detector. ::
 

diff --git a/modules/ocl/doc/image_filtering.rst b/modules/ocl/doc/image_filtering.rst
index 20e90c3..ca97d3a 100644 (file)
--- a/modules/ocl/doc/image_filtering.rst
+++ b/modules/ocl/doc/image_filtering.rst
@@ -7,7 +7,7 @@ ocl::Sobel
 ------------------
 Returns void
 
-.. ocv:function:: void Sobel(const oclMat &src, oclMat &dst, int ddepth, int dx, int dy, int ksize = 3, double scale = 1, double delta = 0.0, int bordertype = BORDER_DEFAULT)
+.. ocv:function:: void ocl::Sobel(const oclMat &src, oclMat &dst, int ddepth, int dx, int dy, int ksize = 3, double scale = 1, double delta = 0.0, int bordertype = BORDER_DEFAULT)
 
     :param src: The source image
 
@@ -33,7 +33,7 @@ ocl::Scharr
 ------------------
 Returns void
 
-.. ocv:function:: void Scharr(const oclMat &src, oclMat &dst, int ddepth, int dx, int dy, double scale = 1, double delta = 0.0, int bordertype = BORDER_DEFAULT)
+.. ocv:function:: void ocl::Scharr(const oclMat &src, oclMat &dst, int ddepth, int dx, int dy, double scale = 1, double delta = 0.0, int bordertype = BORDER_DEFAULT)
 
     :param src: The source image
 
@@ -57,7 +57,7 @@ ocl::GaussianBlur
 ------------------
 Returns void
 
-.. ocv:function:: void GaussianBlur(const oclMat &src, oclMat &dst, Size ksize, double sigma1, double sigma2 = 0, int bordertype = BORDER_DEFAULT)
+.. ocv:function:: void ocl::GaussianBlur(const oclMat &src, oclMat &dst, Size ksize, double sigma1, double sigma2 = 0, int bordertype = BORDER_DEFAULT)
 
     :param src: The source image
 
@@ -75,7 +75,7 @@ ocl::boxFilter
 ------------------
 Returns void
 
-.. ocv:function:: void boxFilter(const oclMat &src, oclMat &dst, int ddepth, Size ksize, Point anchor = Point(-1, -1), int borderType = BORDER_DEFAULT)
+.. ocv:function:: void ocl::boxFilter(const oclMat &src, oclMat &dst, int ddepth, Size ksize, Point anchor = Point(-1, -1), int borderType = BORDER_DEFAULT)
 
     :param src: The source image
 
@@ -95,7 +95,7 @@ ocl::Laplacian
 ------------------
 Returns void
 
-.. ocv:function:: void Laplacian(const oclMat &src, oclMat &dst, int ddepth, int ksize = 1, double scale = 1)
+.. ocv:function:: void ocl::Laplacian(const oclMat &src, oclMat &dst, int ddepth, int ksize = 1, double scale = 1)
 
     :param src: The source image
 
@@ -113,7 +113,7 @@ ocl::convolve
 ------------------
 Returns void
 
-.. ocv:function:: void convolve(const oclMat &image, const oclMat &temp1, oclMat &result)
+.. ocv:function:: void ocl::convolve(const oclMat &image, const oclMat &temp1, oclMat &result)
 
     :param image: The source image
 
@@ -127,7 +127,7 @@ ocl::bilateralFilter
 --------------------
 Returns void
 
-.. ocv:function:: void bilateralFilter(const oclMat &src, oclMat &dst, int d, double sigmaColor, double sigmaSpave, int borderType=BORDER_DEFAULT)
+.. ocv:function:: void ocl::bilateralFilter(const oclMat &src, oclMat &dst, int d, double sigmaColor, double sigmaSpave, int borderType=BORDER_DEFAULT)
 
     :param src: The source image
 
@@ -147,7 +147,7 @@ ocl::copyMakeBorder
 --------------------
 Returns void
 
-.. ocv:function:: void copyMakeBorder(const oclMat &src, oclMat &dst, int top, int bottom, int left, int right, int boardtype, const Scalar &value = Scalar())
+.. ocv:function:: void ocl::copyMakeBorder(const oclMat &src, oclMat &dst, int top, int bottom, int left, int right, int boardtype, const Scalar &value = Scalar())
 
     :param src: The source image
 
@@ -165,7 +165,7 @@ ocl::dilate
 ------------------
 Returns void
 
-.. ocv:function:: void dilate( const oclMat &src, oclMat &dst, const Mat &kernel, Point anchor = Point(-1, -1), int iterations = 1, int borderType = BORDER_CONSTANT, const Scalar &borderValue = morphologyDefaultBorderValue())
+.. ocv:function:: void ocl::dilate( const oclMat &src, oclMat &dst, const Mat &kernel, Point anchor = Point(-1, -1), int iterations = 1, int borderType = BORDER_CONSTANT, const Scalar &borderValue = morphologyDefaultBorderValue())
 
     :param src: The source image
 
@@ -187,7 +187,7 @@ ocl::erode
 ------------------
 Returns void
 
-.. ocv:function:: void erode( const oclMat &src, oclMat &dst, const Mat &kernel, Point anchor = Point(-1, -1), int iterations = 1, int borderType = BORDER_CONSTANT, const Scalar &borderValue = morphologyDefaultBorderValue())
+.. ocv:function:: void ocl::erode( const oclMat &src, oclMat &dst, const Mat &kernel, Point anchor = Point(-1, -1), int iterations = 1, int borderType = BORDER_CONSTANT, const Scalar &borderValue = morphologyDefaultBorderValue())
 
     :param src: The source image
 
@@ -209,7 +209,7 @@ ocl::morphologyEx
 ------------------
 Returns void
 
-.. ocv:function:: void morphologyEx( const oclMat &src, oclMat &dst, int op, const Mat &kernel, Point anchor = Point(-1, -1), int iterations = 1, int borderType = BORDER_CONSTANT, const Scalar &borderValue = morphologyDefaultBorderValue())
+.. ocv:function:: void ocl::morphologyEx( const oclMat &src, oclMat &dst, int op, const Mat &kernel, Point anchor = Point(-1, -1), int iterations = 1, int borderType = BORDER_CONSTANT, const Scalar &borderValue = morphologyDefaultBorderValue())
 
     :param src: The source image
 

diff --git a/modules/ocl/doc/image_processing.rst b/modules/ocl/doc/image_processing.rst
index 461fb98..94712e0 100644 (file)
--- a/modules/ocl/doc/image_processing.rst
+++ b/modules/ocl/doc/image_processing.rst
@@ -7,7 +7,7 @@ ocl::cornerHarris
 ------------------
 Returns void
 
-.. ocv:function:: void cornerHarris(const oclMat &src, oclMat &dst, int blockSize, int ksize, double k, int bordertype = cv::BORDER_DEFAULT)
+.. ocv:function:: void ocl::cornerHarris(const oclMat &src, oclMat &dst, int blockSize, int ksize, double k, int bordertype = cv::BORDER_DEFAULT)
 
     :param src: Source image. Only CV_8UC1 and CV_32FC1 images are supported now.
 
@@ -27,7 +27,7 @@ ocl::cornerMinEigenVal
 ------------------------
 Returns void
 
-.. ocv:function:: void cornerMinEigenVal(const oclMat &src, oclMat &dst, int blockSize, int ksize, int bordertype = cv::BORDER_DEFAULT)
+.. ocv:function:: void ocl::cornerMinEigenVal(const oclMat &src, oclMat &dst, int blockSize, int ksize, int bordertype = cv::BORDER_DEFAULT)
 
     :param src: Source image. Only CV_8UC1 and CV_32FC1 images are supported now.
 
@@ -45,7 +45,7 @@ ocl::calcHist
 ------------------
 Returns void
 
-.. ocv:function:: void calcHist(const oclMat &mat_src, oclMat &mat_hist)
+.. ocv:function:: void ocl::calcHist(const oclMat &mat_src, oclMat &mat_hist)
 
     :param src: Source arrays. They all should have the same depth, CV 8U, and the same size. Each of them can have an arbitrary number of channels.
 
@@ -57,7 +57,7 @@ ocl::remap
 ------------------
 Returns void
 
-.. ocv:function:: void remap(const oclMat &src, oclMat &dst, oclMat &map1, oclMat &map2, int interpolation, int bordertype, const Scalar &value = Scalar())
+.. ocv:function:: void ocl::remap(const oclMat &src, oclMat &dst, oclMat &map1, oclMat &map2, int interpolation, int bordertype, const Scalar &value = Scalar())
 
     :param src: Source image. Only CV_8UC1 and CV_32FC1 images are supported now.
 
@@ -79,7 +79,7 @@ ocl::resize
 ------------------
 Returns void
 
-.. ocv:function:: void resize(const oclMat &src, oclMat &dst, Size dsize, double fx = 0, double fy = 0, int interpolation = INTER_LINEAR)
+.. ocv:function:: void ocl::resize(const oclMat &src, oclMat &dst, Size dsize, double fx = 0, double fy = 0, int interpolation = INTER_LINEAR)
 
     :param src: Source image.
 
@@ -99,7 +99,7 @@ ocl::warpAffine
 ------------------
 Returns void
 
-.. ocv:function:: void warpAffine(const oclMat &src, oclMat &dst, const Mat &M, Size dsize, int flags = INTER_LINEAR)
+.. ocv:function:: void ocl::warpAffine(const oclMat &src, oclMat &dst, const Mat &M, Size dsize, int flags = INTER_LINEAR)
 
     :param src: Source image.
 
@@ -117,7 +117,7 @@ ocl::warpPerspective
 ---------------------
 Returns void
 
-.. ocv:function:: void warpPerspective(const oclMat &src, oclMat &dst, const Mat &M, Size dsize, int flags = INTER_LINEAR)
+.. ocv:function:: void ocl::warpPerspective(const oclMat &src, oclMat &dst, const Mat &M, Size dsize, int flags = INTER_LINEAR)
 
     :param src: Source image.
 
@@ -135,7 +135,7 @@ ocl::cvtColor
 ------------------
 Returns void
 
-.. ocv:function:: void cvtColor(const oclMat &src, oclMat &dst, int code , int dcn = 0)
+.. ocv:function:: void ocl::cvtColor(const oclMat &src, oclMat &dst, int code , int dcn = 0)
 
     :param src: Source image.
 
@@ -151,7 +151,7 @@ ocl::threshold
 ------------------
 Returns Threshold value
 
-.. ocv:function:: double threshold(const oclMat &src, oclMat &dst, double thresh, double maxVal, int type = THRESH_TRUNC)
+.. ocv:function:: double ocl::threshold(const oclMat &src, oclMat &dst, double thresh, double maxVal, int type = THRESH_TRUNC)
 
     :param src: The source array
 
@@ -169,7 +169,7 @@ ocl::buildWarpPlaneMaps
 -----------------------
 Builds plane warping maps.
 
-.. ocv:function:: void ocl::buildWarpPlaneMaps(Size src_size, Rect dst_roi, const Mat& R, double f, double s, double dist, oclMat& map_x, oclMat& map_y)
+.. ocv:function:: void ocl::buildWarpPlaneMaps( Size src_size, Rect dst_roi, const Mat& K, const Mat& R, const Mat& T, float scale, oclMat& map_x, oclMat& map_y )
 
 
 
@@ -177,7 +177,7 @@ ocl::buildWarpCylindricalMaps
 -----------------------------
 Builds cylindrical warping maps.
 
-.. ocv:function:: void ocl::buildWarpCylindricalMaps(Size src_size, Rect dst_roi, const Mat& R, double f, double s, oclMat& map_x, oclMat& map_y)
+.. ocv:function:: void ocl::buildWarpCylindricalMaps( Size src_size, Rect dst_roi, const Mat& K, const Mat& R, float scale, oclMat& map_x, oclMat& map_y )
 
 
 
@@ -186,14 +186,14 @@ ocl::buildWarpSphericalMaps
 ---------------------------
 Builds spherical warping maps.
 
-.. ocv:function:: void ocl::buildWarpSphericalMaps(Size src_size, Rect dst_roi, const Mat& R, double f, double s, oclMat& map_x, oclMat& map_y)
+.. ocv:function:: void ocl::buildWarpSphericalMaps( Size src_size, Rect dst_roi, const Mat& K, const Mat& R, float scale, oclMat& map_x, oclMat& map_y )
 
 
 ocl::buildWarpPerspectiveMaps
 -----------------------------
 Builds transformation maps for perspective transformation.
 
-.. ocv:function:: void buildWarpAffineMaps(const Mat& M, bool inverse, Size dsize, oclMat& xmap, oclMat& ymap)
+.. ocv:function:: void ocl::buildWarpAffineMaps(const Mat& M, bool inverse, Size dsize, oclMat& xmap, oclMat& ymap)
 
     :param M: *3x3*  transformation matrix.
 
@@ -212,7 +212,7 @@ ocl::buildWarpAffineMaps
 ------------------------
 Builds transformation maps for affine transformation.
 
-.. ocv:function:: void buildWarpAffineMaps(const Mat& M, bool inverse, Size dsize, oclMat& xmap, oclMat& ymap)
+.. ocv:function:: void ocl::buildWarpAffineMaps(const Mat& M, bool inverse, Size dsize, oclMat& xmap, oclMat& ymap)
 
     :param M: *2x3*  transformation matrix.
 

diff --git a/modules/ocl/doc/matrix_reductions.rst b/modules/ocl/doc/matrix_reductions.rst
index 6eb889a..69b27eb 100644 (file)
--- a/modules/ocl/doc/matrix_reductions.rst
+++ b/modules/ocl/doc/matrix_reductions.rst
@@ -7,7 +7,7 @@ ocl::countNonZero
 ------------------
 Returns the number of non-zero elements in src
 
-.. ocv:function:: int countNonZero(const oclMat &src)
+.. ocv:function:: int ocl::countNonZero(const oclMat &src)
 
     :param src: Single-channel array
 
@@ -17,7 +17,7 @@ ocl::minMax
 ------------------
 Returns void
 
-.. ocv:function:: void minMax(const oclMat &src, double *minVal, double *maxVal = 0, const oclMat &mask = oclMat())
+.. ocv:function:: void ocl::minMax(const oclMat &src, double *minVal, double *maxVal = 0, const oclMat &mask = oclMat())
 
     :param src: Single-channel array
 
@@ -33,7 +33,7 @@ ocl::minMaxLoc
 ------------------
 Returns void
 
-.. ocv:function:: void minMaxLoc(const oclMat &src, double *minVal, double *maxVal = 0, Point *minLoc = 0, Point *maxLoc = 0,const oclMat &mask = oclMat())
+.. ocv:function:: void ocl::minMaxLoc(const oclMat &src, double *minVal, double *maxVal = 0, Point *minLoc = 0, Point *maxLoc = 0,const oclMat &mask = oclMat())
 
     :param src: Single-channel array
 
@@ -53,7 +53,7 @@ ocl::Sum
 ------------------
 Returns the sum of matrix elements for each channel
 
-.. ocv:function:: Scalar sum(const oclMat &m)
+.. ocv:function:: Scalar ocl::sum(const oclMat &m)
 
     :param m: The Source image of all depth
 
@@ -63,7 +63,7 @@ ocl::sqrSum
 ------------------
 Returns the squared sum of matrix elements for each channel
 
-.. ocv:function:: Scalar sqrSum(const oclMat &m)
+.. ocv:function:: Scalar ocl::sqrSum(const oclMat &m)
 
     :param m: The Source image of all depth
 

diff --git a/modules/ocl/doc/object_detection.rst b/modules/ocl/doc/object_detection.rst
index cbbcd78..6cd3a12 100644 (file)
--- a/modules/ocl/doc/object_detection.rst
+++ b/modules/ocl/doc/object_detection.rst
@@ -3,12 +3,13 @@ Object Detection
 
 .. highlight:: cpp
 
-ocl::oclCascadeClassifier
+ocl::OclCascadeClassifier
 -------------------------
+.. ocv:class:: ocl::OclCascadeClassifier : public CascadeClassifier
 
 Cascade classifier class used for object detection. Supports HAAR cascade classifier  in the form of cross link ::
 
-    class CV_EXPORTS OclCascadeClassifier : public  cv::CascadeClassifier
+    class CV_EXPORTS OclCascadeClassifier : public CascadeClassifier
     {
     public:
           OclCascadeClassifier() {};
@@ -19,11 +20,11 @@ Cascade classifier class used for object detection. Supports HAAR cascade classi
                                       CvSize maxSize = cvSize(0, 0));
     };
 
-ocl::oclCascadeClassifier::oclHaarDetectObjects
+ocl::OclCascadeClassifier::oclHaarDetectObjects
 ------------------------------------------------------
 Returns the detected objects by a list of rectangles
 
-.. ocv:function:: CvSeq *OclCascadeClassifier::oclHaarDetectObjects(oclMat &gimg, CvMemStorage *storage, double scaleFactor,int minNeighbors, int flags, CvSize minSize = cvSize(0, 0), CvSize maxSize = cvSize(0, 0))
+.. ocv:function:: CvSeq* ocl::OclCascadeClassifier::oclHaarDetectObjects(oclMat &gimg, CvMemStorage *storage, double scaleFactor,int minNeighbors, int flags, CvSize minSize = cvSize(0, 0), CvSize maxSize = cvSize(0, 0))
 
     :param image:  Matrix of type CV_8U containing an image where objects should be detected.
 
@@ -39,7 +40,7 @@ Detects objects of different sizes in the input image,only tested for face detec
 
 ocl::MatchTemplateBuf
 ---------------------
-.. ocv:class:: ocl::MatchTemplateBuf
+.. ocv:struct:: ocl::MatchTemplateBuf
 
 Class providing memory buffers for :ocv:func:`ocl::matchTemplate` function, plus it allows to adjust some specific parameters. ::
 

diff --git a/modules/ocl/doc/operations_on_matrices.rst b/modules/ocl/doc/operations_on_matrices.rst
index 27696ca..145659b 100644 (file)
--- a/modules/ocl/doc/operations_on_matrices.rst
+++ b/modules/ocl/doc/operations_on_matrices.rst
@@ -3,11 +3,11 @@ Operations on Matrics
 
 .. highlight:: cpp
 
-ocl::convertTo
-------------------
+ocl::oclMat::convertTo
+----------------------
 Returns void
 
-.. ocv:function:: void convertTo( oclMat &m, int rtype, double alpha = 1, double beta = 0 ) const
+.. ocv:function:: void ocl::oclMat::convertTo( oclMat &m, int rtype, double alpha = 1, double beta = 0 ) const
 
     :param m: The destination matrix. If it does not have a proper size or type before the operation, it will be reallocated
 
@@ -19,11 +19,11 @@ Returns void
 
 The method converts source pixel values to the target datatype. saturate cast is applied in the end to avoid possible overflows. Supports CV_8UC1, CV_8UC4, CV_32SC1, CV_32SC4, CV_32FC1, CV_32FC4.
 
-ocl::copyTo
-------------------
+ocl::oclMat::copyTo
+-------------------
 Returns void
 
-.. ocv:function:: void copyTo( oclMat &m, const oclMat &mask ) const
+.. ocv:function:: void ocl::oclMat::copyTo( oclMat &m, const oclMat &mask ) const
 
     :param m: The destination matrix. If it does not have a proper size or type before the operation, it will be reallocated
 
@@ -31,11 +31,11 @@ Returns void
 
 Copies the matrix to another one. Supports CV_8UC1, CV_8UC4, CV_32SC1, CV_32SC4, CV_32FC1, CV_32FC4
 
-ocl::setTo
+ocl::oclMat::setTo
 ------------------
 Returns oclMat
 
-.. ocv:function:: oclMat &setTo(const Scalar &s, const oclMat &mask = oclMat())
+.. ocv:function:: oclMat& ocl::oclMat::setTo(const Scalar &s, const oclMat &mask = oclMat())
 
     :param s: Assigned scalar, which is converted to the actual array type
 
@@ -47,15 +47,16 @@ ocl::absdiff
 ------------------
 Returns void
 
-.. ocv:function:: void absdiff(const oclMat &a, const oclMat &b, oclMat &c)
+.. ocv:function:: void ocl::absdiff( const oclMat& a, const oclMat& b, oclMat& c )
+
+.. ocv:function:: void ocl::absdiff( const oclMat& a, const Scalar& s, oclMat& c )
 
-.. ocv:function:: void absdiff(const oclMat &a, const Scalar& sc, oclMat &c)
 
     :param a: The first input array
 
     :param b: The second input array, must be the same size and same type as a
 
-    :param sc: Scalar, the second input parameter
+    :param s: Scalar, the second input parameter
 
     :param c: The destination array, it will have the same size and same type as a
 
@@ -65,17 +66,19 @@ ocl::add
 ------------------
 Returns void
 
-.. ocv:function:: void add(const oclMat &src1, const oclMat &src2, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::add( const oclMat & a, const oclMat & b, oclMat & c )
 
-.. ocv:function:: void add(const oclMat &src1, const Scalar &sc, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::add( const oclMat & a, const oclMat & b, oclMat & c, const oclMat & mask )
 
-    :param src1: The first input array
+.. ocv:function:: void ocl::add( const oclMat & a, const Scalar & sc, oclMat & c, const oclMat & mask=oclMat() )
 
-    :param src2: The second input array, must be the same size and same type as src1
+    :param a: The first input array
+
+    :param b: The second input array, must be the same size and same type as src1
 
     :param sc: Scalar, the second input parameter
 
-    :param dst: The destination array, it will have the same size and same type as src1
+    :param c: The destination array, it will have the same size and same type as src1
 
     :param mask: he optional operation mask, 8-bit single channel array; specifies elements of the destination array to be changed
 
@@ -85,17 +88,22 @@ ocl::subtract
 ------------------
 Returns void
 
-.. ocv:function:: void subtract(const oclMat &src1, const oclMat &src2, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::subtract( const oclMat& a, const oclMat& b, oclMat& c )
 
-.. ocv:function:: void subtract(const oclMat &src1, const Scalar &sc, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::subtract( const oclMat& a, const oclMat& b, oclMat& c, const oclMat& mask )
 
-    :param src1: The first input array
+.. ocv:function:: void ocl::subtract( const oclMat& a, const Scalar& sc, oclMat& c, const oclMat& mask=oclMat() )
 
-    :param src2: The second input array, must be the same size and same type as src1
+.. ocv:function:: void ocl::subtract( const Scalar& sc, const oclMat& a, oclMat& c, const oclMat& mask=oclMat() )
+
+
+    :param a: The first input array
+
+    :param b: The second input array, must be the same size and same type as src1
 
     :param sc: Scalar, the second input parameter
 
-    :param dst: The destination array, it will have the same size and same type as src1
+    :param c: The destination array, it will have the same size and same type as src1
 
     :param mask: he optional operation mask, 8-bit single channel array; specifies elements of the destination array to be changed
 
@@ -105,13 +113,13 @@ ocl::multiply
 ------------------
 Returns void
 
-.. ocv:function:: void multiply(const oclMat &src1, const oclMat &src2, oclMat &dst, double scale = 1)
+.. ocv:function:: void ocl::multiply( const oclMat& a, const oclMat& b, oclMat& c, double scale=1 )
 
-    :param src1: The first input array
+    :param a: The first input array
 
-    :param src2: The second input array, must be the same size and same type as src1
+    :param b: The second input array, must be the same size and same type as src1
 
-    :param dst: The destination array, it will have the same size and same type as src1
+    :param c: The destination array, it will have the same size and same type as src1
 
     :param scale: must be 1 now
 
@@ -121,13 +129,15 @@ ocl::divide
 ------------------
 Returns void
 
-.. ocv:function:: void divide(const oclMat &src1, const oclMat &src2, oclMat &dst, double scale = 1)
+.. ocv:function:: void ocl::divide( const oclMat& a, const oclMat& b, oclMat& c, double scale=1 )
 
-    :param src1: The first input array
+.. ocv:function:: void ocl::divide( double scale, const oclMat& b, oclMat& c )
 
-    :param src2: The second input array, must be the same size and same type as src1
+    :param a: The first input array
 
-    :param dst: The destination array, it will have the same size and same type as src1
+    :param b: The second input array, must be the same size and same type as src1
+
+    :param c: The destination array, it will have the same size and same type as src1
 
     :param scale: must be 1 now
 
@@ -137,15 +147,15 @@ ocl::bitwise_and
 ------------------
 Returns void
 
-.. ocv:function:: void bitwise_and(const oclMat &src1, const oclMat &src2, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::bitwise_and( const oclMat& src1, const oclMat& src2, oclMat& dst, const oclMat& mask=oclMat() )
 
-.. ocv:function:: void bitwise_and(const oclMat &src1, const Scalar &sc, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::bitwise_and( const oclMat& src1, const Scalar& s, oclMat& dst, const oclMat& mask=oclMat() )
 
     :param src1: The first input array
 
     :param src2: The second input array, must be the same size and same type as src1
 
-    :param sc: Scalar, the second input parameter
+    :param s: Scalar, the second input parameter
 
     :param dst: The destination array, it will have the same size and same type as src1
 
@@ -157,15 +167,15 @@ ocl::bitwise_or
 ------------------
 Returns void
 
-.. ocv:function:: void bitwise_or(const oclMat &src1, const oclMat &src2, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::bitwise_or( const oclMat& src1, const oclMat& src2, oclMat& dst, const oclMat& mask=oclMat() )
 
-.. ocv:function:: void bitwise_or(const oclMat &src1, const Scalar &sc, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::bitwise_or( const oclMat& src1, const Scalar& s, oclMat& dst, const oclMat& mask=oclMat() )
 
     :param src1: The first input array
 
     :param src2: The second input array, must be the same size and same type as src1
 
-    :param sc: Scalar, the second input parameter
+    :param s: Scalar, the second input parameter
 
     :param dst: The destination array, it will have the same size and same type as src1
 
@@ -177,9 +187,9 @@ ocl::bitwise_xor
 ------------------
 Returns void
 
-.. ocv:function:: void bitwise_xor(const oclMat &src1, const oclMat &src2, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::bitwise_xor( const oclMat& src1, const oclMat& src2, oclMat& dst, const oclMat& mask=oclMat() )
 
-.. ocv:function:: void bitwise_xor(const oclMat &src1, const Scalar &sc, oclMat &dst, const oclMat& mask=oclMat())
+.. ocv:function:: void ocl::bitwise_xor( const oclMat& src1, const Scalar& s, oclMat& dst, const oclMat& mask=oclMat() )
 
     :param src1: The first input array
 
@@ -197,7 +207,7 @@ ocl::bitwise_not
 ------------------
 Returns void
 
-.. ocv:function:: void bitwise_not(const oclMat &src, oclMat &dst)
+.. ocv:function:: void ocl::bitwise_not(const oclMat &src, oclMat &dst)
 
     :param src: The input array
 
@@ -209,7 +219,7 @@ ocl::cartToPolar
 ------------------
 Returns void
 
-.. ocv:function:: void cartToPolar(const oclMat &x, const oclMat &y, oclMat &magnitude, oclMat &angle, bool angleInDegrees = false)
+.. ocv:function:: void ocl::cartToPolar(const oclMat &x, const oclMat &y, oclMat &magnitude, oclMat &angle, bool angleInDegrees = false)
 
     :param x: The array of x-coordinates; must be single-precision or double-precision floating-point array
 
@@ -227,7 +237,7 @@ ocl::polarToCart
 ------------------
 Returns void
 
-.. ocv:function:: void polarToCart(const oclMat &magnitude, const oclMat &angle, oclMat &x, oclMat &y, bool angleInDegrees = false)
+.. ocv:function:: void ocl::polarToCart(const oclMat &magnitude, const oclMat &angle, oclMat &x, oclMat &y, bool angleInDegrees = false)
 
     :param magnitude: The source floating-point array of magnitudes of 2D vectors. It can be an empty matrix (=Mat()) - in this case the function assumes that all the magnitudes are =1. If it's not empty, it must have the same size and same type as angle
 
@@ -245,7 +255,7 @@ ocl::compare
 ------------------
 Returns void
 
-.. ocv:function:: void compare(const oclMat &a, const oclMat &b, oclMat &c, int cmpop)
+.. ocv:function:: void ocl::compare(const oclMat &a, const oclMat &b, oclMat &c, int cmpop)
 
     :param a: The first source array
 
@@ -261,7 +271,7 @@ ocl::exp
 ------------------
 Returns void
 
-.. ocv:function:: void exp(const oclMat &a, oclMat &b)
+.. ocv:function:: void ocl::exp(const oclMat &a, oclMat &b)
 
     :param a: The first source array
 
@@ -273,7 +283,7 @@ ocl::log
 ------------------
 Returns void
 
-.. ocv:function:: void log(const oclMat &a, oclMat &b)
+.. ocv:function:: void ocl::log(const oclMat &a, oclMat &b)
 
     :param a: The first source array
 
@@ -285,7 +295,7 @@ ocl::LUT
 ------------------
 Returns void
 
-.. ocv:function:: void LUT(const oclMat &src, const oclMat &lut, oclMat &dst)
+.. ocv:function:: void ocl::LUT(const oclMat &src, const oclMat &lut, oclMat &dst)
 
     :param src: Source array of 8-bit elements
 
@@ -299,7 +309,7 @@ ocl::magnitude
 ------------------
 Returns void
 
-.. ocv:function:: void magnitude(const oclMat &x, const oclMat &y, oclMat &magnitude)
+.. ocv:function:: void ocl::magnitude(const oclMat &x, const oclMat &y, oclMat &magnitude)
 
     :param x: The floating-point array of x-coordinates of the vectors
 
@@ -313,11 +323,11 @@ ocl::flip
 ------------------
 Returns void
 
-.. ocv:function:: void flip(const oclMat &src, oclMat &dst, int flipCode)
+.. ocv:function:: void ocl::flip( const oclMat& a, oclMat& b, int flipCode )
 
-    :param src: Source image.
+    :param a: Source image.
 
-    :param dst: Destination image
+    :param b: Destination image
 
     :param flipCode: Specifies how to flip the array: 0 means flipping around the x-axis, positive (e.g., 1) means flipping around y-axis, and negative (e.g., -1) means flipping around both axes.
 
@@ -327,7 +337,7 @@ ocl::meanStdDev
 ------------------
 Returns void
 
-.. ocv:function:: void meanStdDev(const oclMat &mtx, Scalar &mean, Scalar &stddev)
+.. ocv:function:: void ocl::meanStdDev(const oclMat &mtx, Scalar &mean, Scalar &stddev)
 
     :param mtx: Source image.
 
@@ -341,7 +351,7 @@ ocl::merge
 ------------------
 Returns void
 
-.. ocv:function:: void merge(const vector<oclMat> &src, oclMat &dst)
+.. ocv:function:: void ocl::merge(const vector<oclMat> &src, oclMat &dst)
 
     :param src: The source array or vector of the single-channel matrices to be merged. All the matrices in src must have the same size and the same type
 
@@ -353,7 +363,7 @@ ocl::split
 ------------------
 Returns void
 
-.. ocv:function:: void split(const oclMat &src, vector<oclMat> &dst)
+.. ocv:function:: void ocl::split(const oclMat &src, vector<oclMat> &dst)
 
     :param src: The source multi-channel array
 
@@ -365,9 +375,9 @@ ocl::norm
 ------------------
 Returns the calculated norm
 
-.. ocv:function:: double norm(const oclMat &src1, int normType = NORM_L2)
+.. ocv:function:: double ocl::norm(const oclMat &src1, int normType = NORM_L2)
 
-.. ocv:function:: double norm(const oclMat &src1, const oclMat &src2, int normType = NORM_L2)
+.. ocv:function:: double ocl::norm(const oclMat &src1, const oclMat &src2, int normType = NORM_L2)
 
     :param src1: The first source array
 
@@ -381,7 +391,7 @@ ocl::phase
 ------------------
 Returns void
 
-.. ocv:function:: void phase(const oclMat &x, const oclMat &y, oclMat &angle, bool angleInDegrees = false)
+.. ocv:function:: void ocl::phase(const oclMat &x, const oclMat &y, oclMat &angle, bool angleInDegrees = false)
 
     :param x: The source floating-point array of x-coordinates of 2D vectors
 
@@ -397,7 +407,7 @@ ocl::pow
 ------------------
 Returns void
 
-.. ocv:function:: void pow(const oclMat &x, double p, oclMat &y)
+.. ocv:function:: void ocl::pow(const oclMat &x, double p, oclMat &y)
 
     :param x: The source array
 
@@ -411,7 +421,7 @@ ocl::transpose
 ------------------
 Returns void
 
-.. ocv:function:: void transpose(const oclMat &src, oclMat &dst)
+.. ocv:function:: void ocl::transpose(const oclMat &src, oclMat &dst)
 
     :param src: The source array
 
@@ -424,7 +434,7 @@ ocl::dft
 ------------
 Performs a forward or inverse discrete Fourier transform (1D or 2D) of the floating point matrix.
 
-.. ocv:function:: void ocl::dft(const oclMat& src, oclMat& dst, Size dft_size, int flags=0)
+.. ocv:function:: void ocl::dft( const oclMat& src, oclMat& dst, Size dft_size=Size(0, 0), int flags=0 )
 
     :param src: Source matrix (real or complex).
 
@@ -452,7 +462,7 @@ ocl::gemm
 ------------------
 Performs generalized matrix multiplication.
 
-.. ocv:function:: void gemm(const oclMat& src1, const oclMat& src2, double alpha, const oclMat& src3, double beta, oclMat& dst, int flags = 0)
+.. ocv:function:: void ocl::gemm(const oclMat& src1, const oclMat& src2, double alpha, const oclMat& src3, double beta, oclMat& dst, int flags = 0)
 
     :param src1: First multiplied input matrix that should be ``CV_32FC1`` type.
 

diff --git a/modules/ocl/doc/structures_and_utility_functions.rst b/modules/ocl/doc/structures_and_utility_functions.rst
index df19a3c..32aa8b9 100644 (file)
--- a/modules/ocl/doc/structures_and_utility_functions.rst
+++ b/modules/ocl/doc/structures_and_utility_functions.rst
@@ -35,7 +35,7 @@ ocl::setBinpath
 ------------------
 Returns void
 
-.. ocv:function:: void setBinpath(const char *path)
+.. ocv:function:: void ocl::setBinpath(const char *path)
 
     :param path: the path of OpenCL kernel binaries
 
@@ -45,7 +45,7 @@ ocl::getoclContext
 ------------------
 Returns the pointer to the opencl context
 
-.. ocv:function:: void *getoclContext()
+.. ocv:function:: void* ocl::getoclContext()
 
 Thefunction are used to get opencl context so that opencv can interactive with other opencl program.
 
@@ -53,6 +53,6 @@ ocl::getoclCommandQueue
 --------------------------
 Returns the pointer to the opencl command queue
 
-.. ocv:function:: void *getoclCommandQueue()
+.. ocv:function:: void* ocl::getoclCommandQueue()
 
 Thefunction are used to get opencl command queue so that opencv can interactive with other opencl program.
\ No newline at end of file

diff --git a/modules/ocl/include/opencv2/ocl/ocl.hpp b/modules/ocl/include/opencv2/ocl/ocl.hpp
index 419b05b..4a56cff 100644 (file)
--- a/modules/ocl/include/opencv2/ocl/ocl.hpp
+++ b/modules/ocl/include/opencv2/ocl/ocl.hpp
@@ -95,9 +95,9 @@ namespace cv
 
         //other opencl program
 
-        CV_EXPORTS void *getoclContext();
+        CV_EXPORTS void* getoclContext();
 
-        CV_EXPORTS void *getoclCommandQueue();
+        CV_EXPORTS void* getoclCommandQueue();
         //////////////////////////////// Error handling ////////////////////////
         CV_EXPORTS void error(const char *error_string, const char *file, const int line, const char *func);
 
@@ -191,10 +191,10 @@ namespace cv
 
             //! sets every oclMatrix element to s
             //It supports 8UC1 8UC4 32SC1 32SC4 32FC1 32FC4
-            oclMat &operator = (const Scalar &s);
+            oclMat& operator = (const Scalar &s);
             //! sets some of the oclMatrix elements to s, according to the mask
             //It supports 8UC1 8UC4 32SC1 32SC4 32FC1 32FC4
-            oclMat &setTo(const Scalar &s, const oclMat &mask = oclMat());
+            oclMat& setTo(const Scalar &s, const oclMat &mask = oclMat());
             //! creates alternative oclMatrix header for the same data, with different
             // number of channels and/or different number of rows. see cvReshape.
             oclMat reshape(int cn, int rows = 0) const;
@@ -213,7 +213,7 @@ namespace cv
             //! locates oclMatrix header within a parent oclMatrix. See below
             void locateROI( Size &wholeSize, Point &ofs ) const;
             //! moves/resizes the current oclMatrix ROI inside the parent oclMatrix.
-            oclMat &adjustROI( int dtop, int dbottom, int dleft, int dright );
+            oclMat& adjustROI( int dtop, int dbottom, int dleft, int dright );
             //! extracts a rectangular sub-oclMatrix
             // (this is a generalized form of row, rowRange etc.)
             oclMat operator()( Range rowRange, Range colRange ) const;
@@ -249,7 +249,7 @@ namespace cv
             bool empty() const;
 
             //! returns pointer to y-th row
-            uchar *ptr(int y = 0);
+            uchar* ptr(int y = 0);
             const uchar *ptr(int y = 0) const;
 
             //! template version of the above method
@@ -347,7 +347,7 @@ namespace cv
 
         //! transposes the matrix
         // supports  CV_8UC1, 8UC4, 8SC4, 16UC2, 16SC2, 32SC1 and 32FC1.(the same as cuda)
-        CV_EXPORTS void transpose(const oclMat &src1, oclMat &dst);
+        CV_EXPORTS void transpose(const oclMat &src, oclMat &dst);
 
         //! computes element-wise absolute difference of two arrays (c = abs(a - b))
         // supports all types except CV_8SC1,CV_8SC2,CV8SC3 and CV_8SC4
@@ -407,7 +407,7 @@ namespace cv
         CV_EXPORTS void equalizeHist(const oclMat &mat_src, oclMat &mat_dst);
         //! bilateralFilter
         // supports 8UC1 8UC4
-        CV_EXPORTS void bilateralFilter(const oclMat &, oclMat &, int , double, double, int);
+        CV_EXPORTS void bilateralFilter(const oclMat& src, oclMat& dst, int d, double sigmaColor, double sigmaSpave, int borderType=BORDER_DEFAULT);
         //! computes exponent of each matrix element (b = e**a)
         // supports only CV_32FC1 type
         CV_EXPORTS void exp(const oclMat &a, oclMat &b);
@@ -719,7 +719,7 @@ namespace cv
             OclCascadeClassifier() {};
             ~OclCascadeClassifier() {};
 
-            CvSeq *oclHaarDetectObjects(oclMat &gimg, CvMemStorage *storage, double scaleFactor,
+            CvSeq* oclHaarDetectObjects(oclMat &gimg, CvMemStorage *storage, double scaleFactor,
                                         int minNeighbors, int flags, CvSize minSize = cvSize(0, 0), CvSize maxSize = cvSize(0, 0));
         };
 
@@ -729,7 +729,7 @@ namespace cv
         CV_EXPORTS void pyrDown(const oclMat &src, oclMat &dst);
 
         //! upsamples the source image and then smoothes it
-        CV_EXPORTS void pyrUp(const cv::ocl::oclMat &src, cv::ocl::oclMat &dst);
+        CV_EXPORTS void pyrUp(const oclMat &src, oclMat &dst);
 
         //! performs linear blending of two images
         //! to avoid accuracy errors sum of weigths shouldn't be very close to zero
@@ -1705,11 +1705,11 @@ namespace cv
         };
         //////////////// build warping maps ////////////////////
         //! builds plane warping maps
-        CV_EXPORTS void buildWarpPlaneMaps(Size, Rect, const Mat &, const Mat &, const Mat &, float, oclMat &, oclMat &);
+        CV_EXPORTS void buildWarpPlaneMaps(Size src_size, Rect dst_roi, const Mat &K, const Mat &R, const Mat &T, float scale, oclMat &map_x, oclMat &map_y);
         //! builds cylindrical warping maps
-        CV_EXPORTS void buildWarpCylindricalMaps(Size, Rect, const Mat &, const Mat &, float, oclMat &, oclMat &);
+        CV_EXPORTS void buildWarpCylindricalMaps(Size src_size, Rect dst_roi, const Mat &K, const Mat &R, float scale, oclMat &map_x, oclMat &map_y);
         //! builds spherical warping maps
-        CV_EXPORTS void buildWarpSphericalMaps(Size, Rect, const Mat &, const Mat &, float, oclMat &, oclMat &);
+        CV_EXPORTS void buildWarpSphericalMaps(Size src_size, Rect dst_roi, const Mat &K, const Mat &R, float scale, oclMat &map_x, oclMat &map_y);
         //! builds Affine warping maps
         CV_EXPORTS void buildWarpAffineMaps(const Mat &M, bool inverse, Size dsize, oclMat &xmap, oclMat &ymap);
 

diff --git a/modules/python/src2/hdr_parser.py b/modules/python/src2/hdr_parser.py
index 8335b0c..4c81b04 100755 (executable)
--- a/modules/python/src2/hdr_parser.py
+++ b/modules/python/src2/hdr_parser.py
@@ -575,6 +575,8 @@ class CppHeaderParser(object):
         """
         if not self.block_stack:
             return name
+        if name.startswith("cv."):
+            return name
         n = ""
         for b in self.block_stack:
             block_type, block_name = b[self.BLOCK_TYPE], b[self.BLOCK_NAME]