From 4e51c38fa35c6f618fd350d40fd43fc55092e6a6 Mon Sep 17 00:00:00 2001
From: Ilya Lysenkov <no@email>
Date: Mon, 9 Apr 2012 12:44:18 +0000
Subject: [PATCH] Documented a return value in meanShift() and CamShift()
 (issue #1678)

---
 modules/video/doc/motion_analysis_and_object_tracking.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/modules/video/doc/motion_analysis_and_object_tracking.rst b/modules/video/doc/motion_analysis_and_object_tracking.rst
index e9178bdf39..12783fce62 100644
--- a/modules/video/doc/motion_analysis_and_object_tracking.rst
+++ b/modules/video/doc/motion_analysis_and_object_tracking.rst
@@ -279,6 +279,8 @@ Finds an object center, size, and orientation.
 
     :param criteria: Stop criteria for the underlying  :ocv:func:`meanShift` .
 
+    :returns: (in old interfaces) Number of iterations CAMSHIFT took to converge 
+
 The function implements the CAMSHIFT object tracking algrorithm
 [Bradski98]_.
 First, it finds an object center using
@@ -305,6 +307,8 @@ Finds an object on a back projection image.
 
     :param criteria: Stop criteria for the iterative search algorithm.
 
+    :returns: Number of iterations CAMSHIFT took to converge.
+
 The function implements the iterative object search algorithm. It takes the input back projection of an object and the initial position. The mass center in ``window`` of the back projection image is computed and the search window center shifts to the mass center. The procedure is repeated until the specified number of iterations ``criteria.maxCount`` is done or until the window center shifts by less than ``criteria.epsilon`` . The algorithm is used inside
 :ocv:func:`CamShift` and, unlike
 :ocv:func:`CamShift` , the search window size or orientation do not change during the search. You can simply pass the output of