Join modifications from branch OCC_debug_for_3_2_0b1

[modules/gui.git] / src / SUIT / SUIT_DataObjectIterator.h

diff --git a/src/SUIT/SUIT_DataObjectIterator.h b/src/SUIT/SUIT_DataObjectIterator.h
index 45b8f7082368fe15175a7954fc16813fca46fd9d..f697a0f682cf227f5673bf931d9cf193f5dce9a3 100644 (file)
--- a/src/SUIT/SUIT_DataObjectIterator.h
+++ b/src/SUIT/SUIT_DataObjectIterator.h
@@ -22,7 +22,10 @@
 #include "SUIT_DataObject.h"
 
 /*!
-  Class provide data object iterator.
+  \class SUIT_DataObjectIterator
+  Provides functionality of SUIT tree detour
+  It is possible to use "to-depth" or "to-breadth" detour and
+  to control level detour (from left or from right)
 */
 class SUIT_EXPORT SUIT_DataObjectIterator
 {
@@ -51,6 +54,11 @@ private:
   int               myDetourType, myCurrentLevel;
 };
 
+/*!
+  \class SUIT_DataObjectIterator
+  Provides functionality of SUIT tree detour between certain levels 
+  Only "to-breadth" detour is used
+*/
 class SUIT_DataObjectLevelIterator : public SUIT_DataObjectIterator
 {
 public: