Documented the TermCriteria class (#2560)

diff --git a/modules/core/doc/basic_structures.rst b/modules/core/doc/basic_structures.rst
index bac7194cb40db15506c41ec8a53057affc0f812e..2e680229ee92e31ebcefb9dab331e94cd22f12da 100644 (file)
--- a/modules/core/doc/basic_structures.rst
+++ b/modules/core/doc/basic_structures.rst
@@ -219,7 +219,31 @@ TermCriteria
 ------------
 .. ocv:class:: TermCriteria
 
-Template class defining termination criteria for iterative algorithms.
+  The class defining termination criteria for iterative algorithms. You can initialize it by default constructor and then override any parameters, or the structure may be fully initialized using the advanced variant of the constructor.
+
+TermCriteria::TermCriteria
+--------------------------
+The constructors.
+
+.. ocv:function:: TermCriteria::TermCriteria()
+
+.. ocv:function:: TermCriteria::TermCriteria(int type, int maxCount, double epsilon)
+
+.. ocv:function:: TermCriteria::TermCriteria(const CvTermCriteria& criteria)
+
+    :param type: The type of termination criteria: ``TermCriteria::COUNT``, ``TermCriteria::EPS`` or ``TermCriteria::COUNT`` + ``TermCriteria::EPS``.
+
+    :param maxCount: The maximum number of iterations or elements to compute.
+
+    :param epsilon: The desired accuracy or change in parameters at which the iterative algorithm stops.
+
+    :param criteria: Termination criteria in the deprecated ``CvTermCriteria`` format.
+   
+TermCriteria::operator CvTermCriteria
+-------------------------------------
+Converts to the deprecated ``CvTermCriteria`` format.
+
+.. ocv:function:: TermCriteria::operator CvTermCriteria() const
 
 Matx
 ----

diff --git a/modules/core/include/opencv2/core/core.hpp b/modules/core/include/opencv2/core/core.hpp
index 8cf8f28c10ed3b21a961a9f28d08f2e679f84265..9d25916cd6e77d3fa36b9897f82accc7e351687d 100644 (file)
--- a/modules/core/include/opencv2/core/core.hpp
+++ b/modules/core/include/opencv2/core/core.hpp
@@ -2037,10 +2037,10 @@ public:
     //! default constructor
     TermCriteria();
     //! full constructor
-    TermCriteria(int _type, int _maxCount, double _epsilon);
+    TermCriteria(int type, int maxCount, double epsilon);
     //! conversion from CvTermCriteria
     TermCriteria(const CvTermCriteria& criteria);
-    //! conversion from CvTermCriteria
+    //! conversion to CvTermCriteria
     operator CvTermCriteria() const;
 
     int type; //!< the type of termination criteria: COUNT, EPS or COUNT + EPS