From d314c602d57af0a8aa3e0086cec09a7f03596aa2 Mon Sep 17 00:00:00 2001
From: "marina.kolpakova" <marina.kolpakova@itseez.com>
Date: Wed, 30 Jan 2013 11:24:45 +0400
Subject: [PATCH] add documentation for new classes

---
 .../softcascade/doc/softcascade_training.rst  | 67 ++++++++++++++++++-
 1 file changed, 64 insertions(+), 3 deletions(-)

diff --git a/modules/softcascade/doc/softcascade_training.rst b/modules/softcascade/doc/softcascade_training.rst
index 6b906657a..b19946206 100644
--- a/modules/softcascade/doc/softcascade_training.rst
+++ b/modules/softcascade/doc/softcascade_training.rst
@@ -11,7 +11,7 @@ SoftCascadeOctave
 -----------------
 .. ocv:class:: SoftCascadeOctave
 
-Public interface for soft cascade training algorithm
+Public interface for soft cascade training algorithm. ::
 
     class CV_EXPORTS SoftCascadeOctave : public Algorithm
     {
@@ -70,8 +70,8 @@ SoftCascadeOctave::setRejectThresholds
 SoftCascadeOctave::write
 ------------------------
 
-.. ocv:function:: write SoftCascadeOctave::train(cv::FileStorage &fs, const FeaturePool* pool, InputArray thresholds) const
-.. ocv:function:: write SoftCascadeOctave::train( CvFileStorage* fs, string name) const
+.. ocv:function:: void SoftCascadeOctave::train(cv::FileStorage &fs, const FeaturePool* pool, InputArray thresholds) const
+.. ocv:function:: void SoftCascadeOctave::train( CvFileStorage* fs, string name) const
 
     :param fs an output file storage to store trained detector.
 
@@ -80,3 +80,64 @@ SoftCascadeOctave::write
     :param dataset a rejection vector that should be included in detector xml file.
 
     :param name a name of root node for trained detector.
+
+
+FeaturePool
+-----------
+.. ocv:class:: FeaturePool
+
+Public interface for feature pool. This is a hight level abstraction for training random feature pool. ::
+
+    class CV_EXPORTS FeaturePool
+    {
+    public:
+
+        virtual int size() const = 0;
+        virtual float apply(int fi, int si, const Mat& channels) const = 0;
+        virtual void write( cv::FileStorage& fs, int index) const = 0;
+        virtual ~FeaturePool();
+
+    };
+
+FeaturePool::size
+-----------------
+
+Returns size of feature pool.
+
+.. ocv:function:: int FeaturePool::size() const
+
+
+
+FeaturePool::~FeaturePool
+-------------------------
+
+FeaturePool destructor.
+
+.. ocv:function:: int FeaturePool::~FeaturePool()
+
+
+
+FeaturePool::write
+------------------
+
+Write specified feature from feature pool to file storage.
+
+.. ocv:function:: void FeaturePool::write( cv::FileStorage& fs, int index) const
+
+    :param fs an output file storage to store feature.
+
+    :param index an index of feature that should be stored.
+
+
+FeaturePool::apply
+------------------
+
+Compute feature on integral channel image.
+
+.. ocv:function:: float FeaturePool::apply(int fi, int si, const Mat& channels) const
+
+    :param fi an index of feature that should be computed.
+
+    :param si an index of sample.
+
+    :param fs a channel matrix.
\ No newline at end of file