From: enk <enk@opencascade.com>
Date: Mon, 11 Jul 2005 13:01:15 +0000 (+0000)
Subject: Update comments
X-Git-Tag: V3_0_1~76
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=6c1750a4187a06f75b396d5f9dd14a9b199cee22;p=modules%2Fgui.git

Update comments
---

diff --git a/src/SUIT/SUIT_Operation.cxx b/src/SUIT/SUIT_Operation.cxx
index f7f34a623..c01ecd3ea 100755
--- a/src/SUIT/SUIT_Operation.cxx
+++ b/src/SUIT/SUIT_Operation.cxx
@@ -3,6 +3,7 @@
 #include "SUIT_Study.h"
 #include "SUIT_Application.h"
 
+/*! Constructor. Initialize myApp, myStudy, myState.*/
 SUIT_Operation::SUIT_Operation( SUIT_Application* app )
 : QObject(),
 myApp( app ),
@@ -11,25 +12,30 @@ myState( Waiting )
 {
 }
 
+/*! Destructor*/
 SUIT_Operation::~SUIT_Operation()
 {
 }
 
+/*! \retval Return myStudy.*/
 SUIT_Study* SUIT_Operation::study() const
 {
   return myStudy;
 }
 
+/*! \retval Return myApp*/
 SUIT_Application* SUIT_Operation::application() const
 {
   return myApp;
 }
 
+/*! \retval Return myState*/
 SUIT_Operation::OperationState SUIT_Operation::state() const
 {
   return myState;
 }
 
+/*! Set started operation status*/
 void SUIT_Operation::start()
 {
 	myStudy = myApp->activeStudy();
@@ -50,6 +56,7 @@ void SUIT_Operation::start()
 	}
 }
 
+/*! Set aborted operation status*/
 void SUIT_Operation::abort()
 {
 	abortOperation();
@@ -59,6 +66,7 @@ void SUIT_Operation::abort()
   emit aborted( this );
 }
 
+/*! Set commited operation status*/
 void SUIT_Operation::commit()
 {
 	commitOperation();
@@ -70,6 +78,7 @@ void SUIT_Operation::commit()
   myStudy->sendChangesNotification();
 }
 
+/*! Set resumed operation status*/
 void SUIT_Operation::resume()
 {
 	resumeOperation();
@@ -78,6 +87,7 @@ void SUIT_Operation::resume()
 	emit resumed( this );
 }
 
+/*! Set suspended operation status*/
 void SUIT_Operation::suspend()
 {
 	suspendOperation();
@@ -86,11 +96,16 @@ void SUIT_Operation::suspend()
 	emit suspended( this );
 }
 
+/*! \retval Return true*/
 bool SUIT_Operation::isReadyToStart()
 {
 	return true;
 }
 
+/*! start operation.\n
+ *  emitting callSlot() signal \n
+ *  calling commit() function.
+ */
 void SUIT_Operation::startOperation()
 {
 	emit callSlot();
@@ -98,42 +113,51 @@ void SUIT_Operation::startOperation()
 	commit();
 }
 
+/*! Do nothing*/
 void SUIT_Operation::abortOperation()
 {
 }
 
+/*! Do nothing*/
 void SUIT_Operation::resumeOperation()
 {
 }
 
+/*! Do nothing*/
 void SUIT_Operation::suspendOperation()
 {
 }
 
+/*! Do nothing*/
 void SUIT_Operation::commitOperation()
 {
 }
 
+/*! Setting slot.*/
 bool SUIT_Operation::setSlot( const QObject* theReceiver, const char* theSlot )
 {
 	return connect( this, SIGNAL( callSlot() ), theReceiver, theSlot );
 }
 
+/*! \retval Return false*/
 bool SUIT_Operation::isValid( SUIT_Operation* ) const
 {
   return false;
 }
 
+/*! \retval Return false*/
 bool SUIT_Operation::isGranted() const
 {
   return false;
 }
 
+/*! Setting study.*/
 void SUIT_Operation::setStudy( SUIT_Study* s )
 {
   myStudy = s;
 }
 
+/*! Setting application.*/
 void SUIT_Operation::setApplication( SUIT_Application* app )
 {
   myApp = app;
diff --git a/src/SUIT/SUIT_Operation.h b/src/SUIT/SUIT_Operation.h
index 123ec3747..a77bdb390 100755
--- a/src/SUIT/SUIT_Operation.h
+++ b/src/SUIT/SUIT_Operation.h
@@ -51,7 +51,7 @@ protected:
 	virtual void      resumeOperation();
 	virtual void      suspendOperation();
 
-  // Returns TRUE if the given operator is valid for (can be started "above") the current operator
+	/*! Returns TRUE if the given operator is valid for (can be started "above") the current operator*/
 	virtual bool      isValid( SUIT_Operation* ) const;
 
 	/*!
@@ -67,7 +67,7 @@ protected:
 
 private:
 	SUIT_Application* myApp;
-	SUIT_Study*		    myStudy;
+	SUIT_Study*       myStudy;
 	OperationState	  myState;
 
 	friend class SUIT_Study;
diff --git a/src/SUIT/SUIT_OverrideCursor.cxx b/src/SUIT/SUIT_OverrideCursor.cxx
index fa8efc2fc..770d14521 100755
--- a/src/SUIT/SUIT_OverrideCursor.cxx
+++ b/src/SUIT/SUIT_OverrideCursor.cxx
@@ -1,25 +1,30 @@
 #include "SUIT_OverrideCursor.h"
 
+/*!Constructor. Initialize wait cursor.*/
 SUIT_OverrideCursor::SUIT_OverrideCursor()
 {
   QApplication::setOverrideCursor( QCursor( Qt::WaitCursor ) );
 }
 
+/*!Copy constructor.*/
 SUIT_OverrideCursor::SUIT_OverrideCursor( const QCursor& cursor )
 {
   QApplication::setOverrideCursor( cursor );
 }
 
+/*!Destructor. restoring override cursor.*/
 SUIT_OverrideCursor::~SUIT_OverrideCursor()
 {
   QApplication::restoreOverrideCursor();
 }
 
+/*! Check cursors is empty */
 bool SUIT_OverrideCursor::isActive() const
 {
   return myCursors.isEmpty();
 }
 
+/*!Suspend cursors.*/
 void SUIT_OverrideCursor::suspend()
 {
   if ( !isActive() )
@@ -32,6 +37,7 @@ void SUIT_OverrideCursor::suspend()
   }
 }
 
+/*!Resume cursors.*/
 void SUIT_OverrideCursor::resume()
 {
   if ( isActive() )
diff --git a/src/SUIT/SUIT_OverrideCursor.h b/src/SUIT/SUIT_OverrideCursor.h
index 03c551d8b..f3a678834 100755
--- a/src/SUIT/SUIT_OverrideCursor.h
+++ b/src/SUIT/SUIT_OverrideCursor.h
@@ -6,6 +6,7 @@
 
 #include "SUIT.h"
 
+/*! \brief Class used for management cursors.*/
 class SUIT_EXPORT SUIT_OverrideCursor
 {
 public:
diff --git a/src/SUIT/SUIT_ParserSettings.cxx b/src/SUIT/SUIT_ParserSettings.cxx
index d7b358b30..44689d114 100755
--- a/src/SUIT/SUIT_ParserSettings.cxx
+++ b/src/SUIT/SUIT_ParserSettings.cxx
@@ -36,16 +36,14 @@
 #include <qtextstream.h>
 
 
-/*!
-    Constructor.
-*/
+/*! Constructor. Do nothing.*/
 SUIT_ParserSettings::SUIT_ParserSettings()
 {
 }
 
 
 /*!
-    Destructor.
+    Destructor. Do nothing.
 */
 SUIT_ParserSettings::~SUIT_ParserSettings()
 {
@@ -202,7 +200,7 @@ QString SUIT_ParserSettings::removeComments(QString s)
 
 
 /*!
-    Removes all HTML comments (between '<!--' and '-->').
+    Removes all HTML comments (between '<!--' and '-->') \image html html_comments.gif
 */
 QString SUIT_ParserSettings::removeHtmlComments(QString s)
 {
diff --git a/src/SUIT/SUIT_ParserSettings.h b/src/SUIT/SUIT_ParserSettings.h
index 9475b235b..b5e724a6c 100755
--- a/src/SUIT/SUIT_ParserSettings.h
+++ b/src/SUIT/SUIT_ParserSettings.h
@@ -31,7 +31,7 @@
 
 #include <qstring.h>
 #include "SUIT.h"
-
+/*! \brief Text Parser.*/
 class SUIT_EXPORT SUIT_ParserSettings
 {
 public:
diff --git a/src/SUIT/SUIT_PopupClient.cxx b/src/SUIT/SUIT_PopupClient.cxx
index ddb795139..8714bfe64 100644
--- a/src/SUIT/SUIT_PopupClient.cxx
+++ b/src/SUIT/SUIT_PopupClient.cxx
@@ -2,16 +2,13 @@
 
 #include <qevent.h>
 
-/*
-  Class: SUIT_PopupClient [public]
-  Descr: Base class for instances which creates popup menu on QContextMenuEvent
-*/
-
+/*! constructor. initialize mySignal.*/
 SUIT_PopupClient::SUIT_PopupClient()
 : mySignal( 0 )
 {
 }
 
+/*! destructor. delete mySignal*/
 SUIT_PopupClient::~SUIT_PopupClient()
 {
   delete mySignal;
@@ -46,11 +43,13 @@ void SUIT_PopupClient::contextMenuRequest( QContextMenuEvent* e )
   Descr: invoke signal which is connected to reciever in SUIT_PopupClient
 */
 
+/*! constructor*/
 SUIT_PopupClient::Signal::Signal()
 : QObject( 0 )
 {
 }
 
+/*! destructor. do nothing*/
 SUIT_PopupClient::Signal::~Signal()
 {}
 
diff --git a/src/SUIT/SUIT_PopupClient.h b/src/SUIT/SUIT_PopupClient.h
index 75522cb3d..4ea4a5957 100644
--- a/src/SUIT/SUIT_PopupClient.h
+++ b/src/SUIT/SUIT_PopupClient.h
@@ -8,11 +8,9 @@
 class QPopupMenu;
 class QContextMenuEvent;
 
-/*
-  Class: SUIT_PopupClient [public]
-  Descr: Base class for instances which creates popup menu on QContextMenuEvent
-*/
-
+/*!Class: SUIT_PopupClient [public] \n
+ * Descr: Base class for instances which creates popup menu on QContextMenuEvent
+ */
 class SUIT_EXPORT SUIT_PopupClient
 {
 public:
@@ -35,11 +33,9 @@ private:
   Signal* mySignal;
 };
 
-/*
-  Class: SUIT_PopupClient::Signal [internal]
-  Descr: invoke signal which is connected to reciever in SUIT_PopupClient
-*/
-
+/*! Class: SUIT_PopupClient::Signal [internal] \n
+ *  Descr: invoke signal which is connected to reciever in SUIT_PopupClient
+ */
 class SUIT_PopupClient::Signal : public QObject
 {
   Q_OBJECT
diff --git a/src/SUIT/SUIT_SelectionFilter.cxx b/src/SUIT/SUIT_SelectionFilter.cxx
index 51da3d0aa..dbc4ab1a8 100644
--- a/src/SUIT/SUIT_SelectionFilter.cxx
+++ b/src/SUIT/SUIT_SelectionFilter.cxx
@@ -1,9 +1,10 @@
 #include "SUIT_SelectionFilter.h"
 
+/*! constructor. do nothing*/
 SUIT_SelectionFilter::SUIT_SelectionFilter()
 {
 }
-
+/*! destructor. do nothing*/
 SUIT_SelectionFilter::~SUIT_SelectionFilter()
 {
 }
diff --git a/src/SUIT/SUIT_SelectionFilter.h b/src/SUIT/SUIT_SelectionFilter.h
index 301d6072a..2ac906c8a 100644
--- a/src/SUIT/SUIT_SelectionFilter.h
+++ b/src/SUIT/SUIT_SelectionFilter.h
@@ -5,6 +5,7 @@
 
 class SUIT_DataOwner;
 
+/*!Base class.*/
 class SUIT_EXPORT SUIT_SelectionFilter
 {
 public:
diff --git a/src/SUIT/SUIT_SelectionMgr.cxx b/src/SUIT/SUIT_SelectionMgr.cxx
index 6384d2bd3..6711e5797 100755
--- a/src/SUIT/SUIT_SelectionMgr.cxx
+++ b/src/SUIT/SUIT_SelectionMgr.cxx
@@ -1,11 +1,13 @@
 #include "SUIT_SelectionMgr.h"
 
+/*!constructor. initialize myIterations and myIsSelChangeEnabled.*/
 SUIT_SelectionMgr::SUIT_SelectionMgr( const bool Feedback )
 : myIterations( Feedback ? 1 : 0 ),
 myIsSelChangeEnabled( true )
 {
 }
 
+/*!destructor. mySelectors auto delete.*/
 SUIT_SelectionMgr::~SUIT_SelectionMgr()
 {
   mySelectors.setAutoDelete( true );
diff --git a/src/SUIT/SUIT_Session.cxx b/src/SUIT/SUIT_Session.cxx
index d47b8d3e3..a9db903d0 100755
--- a/src/SUIT/SUIT_Session.cxx
+++ b/src/SUIT/SUIT_Session.cxx
@@ -19,6 +19,8 @@
 
 SUIT_Session* SUIT_Session::mySession = 0;
 
+/*! Constructor.*/
+
 SUIT_Session::SUIT_Session()
 : QObject(),
 myResMgr( 0 ),
@@ -33,6 +35,7 @@ myExitStatus( FROM_GUI )
   myAppList.setAutoDelete( true );
 }
 
+/*!destructor. Clear applications list and set mySession to zero.*/
 SUIT_Session::~SUIT_Session()
 {
   myAppList.clear();
@@ -40,6 +43,7 @@ SUIT_Session::~SUIT_Session()
   mySession = 0;
 }
 
+/*! \retval return mySession */
 SUIT_Session* SUIT_Session::session()
 {
   return mySession;
@@ -226,11 +230,13 @@ void SUIT_Session::closeSession( int mode )
   }
 }
 
+/*! \retval return myHandler*/
 SUIT_ExceptionHandler* SUIT_Session::handler() const
 {
   return myHandler;
 }
 
+/*! \retval return last error string.*/
 QString SUIT_Session::lastError() const
 {
   QString str;
@@ -246,6 +252,9 @@ QString SUIT_Session::lastError() const
   return str;
 }
 
+/*! Load library to session.
+ * \retval Loaded library.
+ */
 SUIT_Session::AppLib SUIT_Session::loadLibrary( const QString& name )
 {
   QString libFile = SUIT_Tools::library( name );
@@ -262,6 +271,7 @@ SUIT_Session::AppLib SUIT_Session::loadLibrary( const QString& name )
   return lib;
 }
 
+/*! \retval Return file name by application name.*/
 QString SUIT_Session::applicationName( const QString& str ) const
 {
 #ifdef WIN32
diff --git a/src/SUIT/SUIT_Study.cxx b/src/SUIT/SUIT_Study.cxx
index ea157b387..099d24393 100755
--- a/src/SUIT/SUIT_Study.cxx
+++ b/src/SUIT/SUIT_Study.cxx
@@ -68,8 +68,9 @@ void SUIT_Study::closeDocument()
 
 void SUIT_Study::createDocument()
 {
-  // Custom document initialization to be performed
-  // within onNewDoc() handler can be put here
+  /*! Custom document initialization to be performed \n
+   *  within onNewDoc() handler can be put here
+   */
 }
 
 bool SUIT_Study::openDocument( const QString& fileName )
diff --git a/src/SUIT/SUIT_ToolButton.h b/src/SUIT/SUIT_ToolButton.h
index 33a42dcd3..5a0e78430 100755
--- a/src/SUIT/SUIT_ToolButton.h
+++ b/src/SUIT/SUIT_ToolButton.h
@@ -6,14 +6,14 @@
 
 #include "SUIT.h"
 
-// Purpose:   to draw down arrow on toolbutton.
-
+/*! To draw down arrow on toolbutton.*/
 class SUIT_EXPORT SUIT_ToolButton : public QToolButton
 {
   Q_OBJECT
 
 public:
-//constructors
+  /*! @name constructors*/
+  //@{
   SUIT_ToolButton( QWidget *parent = 0, 
                    const char *name = 0,
                    bool changeItemAfterClick = true );
@@ -22,14 +22,15 @@ public:
                     QObject * receiver, const char* slot,
                     QToolBar * parent, const char* name = 0,
                     bool changeItemAfterClick = true );
+  //@}
 
-  //drawButton is redefined to draw DownArrow
+  /*!drawButton is redefined to draw DownArrow*/
   void drawButton( QPainter * pQPainter);
 
-  // Add action into popup
+  /*! Add action into popup*/
   void AddAction(QAction* theAction);
 
-  // Sets myPopup item with theIndex as current
+  /*! Sets myPopup item with theIndex as current*/
   void SetItem(int theIndex);
 
 public slots:
diff --git a/src/SUIT/SUIT_ViewManager.cxx b/src/SUIT/SUIT_ViewManager.cxx
index cab5a470b..619881571 100755
--- a/src/SUIT/SUIT_ViewManager.cxx
+++ b/src/SUIT/SUIT_ViewManager.cxx
@@ -214,7 +214,7 @@ void SUIT_ViewManager::onDeleteStudy()
 //***************************************************************
 void SUIT_ViewManager::onContextMenuRequested( QContextMenuEvent* e )
 {
-  // invoke method of SUIT_PopupClient, which notifies about popup
+  /*! invoke method of SUIT_PopupClient, which notifies about popup*/
   contextMenuRequest( e );
 }
 
diff --git a/src/SUIT/SUIT_ViewManager.h b/src/SUIT/SUIT_ViewManager.h
index e94077fd9..8370b7d5b 100755
--- a/src/SUIT/SUIT_ViewManager.h
+++ b/src/SUIT/SUIT_ViewManager.h
@@ -44,7 +44,7 @@ public:
   QString          getTitle() const { return myTitle;}
   void             setTitle(QString theTitle) { myTitle = theTitle; }
 
-  //! Creates View, adds it into list of views and returns just created view window
+  /*! Creates View, adds it into list of views and returns just created view window*/
   SUIT_ViewWindow* createViewWindow();
 
 public slots:
@@ -74,20 +74,15 @@ private slots:
   void             onContextMenuRequested( QContextMenuEvent* e );
   
 protected:
-  /*!
-  Inserts the View into internal Views Vector.
-  Returns true if view has been added successfully
-  */
+  /*! Inserts the View into internal Views Vector.\n
+   *  Returns true if view has been added successfully
+   */
   virtual bool     insertView(SUIT_ViewWindow* theView);
   
-  /*!
-  Removes the View from internal Views Vector.
-  */
+  /*! Removes the View from internal Views Vector.*/
   virtual void     removeView(SUIT_ViewWindow* theView);
   
-  /*
-  Used to set unique name for the view
-  */
+  /*! Used to set unique name for the view.*/
   virtual void     setViewName(SUIT_ViewWindow* theView);
 
 protected:
diff --git a/src/SUIT/SUIT_ViewModel.h b/src/SUIT/SUIT_ViewModel.h
index c00bf0796..82af77687 100755
--- a/src/SUIT/SUIT_ViewModel.h
+++ b/src/SUIT/SUIT_ViewModel.h
@@ -10,11 +10,11 @@
 #include <qcursor.h>
 
 /*!
-	This object manages the definition and behaviour of a View Window. 
-	In case of definition of this object in an external lib that lib must 
-	have an exported function "createViewModel" which returns newly created 
-	instance of SUIT_ViewModel.
-*/
+ * This object manages the definition and behaviour of a View Window. \n
+ * In case of definition of this object in an external lib that lib must \n
+ * have an exported function "createViewModel" which returns newly created \n
+ * instance of SUIT_ViewModel.
+ */
 
 #ifdef WIN32
 #pragma warning( disable:4251 )