From 8bed7bb5f9215eca621aed05cbf1dfa48743a50f Mon Sep 17 00:00:00 2001 From: Roman Donchenko Date: Tue, 6 Aug 2013 15:38:19 +0400 Subject: [PATCH] Fixed documentation errors. --- .../doc/camera_calibration_and_3d_reconstruction.rst | 2 +- modules/core/doc/opengl_interop.rst | 6 +----- modules/highgui/doc/user_interface.rst | 4 ++-- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.rst b/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.rst index 60eeebb4d2..d486bc8ca2 100644 --- a/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.rst +++ b/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.rst @@ -1214,7 +1214,7 @@ The class implements the modified H. Hirschmuller algorithm [HH08]_ that differs * Mutual information cost function is not implemented. Instead, a simpler Birchfield-Tomasi sub-pixel metric from [BT98]_ is used. Though, the color images are supported as well. - * Some pre- and post- processing steps from K. Konolige algorithm :ocv:funcx:`StereoBM::operator()` are included, for example: pre-filtering (``CV_STEREO_BM_XSOBEL`` type) and post-filtering (uniqueness check, quadratic interpolation and speckle filtering). + * Some pre- and post- processing steps from K. Konolige algorithm ``StereoBM`` are included, for example: pre-filtering (``StereoBM::PREFILTER_XSOBEL`` type) and post-filtering (uniqueness check, quadratic interpolation and speckle filtering). .. Sample code:: diff --git a/modules/core/doc/opengl_interop.rst b/modules/core/doc/opengl_interop.rst index e0db36aec4..53c58fcdf7 100644 --- a/modules/core/doc/opengl_interop.rst +++ b/modules/core/doc/opengl_interop.rst @@ -158,14 +158,10 @@ ogl::Buffer::copyTo ------------------- Copies from OpenGL buffer to host/device memory or another OpenGL buffer object. -.. ocv:function:: void ogl::Buffer::copyTo(OutputArray arr, Target target = ARRAY_BUFFER, bool autoRelease = false) const +.. ocv:function:: void ogl::Buffer::copyTo(OutputArray arr) const :param arr: Destination array (host or device memory, can be :ocv:class:`Mat` , :ocv:class:`gpu::GpuMat` , ``std::vector`` or ``ogl::Buffer`` ). - :param target: Buffer usage for destination buffer (if ``arr`` is OpenGL buffer). - - :param autoRelease: Auto release mode for destination buffer (if ``arr`` is OpenGL buffer). - ogl::Buffer::clone diff --git a/modules/highgui/doc/user_interface.rst b/modules/highgui/doc/user_interface.rst index 09967ba2c7..3b822e4883 100644 --- a/modules/highgui/doc/user_interface.rst +++ b/modules/highgui/doc/user_interface.rst @@ -266,7 +266,7 @@ setOpenGlContext ---------------- Sets the specified window as current OpenGL context. -.. ocv:function:: void setOpenGlContext(const string& winname) +.. ocv:function:: void setOpenGlContext(const String& winname) :param winname: Window name @@ -274,6 +274,6 @@ updateWindow ------------ Force window to redraw its context and call draw callback ( :ocv:func:`setOpenGlDrawCallback` ). -.. ocv:function:: void updateWindow(const string& winname) +.. ocv:function:: void updateWindow(const String& winname) :param winname: Window name