Update comments

[modules/gui.git] / src / SUIT / SUIT_DataObjectKey.cxx

diff --git a/src/SUIT/SUIT_DataObjectKey.cxx b/src/SUIT/SUIT_DataObjectKey.cxx
index 3f6a7148f4887ab7becea0e9a5d2aaa60eda91a8..6ce6db2279f571534b01ccb520f0d0db2eba5661 100755 (executable)
--- a/src/SUIT/SUIT_DataObjectKey.cxx
+++ b/src/SUIT/SUIT_DataObjectKey.cxx
@@ -10,30 +10,40 @@
 #define _typeinfo type_info
 #endif
 
+/*!\class SUIT_DataObjectKey
+ * Key for personal idetfication of SUIT_DataObject.
+ */
+
 /*!
-    Class: SUIT_DataObjectKey
-    Descr: Key for personal idetfication of SUIT_DataObject.
+  Constructor.
 */
-
 SUIT_DataObjectKey::SUIT_DataObjectKey()
 : refCounter( 0 )
 {
 }
 
+/*!
+  Destructor.
+*/
 SUIT_DataObjectKey::~SUIT_DataObjectKey()
 {
 }
 
+/*!\class SUIT_DataObjectKeyHandle
+ * Wrapper around the pointer of class SUIT_DataObjectKey.
+ */
+
 /*!
-    Class: SUIT_DataObjectKeyHandle
-    Descr: Wrapper around the pointer of class SUIT_DataObjectKey.
+  Constructor. 
 */
-
 SUIT_DataObjectKeyHandle::SUIT_DataObjectKeyHandle()
 : myKey( 0 )
 {
 }
 
+/*!
+  Copy Constructor.
+*/
 SUIT_DataObjectKeyHandle::SUIT_DataObjectKeyHandle( const SUIT_DataObjectKeyHandle& other )
 : myKey( other.myKey )
 {
@@ -42,27 +52,44 @@ SUIT_DataObjectKeyHandle::SUIT_DataObjectKeyHandle( const SUIT_DataObjectKeyHand
   beginScope();
 }
 
+/*!
+  Constructor. Initialize by key \a key.
+*/
 SUIT_DataObjectKeyHandle::SUIT_DataObjectKeyHandle( SUIT_DataObjectKey* key )
 : myKey( key )
 {
   beginScope();
 }
 
+/*!
+  Destructor.
+*/
 SUIT_DataObjectKeyHandle::~SUIT_DataObjectKeyHandle()
 {
   nullify();
 }
 
+/*!
+ * Checks: Is key null?
+ *\retval TRUE - if null, esle false.
+*/
 bool SUIT_DataObjectKeyHandle::isNull() const
 {
   return !myKey;
 }
 
+/*!
+  Nullify key.
+*/
 void SUIT_DataObjectKeyHandle::nullify()
 {
   endScope();
 }
 
+/*!
+ *  Operator less.
+ *\retval boolean. TRUE - If current key less than \a kw.
+ */
 bool SUIT_DataObjectKeyHandle::operator<( const SUIT_DataObjectKeyHandle& kw ) const
 {
   if ( myKey == kw.myKey )
@@ -83,6 +110,10 @@ bool SUIT_DataObjectKeyHandle::operator<( const SUIT_DataObjectKeyHandle& kw ) c
     return myKey->isLess( kw.myKey );
 }
 
+/*!
+ * Operator is equal.
+ *\retval boolean. TRUE - If current key equal \a kw.
+ */
 bool SUIT_DataObjectKeyHandle::operator==( const SUIT_DataObjectKeyHandle& kw ) const
 {
   if ( myKey == kw.myKey )
@@ -97,6 +128,9 @@ bool SUIT_DataObjectKeyHandle::operator==( const SUIT_DataObjectKeyHandle& kw )
   return myKey->isEqual( kw.myKey );
 }
 
+/*!
+ * Copy value of key \a kw to current.
+ */
 SUIT_DataObjectKeyHandle& SUIT_DataObjectKeyHandle::operator=( const SUIT_DataObjectKeyHandle& kw )
 {
   if ( myKey != kw.myKey )
@@ -110,12 +144,18 @@ SUIT_DataObjectKeyHandle& SUIT_DataObjectKeyHandle::operator=( const SUIT_DataOb
   return *this;
 }
 
+/*!
+ * Inctrement reference counter for current key.
+ */
 void SUIT_DataObjectKeyHandle::beginScope()
 {
   if ( myKey )
     myKey->refCounter++;
 }
 
+/*!
+ * Decrement reference counter for current key.
+ */
 void SUIT_DataObjectKeyHandle::endScope()
 {
   if ( !myKey )