Salome HOME
Update comments
authorenk <enk@opencascade.com>
Tue, 26 Jul 2005 12:50:32 +0000 (12:50 +0000)
committerenk <enk@opencascade.com>
Tue, 26 Jul 2005 12:50:32 +0000 (12:50 +0000)
42 files changed:
src/SalomeApp/SalomeApp_Application.cxx
src/SalomeApp/SalomeApp_CheckFileDlg.cxx
src/SalomeApp/SalomeApp_DataModel.cxx
src/SalomeApp/SalomeApp_DataModel.h
src/SalomeApp/SalomeApp_DataObject.cxx
src/SalomeApp/SalomeApp_DataObject.h
src/SalomeApp/SalomeApp_DataOwner.cxx
src/SalomeApp/SalomeApp_DataOwner.h
src/SalomeApp/SalomeApp_DataSubOwner.cxx
src/SalomeApp/SalomeApp_DataSubOwner.h
src/SalomeApp/SalomeApp_EventFilter.cxx
src/SalomeApp/SalomeApp_EventFilter.h
src/SalomeApp/SalomeApp_ExceptionHandler.cxx
src/SalomeApp/SalomeApp_Filter.cxx
src/SalomeApp/SalomeApp_GLSelector.cxx
src/SalomeApp/SalomeApp_ImportOperation.cxx
src/SalomeApp/SalomeApp_ListView.cxx
src/SalomeApp/SalomeApp_Module.cxx
src/SalomeApp/SalomeApp_Module.h
src/SalomeApp/SalomeApp_ModuleDlg.cxx
src/SalomeApp/SalomeApp_NameDlg.h
src/SalomeApp/SalomeApp_OBFilter.cxx
src/SalomeApp/SalomeApp_OBSelector.cxx
src/SalomeApp/SalomeApp_OBSelector.h
src/SalomeApp/SalomeApp_OCCSelector.cxx
src/SalomeApp/SalomeApp_Preferences.cxx
src/SalomeApp/SalomeApp_PreferencesDlg.cxx
src/SalomeApp/SalomeApp_PreferencesDlg.h
src/SalomeApp/SalomeApp_PyInterp.cxx
src/SalomeApp/SalomeApp_Selection.cxx
src/SalomeApp/SalomeApp_Selection.h
src/SalomeApp/SalomeApp_SelectionMgr.cxx
src/SalomeApp/SalomeApp_Study.cxx
src/SalomeApp/SalomeApp_StudyPropertiesDlg.cxx
src/SalomeApp/SalomeApp_Tools.cxx
src/SalomeApp/SalomeApp_Tools.h
src/SalomeApp/SalomeApp_TypeFilter.cxx
src/SalomeApp/SalomeApp_TypeFilter.h
src/SalomeApp/SalomeApp_VTKSelector.cxx
src/SalomeApp/SalomeApp_VTKSelector.h
src/SalomeApp/SalomeApp_WidgetContainer.cxx
src/SalomeApp/SalomeApp_WidgetContainer.h

index f0341870936d972e47417afce84ba12b00df6d19..3d89aae00b06bed2da2e30bf2f9aba5fcfaa9151 100644 (file)
@@ -749,7 +749,7 @@ bool SalomeApp_Application::useStudy(const QString& theName)
 }
 
 /*!Set active study.
- *\param stupa - SUIT_Study.
+ *\param study - SUIT_Study.
  */
 void SalomeApp_Application::setActiveStudy( SUIT_Study* study )
 {
@@ -926,7 +926,7 @@ QWidget* SalomeApp_Application::getWindow( const int flag, const int studyId )
   return wid;
 }
 
-/*!Check*/
+/*!Check is window visible?(with identificator \a type)*/
 bool SalomeApp_Application::isWindowVisible( const int type ) const
 {
   bool res = false;
@@ -938,6 +938,10 @@ bool SalomeApp_Application::isWindowVisible( const int type ) const
   return res;
 }
 
+/*!Sets window show or hide.
+ *\param type - window identificator.
+ *\param on   - true/false (window show/hide)
+ */
 void SalomeApp_Application::setWindowShown( const int type, const bool on )
 {
   if ( !desktop() || !myWindows.contains( type ) )
@@ -957,6 +961,7 @@ OB_Browser* SalomeApp_Application::objectBrowser()
   return ob;
 }
 
+/*!Gets "LogWindow".*/
 LogWindow* SalomeApp_Application::logWindow()
 {
   LogWindow* lw = 0;
@@ -966,6 +971,7 @@ LogWindow* SalomeApp_Application::logWindow()
   return lw;
 }
 
+/*!Get "PythonConsole"*/
 PythonConsole* SalomeApp_Application::pythonConsole()
 {
   PythonConsole* console = 0;
@@ -975,11 +981,13 @@ PythonConsole* SalomeApp_Application::pythonConsole()
   return console;
 }
 
+/*!Gets preferences.*/
 SalomeApp_Preferences* SalomeApp_Application::preferences() const
 {
   return preferences( false );
 }
 
+/*!Gets view manager*/
 SUIT_ViewManager* SalomeApp_Application::getViewManager( const QString& vmType, const bool create )
 {
   SUIT_ViewManager* aVM = viewManager( vmType );
@@ -1001,6 +1009,7 @@ SUIT_ViewManager* SalomeApp_Application::getViewManager( const QString& vmType,
   return aVM;
 }
 
+/*!Create view manager.*/
 SUIT_ViewManager* SalomeApp_Application::createViewManager( const QString& vmType )
 {
   SUIT_ResourceMgr* resMgr = resourceMgr();
@@ -1059,6 +1068,7 @@ void SalomeApp_Application::onCloseView( SUIT_ViewManager* theVM )
   removeViewManager( theVM );
 }
 
+/*!Private SLOT. On study created.*/
 void SalomeApp_Application::onStudyCreated( SUIT_Study* theStudy )
 {
   SUIT_DataObject* aRoot = 0;
@@ -1075,6 +1085,7 @@ void SalomeApp_Application::onStudyCreated( SUIT_Study* theStudy )
   activateWindows();
 }
 
+/*!Private SLOT. On study opened.*/
 void SalomeApp_Application::onStudyOpened( SUIT_Study* theStudy )
 {
   SUIT_DataObject* aRoot = 0;
@@ -1099,6 +1110,7 @@ void SalomeApp_Application::onStudySaved( SUIT_Study* )
   emit studySaved();
 }
 
+/*!Private SLOT. On study closed.*/
 void SalomeApp_Application::onStudyClosed( SUIT_Study* )
 {
   emit studyClosed();
@@ -1108,6 +1120,7 @@ void SalomeApp_Application::onStudyClosed( SUIT_Study* )
   saveWindowsGeometry();
 }
 
+/*!Private SLOT. On dump study.*/
 void SalomeApp_Application::onDumpStudy( )
 {
   SalomeApp_Study* appStudy = dynamic_cast<SalomeApp_Study*>( activeStudy() );
@@ -1132,6 +1145,7 @@ void SalomeApp_Application::onDumpStudy( )
   }
 }
 
+/*!Private SLOT. On load script.*/
 void SalomeApp_Application::onLoadScript( )
 {
   SalomeApp_Study* appStudy = dynamic_cast<SalomeApp_Study*>( activeStudy() );
@@ -1163,6 +1177,7 @@ void SalomeApp_Application::onLoadScript( )
   }
 }
 
+/*!Private SLOT. On preferences.*/
 void SalomeApp_Application::onPreferences()
 {
   QApplication::setOverrideCursor( Qt::waitCursor );
@@ -1179,11 +1194,13 @@ void SalomeApp_Application::onPreferences()
   delete prefDlg;
 }
 
+/*!Private SLOT. On open document with name \a aName.*/
 void SalomeApp_Application::onMRUActivated( QString aName )
 {
   onOpenDoc( aName );
 }
 
+/*!Private SLOT. On preferences changed.*/
 void SalomeApp_Application::onPreferenceChanged( QString& modName, QString& section, QString& param )
 {
   SalomeApp_Module* sMod = 0;
@@ -1197,11 +1214,15 @@ void SalomeApp_Application::onPreferenceChanged( QString& modName, QString& sect
     preferencesChanged( section, param );
 }
 
+/*!Gets file filter.
+ *\retval QString "(*.hdf)"
+ */
 QString SalomeApp_Application::getFileFilter() const
 {
   return "(*.hdf)";
 }
 
+/*!Remove all windows from study.*/
 void SalomeApp_Application::beforeCloseDoc( SUIT_Study* s )
 {
   CAM_Application::beforeCloseDoc( s );
@@ -1210,11 +1231,13 @@ void SalomeApp_Application::beforeCloseDoc( SUIT_Study* s )
     removeWindow( itr.key(), s->id() );
 }
 
+/*!Update actions.*/
 void SalomeApp_Application::updateActions()
 {
   updateCommandsStatus();
 }
 
+/*!Create window.*/
 QWidget* SalomeApp_Application::createWindow( const int flag )
 {
   QWidget* wid = 0;
@@ -1269,6 +1292,9 @@ QWidget* SalomeApp_Application::createWindow( const int flag )
   return wid;
 }
 
+/*!Default windows(Object Browser, Python Console).
+ * Adds to map \a aMap.
+ */
 void SalomeApp_Application::defaultWindows( QMap<int, int>& aMap ) const
 {
   aMap.insert( WT_ObjectBrowser, Qt::DockLeft );
@@ -1276,10 +1302,15 @@ void SalomeApp_Application::defaultWindows( QMap<int, int>& aMap ) const
   //  aMap.insert( WT_LogWindow, Qt::DockBottom );
 }
 
+/*!Default view manager.*/
 void SalomeApp_Application::defaultViewManagers( QStringList& ) const
 {
+  /*!Do nothing.*/
 }
 
+/*!Gets preferences.
+ * Create preferences, if \a crt = true.
+ */
 SalomeApp_Preferences* SalomeApp_Application::preferences( const bool crt ) const
 {
   if ( myPrefs )
@@ -1334,6 +1365,7 @@ SalomeApp_Preferences* SalomeApp_Application::preferences( const bool crt ) cons
   return myPrefs;
 }
 
+/*!Add new module to application.*/
 void SalomeApp_Application::moduleAdded( CAM_Module* mod )
 {
   CAM_Application::moduleAdded( mod );
@@ -1350,6 +1382,7 @@ void SalomeApp_Application::moduleAdded( CAM_Module* mod )
   }
 }
 
+/*!Create preferences.*/
 void SalomeApp_Application::createPreferences( SalomeApp_Preferences* pref )
 {
   if ( !pref )
@@ -1509,6 +1542,7 @@ void SalomeApp_Application::preferencesChanged( const QString& sec, const QStrin
   }
 }
 
+/*!Update desktop title.*/
 void SalomeApp_Application::updateDesktopTitle() {
   QString aTitle = applicationName();
   QString aVer = applicationVersion();
@@ -1534,6 +1568,7 @@ void SalomeApp_Application::updateDesktopTitle() {
   desktop()->setCaption( aTitle );
 }
 
+/*!Update windows after close document.*/
 void SalomeApp_Application::afterCloseDoc()
 {
   updateWindows();
@@ -1541,6 +1576,7 @@ void SalomeApp_Application::afterCloseDoc()
   CAM_Application::afterCloseDoc();
 }
 
+/*!Gets CORBA::ORB_var*/
 CORBA::ORB_var SalomeApp_Application::orb()
 {
   ORB_INIT& init = *SINGLETON_<ORB_INIT>::Instance();
@@ -1548,18 +1584,21 @@ CORBA::ORB_var SalomeApp_Application::orb()
   return _orb;
 }
 
+/*!Create and return SALOMEDS_StudyManager.*/
 SALOMEDSClient_StudyManager* SalomeApp_Application::studyMgr()
 {
   static SALOMEDSClient_StudyManager* _sm = new SALOMEDS_StudyManager();
   return _sm;
 }
 
+/*!Create and return SALOME_NamingService.*/
 SALOME_NamingService* SalomeApp_Application::namingService()
 {
   static SALOME_NamingService* _ns = new SALOME_NamingService( orb() );
   return _ns;
 }
 
+/*!Create and return SALOME_LifeCycleCORBA.*/
 SALOME_LifeCycleCORBA* SalomeApp_Application::lcc()
 {
   static SALOME_LifeCycleCORBA* _lcc = new SALOME_LifeCycleCORBA( namingService() );
@@ -1568,7 +1607,7 @@ SALOME_LifeCycleCORBA* SalomeApp_Application::lcc()
 
 QString SalomeApp_Application::defaultEngineIOR()
 {
-  // Look for a default module engine (needed for CORBAless modules to use SALOMEDS persistence)
+  /// Look for a default module engine (needed for CORBAless modules to use SALOMEDS persistence)
   QString anIOR( "" );
   CORBA::Object_ptr anEngine = namingService()->Resolve( "/SalomeAppEngine" );
   if ( !CORBA::is_nil( anEngine ) )
@@ -1576,6 +1615,7 @@ QString SalomeApp_Application::defaultEngineIOR()
   return anIOR;
 }
 
+/*!Adds icon names for modules.*/
 void SalomeApp_Application::moduleIconNames( QMap<QString, QString>& iconMap ) const
 {
   iconMap.clear();
@@ -1603,6 +1643,7 @@ void SalomeApp_Application::moduleIconNames( QMap<QString, QString>& iconMap ) c
   }
 }
 
+/*!Update module action.*/
 void SalomeApp_Application::updateModuleActions()
 {
   QString modName;
@@ -1613,6 +1654,9 @@ void SalomeApp_Application::updateModuleActions()
     myActions[modName]->setOn( true );
 }
 
+/*!Gets current windows.
+ *\param winMap - output current windows map.
+ */
 void SalomeApp_Application::currentWindows( QMap<int, int>& winMap ) const
 {
   winMap.clear();
@@ -1625,6 +1669,9 @@ void SalomeApp_Application::currentWindows( QMap<int, int>& winMap ) const
     defaultWindows( winMap );
 }
 
+/*!Gets current view managers.
+ *\param lst - output current view managers list.
+ */
 void SalomeApp_Application::currentViewManagers( QStringList& lst ) const
 {
   lst.clear();
@@ -1637,6 +1684,7 @@ void SalomeApp_Application::currentViewManagers( QStringList& lst ) const
     defaultViewManagers( lst );
 }
 
+/*!Update windows.*/
 void SalomeApp_Application::updateWindows()
 {
   QMap<int, int> winMap;
@@ -1651,6 +1699,7 @@ void SalomeApp_Application::updateWindows()
     setWindowShown( itr.key(), !itr.data()->isEmpty() && winMap.contains( itr.key() ) );
 }
 
+/*!Update view managers.*/
 void SalomeApp_Application::updateViewManagers()
 {
   QStringList lst;
@@ -1660,6 +1709,7 @@ void SalomeApp_Application::updateViewManagers()
     getViewManager( *it, true );
 }
 
+/*!Load windows geometry.*/
 void SalomeApp_Application::loadWindowsGeometry()
 {
   QtxDockAction* dockMgr = 0;
@@ -1683,6 +1733,7 @@ void SalomeApp_Application::loadWindowsGeometry()
   dockMgr->restoreGeometry();
 }
 
+/*!Save windows geometry.*/
 void SalomeApp_Application::saveWindowsGeometry()
 {
   QtxDockAction* dockMgr = 0;
@@ -1706,6 +1757,7 @@ void SalomeApp_Application::saveWindowsGeometry()
   dockMgr->saveGeometry( resourceMgr(), section, false );
 }
 
+/*!Activate windows.*/
 void SalomeApp_Application::activateWindows()
 {
   if ( activeStudy() )
@@ -1715,6 +1767,7 @@ void SalomeApp_Application::activateWindows()
   }
 }
 
+/*!Private SLOT. On preferences.*/
 void SalomeApp_Application::onProperties()
 {
   SalomeApp_Study* study = dynamic_cast<SalomeApp_Study*>( activeStudy() );
@@ -1735,6 +1788,7 @@ void SalomeApp_Application::onProperties()
   updateDesktopTitle();
 }
 
+/*!*/
 QString SalomeApp_Application::getFileName( bool open, const QString& initial, const QString& filters, 
                                            const QString& caption, QWidget* parent )
 {
@@ -1744,6 +1798,7 @@ QString SalomeApp_Application::getFileName( bool open, const QString& initial, c
   return SUIT_FileDlg::getFileName( parent, initial, fls, caption, open, true );
 }
 
+/*!*/
 QString SalomeApp_Application::getDirectory( const QString& initial, const QString& caption, QWidget* parent )
 {
   if ( !parent )
@@ -1751,6 +1806,7 @@ QString SalomeApp_Application::getDirectory( const QString& initial, const QStri
   return SUIT_FileDlg::getExistingDirectory( parent, initial, caption, true );
 }
 
+/*!*/
 QStringList SalomeApp_Application::getOpenFileNames( const QString& initial, const QString& filters, 
                                                     const QString& caption, QWidget* parent )
 {
@@ -1760,6 +1816,7 @@ QStringList SalomeApp_Application::getOpenFileNames( const QString& initial, con
   return SUIT_FileDlg::getOpenFileNames( parent, initial, fls, caption, true );
 }
 
+/*!*/
 void SalomeApp_Application::contextMenuPopup( const QString& type, QPopupMenu* thePopup, QString& title )
 {
   CAM_Application::contextMenuPopup( type, thePopup, title );
@@ -1784,6 +1841,7 @@ void SalomeApp_Application::contextMenuPopup( const QString& type, QPopupMenu* t
   thePopup->insertItem( tr( "MEN_OPENWITH" ), this, SLOT( onOpenWith() ) );
 }
 
+/*!Update obect browser*/
 void SalomeApp_Application::updateObjectBrowser( const bool updateModels )
 {
   // update existing data models (already loaded SComponents)
@@ -1822,8 +1880,7 @@ void SalomeApp_Application::updateObjectBrowser( const bool updateModels )
   }
 }
 
-
-//************************************************************
+/*!Protected SLOT.On desktop activated.*/
 void SalomeApp_Application::onDesktopActivated()
 {
   CAM_Application::onDesktopActivated();
@@ -1832,6 +1889,7 @@ void SalomeApp_Application::onDesktopActivated()
     aModule->studyActivated();
 }
 
+/*!Create empty study.*/
 void SalomeApp_Application::createEmptyStudy()
 {
   CAM_Application::createEmptyStudy();
@@ -1839,6 +1897,7 @@ void SalomeApp_Application::createEmptyStudy()
     objectBrowser()->updateTree();
 }
 
+/*!Activate module \a mod.*/
 bool SalomeApp_Application::activateModule( CAM_Module* mod )
 {
   bool res = CAM_Application::activateModule( mod );
index 32ebeea3bcd32b440b702b132b03ddf1353cb6c5..288ba7079ecf9a8bca0237b629f28ae646946258 100644 (file)
@@ -25,11 +25,15 @@ SalomeApp_CheckFileDlg::~SalomeApp_CheckFileDlg()
 
 }
 
+/*!Sets checked.*/
 void SalomeApp_CheckFileDlg::SetChecked( bool check )
 {
   myCheckBox->setChecked(check);
 }
 
+/*!Is checked?
+ *\retval boolean - true, check box is checked, else false.
+ */
 bool SalomeApp_CheckFileDlg::IsChecked() const
 {
   return myCheckBox->isChecked();
index 1d771e2c64cd96249256d87d51eb2f7f40adf2c2..13c08038e05a96c9870ac3442c23a55399e3fbf3 100644 (file)
@@ -25,8 +25,9 @@
 
 //=======================================================================
 // name    : BuildTree
-// Purpose : static method used by SalomeApp_Study and SalomeApp_DataModel classes
-//           to create default SALOMEDS-based data object tree
+/*!Purpose : static method used by SalomeApp_Study and SalomeApp_DataModel classes
+ *           to create default SALOMEDS-based data object tree
+ */
 //=======================================================================
 SUIT_DataObject* SalomeApp_DataModel::BuildTree( const _PTR(SObject)& obj,
                                                 SUIT_DataObject* parent,
@@ -84,7 +85,7 @@ SUIT_DataObject* SalomeApp_DataModel::BuildTree( const _PTR(SObject)& obj,
 
 //=======================================================================
 // name    : SalomeApp_DataModel::SalomeApp_DataModel
-// Purpose : Constructor
+/*!Purpose : Constructor*/
 //=======================================================================
 SalomeApp_DataModel::SalomeApp_DataModel( CAM_Module* theModule )
 : CAM_DataModel( theModule )
@@ -93,7 +94,7 @@ SalomeApp_DataModel::SalomeApp_DataModel( CAM_Module* theModule )
 
 //=======================================================================
 // name    : SalomeApp_DataModel::~SalomeApp_DataModel
-// Purpose : Destructor
+/*! Purpose : Destructor*/
 //=======================================================================
 SalomeApp_DataModel::~SalomeApp_DataModel()
 {
@@ -101,7 +102,7 @@ SalomeApp_DataModel::~SalomeApp_DataModel()
 
 //================================================================
 // Function : open
-// Purpose  :
+/*! Purpose  : Open data model*/
 //================================================================
 bool SalomeApp_DataModel::open( const QString&, CAM_Study* study )
 {
@@ -154,7 +155,7 @@ bool SalomeApp_DataModel::open( const QString&, CAM_Study* study )
 
 //================================================================
 // Function : save
-// Purpose  :
+/*! Purpose  : Emit saved()*/
 //================================================================
 bool SalomeApp_DataModel::save()
 {
@@ -164,7 +165,7 @@ bool SalomeApp_DataModel::save()
 
 //================================================================
 // Function : saveAs
-// Purpose  :
+/*! Purpose  : Emit saved() */
 //================================================================
 bool SalomeApp_DataModel::saveAs( const QString&, CAM_Study* )
 {
@@ -174,7 +175,7 @@ bool SalomeApp_DataModel::saveAs( const QString&, CAM_Study* )
 
 //================================================================
 // Function : close
-// Purpose  :
+/*! Purpose  : Emit closed()*/
 //================================================================
 bool SalomeApp_DataModel::close()
 {
@@ -184,7 +185,7 @@ bool SalomeApp_DataModel::close()
 
 //================================================================
 // Function : update
-// Purpose  :
+/*! Purpose  : Update application.*/
 //================================================================
 void SalomeApp_DataModel::update( SalomeApp_DataObject*, SalomeApp_Study* study )
 {
@@ -217,7 +218,7 @@ void SalomeApp_DataModel::update( SalomeApp_DataObject*, SalomeApp_Study* study
 
 //================================================================
 // Function : buildTree
-// Purpose  : private method
+/*! Purpose  : private method, build tree.*/
 //================================================================
 void SalomeApp_DataModel::buildTree( const _PTR(SObject)& obj,
                                     SUIT_DataObject* parent,
@@ -236,7 +237,7 @@ void SalomeApp_DataModel::buildTree( const _PTR(SObject)& obj,
 
 //================================================================
 // Function : getModule
-// Purpose  :
+/*! Purpose  : gets module*/
 //================================================================
 
 SalomeApp_Module* SalomeApp_DataModel::getModule() const
@@ -246,7 +247,7 @@ SalomeApp_Module* SalomeApp_DataModel::getModule() const
 
 //================================================================
 // Function : getStudy
-// Purpose  :
+/*! Purpose  : gets study */
 //================================================================
 SalomeApp_Study* SalomeApp_DataModel::getStudy() const
 {
@@ -258,7 +259,7 @@ SalomeApp_Study* SalomeApp_DataModel::getStudy() const
 
 //================================================================
 // Function : getRootEntry
-// Purpose  : returns study entry corresponding to this data model
+/*! Purpose  : returns study entry corresponding to this data model*/
 //================================================================
 QString SalomeApp_DataModel::getRootEntry( SalomeApp_Study* study ) const
 {
@@ -278,7 +279,7 @@ QString SalomeApp_DataModel::getRootEntry( SalomeApp_Study* study ) const
 
 //================================================================
 // Function : isModified
-// Purpose  : default implementation, always returns false so as not to mask study's isModified()
+/*! Purpose  : default implementation, always returns false so as not to mask study's isModified()*/
 //================================================================
 bool SalomeApp_DataModel::isModified() const
 {
@@ -287,7 +288,7 @@ bool SalomeApp_DataModel::isModified() const
 
 //================================================================
 // Function : isSaved
-// Purpose  : default implementation, always returns true so as not to mask study's isSaved()
+/*! Purpose  : default implementation, always returns true so as not to mask study's isSaved()*/
 //================================================================
 bool SalomeApp_DataModel::isSaved() const
 {
@@ -298,7 +299,7 @@ bool SalomeApp_DataModel::isSaved() const
 
 //================================================================
 // Function : GetListOfFiles
-// Purpose  : to be used by CORBAless modules
+/*! Purpose  : to be used by CORBAless modules*/
 //================================================================
 std::vector<std::string> SalomeApp_DataModel::GetListOfFiles() const
        //(const int theStudyId, const char* theComponentName) const
@@ -318,7 +319,7 @@ std::vector<std::string> SalomeApp_DataModel::GetListOfFiles() const
 
 //================================================================
 // Function : SetListOfFiles
-// Purpose  : to be used by CORBAless modules
+/*! Purpose  : to be used by CORBAless modules*/
 //================================================================
 void SalomeApp_DataModel::SetListOfFiles (const std::vector<std::string> theListOfFiles)
      //(const std::vector<std::string> theListOfFiles,
@@ -337,7 +338,7 @@ void SalomeApp_DataModel::SetListOfFiles (const std::vector<std::string> theList
 
 //================================================================
 // Function : GetTmpDir
-// Purpose  : Static method. To be used by CORBAless modules
+/*! Purpose  : Static method. To be used by CORBAless modules*/
 //================================================================
 std::string SalomeApp_DataModel::GetTmpDir (const char* theURL,
                                             const bool  isMultiFile)
@@ -349,7 +350,7 @@ std::string SalomeApp_DataModel::GetTmpDir (const char* theURL,
 
 //================================================================
 // Function : RemoveTemporaryFiles
-// Purpose  : to be used by CORBAless modules
+/*! Purpose  : to be used by CORBAless modules*/
 //================================================================
 void SalomeApp_DataModel::RemoveTemporaryFiles (const bool isMultiFile) const
 {
index f09aecfcc06a2710446ac56cefc8352cc2a80cdf..3f7d5f6640a15cfe01092401e848eac3f0b1ba79 100644 (file)
 
 #include "SALOMEDSClient.hxx"
 
-/*
-  Class       : SalomeApp_DataModel
-  Description : Base class of data model
-*/
-
 class SalomeApp_Module;
 class SalomeApp_Study;
 class SalomeApp_DataObject;
 class SalomeApp_SelectionMgr;
 
+//   Class       : SalomeApp_DataModel
+///  Description : Base class of data model
 class SALOMEAPP_EXPORT SalomeApp_DataModel : public CAM_DataModel
 {
   Q_OBJECT
@@ -38,7 +35,8 @@ public:
                                       SalomeApp_DataModel ( CAM_Module* theModule );
   virtual                             ~SalomeApp_DataModel();
 
-  // These methods should be redefined in successors.
+  /** @name These methods should be redefined in successors.*/
+  //@{
   virtual bool                        open( const QString&, CAM_Study* );
   virtual bool                        save();
   virtual bool                        saveAs( const QString&, CAM_Study* );
@@ -48,6 +46,7 @@ public:
 
   virtual bool                        isModified() const;
   virtual bool                        isSaved()  const;
+  //@}
 
 signals:
   void                                opened();
@@ -60,7 +59,8 @@ protected:
 
   virtual void                        buildTree(const _PTR(SObject)&, SUIT_DataObject*, SalomeApp_Study* );
 
-  // BEGIN: methods to be used by CORBAless modules
+  /** @name methods to be used by CORBAless modules*/
+  //@{
   std::vector<std::string>            GetListOfFiles () const;
   void                                SetListOfFiles (const std::vector<std::string> theListOfFiles);
 
@@ -68,6 +68,7 @@ protected:
                                                 const bool  isMultiFile);
 
   void                                RemoveTemporaryFiles (const bool isMultiFile) const;
+  //@}
   // END: methods to be used by CORBAless modules
 
 private:
index 1f20285bd16394d81a7bf20b6816081a632bf9a2..70e0e154662cf0cfbee894898f22bcbc287d131a 100644 (file)
@@ -19,7 +19,6 @@
        Class: SalomeApp_DataObject::Key
        Level: Internal
 */
-
 class SalomeApp_DataObject::Key : public SUIT_DataObjectKey
 {
 public:
@@ -33,48 +32,57 @@ private:
   QString myEntry;
 };
 
+/*!Constructor. Initialize by \a entry.*/
 SalomeApp_DataObject::Key::Key( const QString& entry )
 : SUIT_DataObjectKey(),
   myEntry( entry )
 {
 }
 
+/*!Destructor. Do nothing.*/
 SalomeApp_DataObject::Key::~Key()
 {
 }
 
+/*!Checks: Is current key less than \a other.*/
 bool SalomeApp_DataObject::Key::isLess( const SUIT_DataObjectKey* other ) const
 {
   Key* that = (Key*)other;
   return myEntry < that->myEntry;
 }
 
+/*!Checks: Is current key equal with \a other.*/
 bool SalomeApp_DataObject::Key::isEqual( const SUIT_DataObjectKey* other ) const
 {
   Key* that = (Key*)other;
   return myEntry == that->myEntry;
 }
 
-/*!
+/*
        Class: SalomeApp_DataObject
        Level: Public
 */
-
+/*!Constructor. Initialize by \a parent*/
 SalomeApp_DataObject::SalomeApp_DataObject( SUIT_DataObject* parent )
 : CAM_DataObject( parent )
 {
 }
 
+/*!Constructor. Initialize by \a parent and SObject*/
 SalomeApp_DataObject::SalomeApp_DataObject( const _PTR(SObject)& sobj, SUIT_DataObject* parent )
 : CAM_DataObject( parent )
 {
   myObject = sobj;
 }
 
+/*!Destructor. Do nothing.*/
 SalomeApp_DataObject::~SalomeApp_DataObject()
 {
 }
 
+/*!Gets object ID.
+ *\retval QString
+ */
 QString SalomeApp_DataObject::entry() const
 {
   if ( myObject )
@@ -82,12 +90,14 @@ QString SalomeApp_DataObject::entry() const
   return QString::null;
 }
 
+/*!Create and return new key object.*/
 SUIT_DataObjectKey* SalomeApp_DataObject::key() const
 {
   QString str = entry();
   return new Key( str );
 }
 
+/*!Gets name of object.*/
 QString SalomeApp_DataObject::name() const
 {
   QString str;
@@ -108,6 +118,7 @@ QString SalomeApp_DataObject::name() const
   return str;
 }
 
+/*!Gets icon picture of object.*/
 QPixmap SalomeApp_DataObject::icon() const
 {
   _PTR(GenericAttribute) anAttr;
@@ -125,6 +136,12 @@ QPixmap SalomeApp_DataObject::icon() const
   return QPixmap();
 }
 
+/*!Gets text value for one of entity:
+ *\li Value           (id = SalomeApp_DataObject::CT_Value)
+ *\li Entry           (id = SalomeApp_DataObject::CT_Entry)
+ *\li IOR             (id = SalomeApp_DataObject::CT_IOR)
+ *\li Reference entry (id = SalomeApp_DataObject::CT_RefEntry)
+ */
 QString SalomeApp_DataObject::text( const int id ) const
 {
   QString txt;
@@ -148,6 +165,11 @@ QString SalomeApp_DataObject::text( const int id ) const
   return txt;
 }
 
+/*!Get color value for one of entity:
+ *\li Text color
+ *\li Highlight color
+ *\li Higlighted text color
+ */
 QColor SalomeApp_DataObject::color( const ColorRole cr ) const
 {
   QColor clr;
@@ -178,12 +200,16 @@ QColor SalomeApp_DataObject::color( const ColorRole cr ) const
   return clr;
 }
 
+/*!Gets tooltip.*/
 QString SalomeApp_DataObject::toolTip() const
 {
   //return object()->Name();
   return QString( "Object \'%1\', module \'%2\', ID=%3" ).arg( name() ).arg( componentDataType() ).arg( entry() );
 }
 
+/*!Gets component object.
+ *\retval SUIT_DataObject.
+ */
 SUIT_DataObject* SalomeApp_DataObject::componentObject() const
 {
   SUIT_DataObject* compObj = 0;  // for root object (invisible SALOME_ROOT_OBJECT) 
@@ -200,6 +226,7 @@ SUIT_DataObject* SalomeApp_DataObject::componentObject() const
   return compObj;
 }
 
+/*!Get component type.*/
 QString SalomeApp_DataObject::componentDataType() const
 {
   const SalomeApp_DataObject* compObj = dynamic_cast<SalomeApp_DataObject*>( componentObject() );
@@ -213,11 +240,13 @@ QString SalomeApp_DataObject::componentDataType() const
   return "";
 }
 
+/*!Gets object.*/
 _PTR(SObject) SalomeApp_DataObject::object() const
 {
   return myObject;
 }
 
+/*!Checks: Is object reference.*/
 bool SalomeApp_DataObject::isReference() const
 {
   bool isRef = false;
@@ -229,6 +258,7 @@ bool SalomeApp_DataObject::isReference() const
   return isRef;
 }
 
+/*!Gets reference object.*/
 _PTR(SObject) SalomeApp_DataObject::referencedObject() const
 {
   _PTR(SObject) refObj;
@@ -239,6 +269,7 @@ _PTR(SObject) SalomeApp_DataObject::referencedObject() const
   return obj;
 }
 
+/*!Gets IOR*/
 QString SalomeApp_DataObject::ior( const _PTR(SObject)& obj ) const
 {
   QString txt;
@@ -258,6 +289,7 @@ QString SalomeApp_DataObject::ior( const _PTR(SObject)& obj ) const
   return txt;
 }
 
+/*!Gets Entry*/
 QString SalomeApp_DataObject::entry( const _PTR(SObject)& obj ) const
 {
   QString txt;
@@ -269,6 +301,7 @@ QString SalomeApp_DataObject::entry( const _PTR(SObject)& obj ) const
   return txt;
 }
 
+/*!Value*/
 QString SalomeApp_DataObject::value( const _PTR(SObject)& obj ) const
 {
   if ( !obj )
@@ -317,11 +350,12 @@ QString SalomeApp_DataObject::value( const _PTR(SObject)& obj ) const
   return val;
 }
 
-/*!
+/*
        Class: SalomeApp_ModuleObject
        Level: Public
 */
 
+/*!Constructor.Initialize by \a parent.*/
 SalomeApp_ModuleObject::SalomeApp_ModuleObject( SUIT_DataObject* parent )
 : SalomeApp_DataObject( parent ), 
   CAM_RootObject( parent ),
@@ -329,6 +363,7 @@ SalomeApp_ModuleObject::SalomeApp_ModuleObject( SUIT_DataObject* parent )
 {
 }
 
+/*!Constructor.Initialize by \a parent and SObject.*/
 SalomeApp_ModuleObject::SalomeApp_ModuleObject( const _PTR(SObject)& sobj, SUIT_DataObject* parent )
 : SalomeApp_DataObject( sobj, parent ), 
   CAM_RootObject( 0, parent ),
@@ -336,6 +371,7 @@ SalomeApp_ModuleObject::SalomeApp_ModuleObject( const _PTR(SObject)& sobj, SUIT_
 {
 }
 
+/*!Constructor.Initialize by \a parent and CAM_DataModel.*/
 SalomeApp_ModuleObject::SalomeApp_ModuleObject( CAM_DataModel* dm, const _PTR(SObject)& sobj, SUIT_DataObject* parent )
 : SalomeApp_DataObject( sobj, parent ), 
   CAM_RootObject( dm, parent ),
@@ -343,6 +379,7 @@ SalomeApp_ModuleObject::SalomeApp_ModuleObject( CAM_DataModel* dm, const _PTR(SO
 {
 }
 
+/*!Destructor. Do nothing.*/
 SalomeApp_ModuleObject::~SalomeApp_ModuleObject()
 {
 }
index 9077f786d08a8f478c6aea07d77d12b817c6c31e..434f96baa460d827a0aa576e9ccfed5b02c3f681 100644 (file)
@@ -32,13 +32,15 @@ public:
   virtual SUIT_DataObjectKey*     key() const;
   virtual QString                 entry() const;
 
-  virtual _PTR(SObject)           object() const; // location of corresponding SALOMEDS::SObject  
+  /*! location of corresponding SALOMEDS::SObject  */
+  virtual _PTR(SObject)           object() const;
 
   bool                            isReference() const;
   _PTR(SObject)                   referencedObject() const;
 
   SUIT_DataObject*                componentObject() const;
-  QString                         componentDataType() const; // GEOM, SMESH, VISU, etc.
+  /*! GEOM, SMESH, VISU, etc.*/
+  QString                         componentDataType() const;
 
 private:
   QString                         ior( const _PTR(SObject)& ) const;
index a3b6963782cee5066ec421508058cce1921114f5..fe7c6b19f0bb798925d22f2f134092aa1bc2009d 100644 (file)
@@ -8,12 +8,14 @@
 
 #include <iostream.h>
 
+/*!Constructor. Initialize by \a theEntry.*/
 SalomeApp_DataOwner
 ::SalomeApp_DataOwner( const QString& theEntry ): 
   myEntry( theEntry )
 {
 }
 
+/*!Constructor. Initialize by \a SALOME_InteractiveObject.*/
 SalomeApp_DataOwner
 ::SalomeApp_DataOwner( const Handle(SALOME_InteractiveObject)& theIO ):
   myEntry(!theIO.IsNull()? theIO->getEntry(): ""),
@@ -21,11 +23,13 @@ SalomeApp_DataOwner
 {
 }
 
+/*!Destructor. Do nothing.*/
 SalomeApp_DataOwner
 ::~SalomeApp_DataOwner()
 {
 }
 
+/*!Checks: Is current data owner equal \a obj.*/
 bool
 SalomeApp_DataOwner
 ::isEqual( const SUIT_DataOwner& obj ) const
@@ -35,6 +39,7 @@ SalomeApp_DataOwner
   return other && entry() == other->entry();
 }
 
+/*!Gets entry.*/
 QString
 SalomeApp_DataOwner
 ::entry() const
@@ -42,6 +47,7 @@ SalomeApp_DataOwner
   return myEntry;
 }
 
+/*!Gets SALOME_InteractiveObject.*/
 const Handle(SALOME_InteractiveObject)&
 SalomeApp_DataOwner
 ::IO() const
index 5f81f69799aab559b489750bd6a54bc688cc2992..d6528d9aaaac8e71035881b36b580f34ea252a84 100644 (file)
@@ -5,6 +5,9 @@
 #include "SUIT_DataOwner.h"
 #include "SALOME_InteractiveObject.hxx"
 
+/*!
+  This class provide data owner objects.
+*/
 class SalomeApp_DataOwner : public SUIT_DataOwner
 {
 public:
index 2643363e2b0c108010cfd513813fc6a96985cfb3..6c201155f2d050c25500b485b0b3ec1f6228a2ec 100644 (file)
@@ -6,16 +6,19 @@
 #include <typeinfo.h>
 #endif
 
+/*!Constructor.Initialize by \a entry and \a index*/
 SalomeApp_DataSubOwner::SalomeApp_DataSubOwner( const QString& entry, const int index )
 : SalomeApp_DataOwner( entry ),
 myIndex( index )
 {
 }
 
+/*!Destructor. Do nothing.*/
 SalomeApp_DataSubOwner::~SalomeApp_DataSubOwner()
 {
 }
 
+/*!Checks: Is current data sub owner equal \a obj.*/
 bool SalomeApp_DataSubOwner::isEqual( const SUIT_DataOwner& obj ) const
 {  
   const SalomeApp_DataSubOwner* other = dynamic_cast<const SalomeApp_DataSubOwner*>( &obj );
@@ -23,6 +26,7 @@ bool SalomeApp_DataSubOwner::isEqual( const SUIT_DataOwner& obj ) const
   return other && entry() == other->entry() && index() == other->index();
 }
 
+/*!Gets index.*/
 int SalomeApp_DataSubOwner::index() const
 {
   return myIndex;
index 430a28ba1c0488103debe2f5319a87b535698e0f..5192641e7c9e97acb261be00c66f85ae4ce9aa11 100644 (file)
@@ -4,6 +4,9 @@
 
 #include <SalomeApp_DataOwner.h>
 
+/*!
+  Class provide sub owner.
+ */
 class SalomeApp_DataSubOwner : public SalomeApp_DataOwner
 {
 public:
index f4a719369f4dcada60c38b1b930d65daf11a6534..c46e8d0d1bbc8f836b881fa075a745b307e666b1 100755 (executable)
@@ -6,6 +6,7 @@
 
 SalomeApp_EventFilter* SalomeApp_EventFilter::myFilter = NULL;
 
+/*!Constructor.*/
 SalomeApp_EventFilter::SalomeApp_EventFilter()
 : QObject()
 {
@@ -13,6 +14,7 @@ SalomeApp_EventFilter::SalomeApp_EventFilter()
   qApp->installEventFilter( this );
 }
 
+/*!Destructor.*/
 SalomeApp_EventFilter::~SalomeApp_EventFilter()
 {
   qApp->removeEventFilter( this );
@@ -30,6 +32,7 @@ bool SalomeApp_EventFilter::eventFilter( QObject* o, QEvent* e )
   return QObject::eventFilter( o, e );
 }
 
+/*!Process event.*/
 void SalomeApp_EventFilter::processEvent( SALOME_Event* theEvent )
 {
   if(theEvent){
@@ -39,12 +42,14 @@ void SalomeApp_EventFilter::processEvent( SALOME_Event* theEvent )
   }
 }
 
+/*!Create new instance of SalomeApp_EventFilter*/
 void SalomeApp_EventFilter::Init()
 {
   if( myFilter==NULL )
     myFilter = new SalomeApp_EventFilter();
 }
 
+/*!Destroy filter.*/
 void SalomeApp_EventFilter::Destroy()
 {
   if( myFilter )
index e2de767b31d31283f6b30d3aea9cfd20beff3df3..d2f9e7ddacf21c710f67fd330626fa1684202669 100755 (executable)
@@ -10,6 +10,9 @@
 
 class SALOME_Event;
 
+/*!
+  Class provide event filter.
+*/
 class SALOMEAPP_EXPORT SalomeApp_EventFilter: public QObject 
 {
 public:
@@ -21,7 +24,7 @@ protected:
   virtual ~SalomeApp_EventFilter();
 
 private:
-  /* global event filter for qapplication */
+  /*! global event filter for qapplication */
   virtual bool eventFilter( QObject* o, QEvent* e );
   void processEvent( SALOME_Event* );
 
index aebfb9c8c43fab6710a10b6afbc25799cdad71d4..eff88e81e49396393512a374a28067a4620ade99 100644 (file)
 
 #include <qstring.h>
 
+/*!Constructor. Initialize by \a floatSignal.*/
 SalomeApp_ExceptionHandler::SalomeApp_ExceptionHandler( const bool floatSignal )
 : SUIT_ExceptionHandler()
 {
   OSD::SetSignal( floatSignal );
 }
 
+/*!Try to call SUIT_ExceptionHandler::internalHandle(o, e), catch if failure.*/
 bool SalomeApp_ExceptionHandler::handleSignals( QObject* o, QEvent* e )
 {
   try {
@@ -37,6 +39,7 @@ bool SalomeApp_ExceptionHandler::handleSignals( QObject* o, QEvent* e )
 #undef catch
 #endif
 
+/*!Try to call handleSignals( o, e ), catch and show error message.*/
 bool SalomeApp_ExceptionHandler::handle( QObject* o, QEvent* e )
 {
   bool res = false;
@@ -63,6 +66,7 @@ bool SalomeApp_ExceptionHandler::handle( QObject* o, QEvent* e )
   return res;
 }
 
+/*!Create new SUIT_ExceptionHandler*/
 extern "C" SALOMEAPP_EXPORT SUIT_ExceptionHandler* getExceptionHandler()
 {
   return new SalomeApp_ExceptionHandler( true );
index 6404e5c9deb5e619d667f7c9ad617e8d0f7a95fa..f512a8db7ab47aa2873064e20e1f792b38bbe82e 100644 (file)
@@ -1,14 +1,17 @@
 #include "SalomeApp_Filter.h"
 
+/*!Constructor.Initialize by study.*/
 SalomeApp_Filter::SalomeApp_Filter( SalomeApp_Study* study )
 {
   myStudy = study;
 }
 
+/*!Destructor. Do nothing.*/
 SalomeApp_Filter::~SalomeApp_Filter()
 {
 }
 
+/*!Gets study.*/
 SalomeApp_Study* SalomeApp_Filter::getStudy() const
 {
   return myStudy;
index 33a2e3ba9978d4f5b6fce4527a65acea5fe1fbea..0e3b4a842d95526e0ecfe682a3c49b62ec5955bc 100644 (file)
@@ -6,6 +6,7 @@
 
 #include <GLViewer_Context.h>
 
+/*!Constructor. Initialize by GLViewer_Viewer2d and SUIT_SelectionMgr.*/
 SalomeApp_GLSelector::SalomeApp_GLSelector( GLViewer_Viewer2d* viewer, SUIT_SelectionMgr* mgr )
 : SUIT_Selector( mgr, viewer ),
   myViewer( viewer )
@@ -14,20 +15,24 @@ SalomeApp_GLSelector::SalomeApp_GLSelector( GLViewer_Viewer2d* viewer, SUIT_Sele
     connect( myViewer, SIGNAL( selectionChanged() ), this, SLOT( onSelectionChanged() ) );
 }
 
+/*!Destructor. Do nothing.*/
 SalomeApp_GLSelector::~SalomeApp_GLSelector()
 {
 }
 
+/*!Gets viewer*/
 GLViewer_Viewer2d* SalomeApp_GLSelector::viewer() const
 {
   return myViewer;
 }
 
+/*!On selection changed event.*/
 void SalomeApp_GLSelector::onSelectionChanged()
 {
   selectionChanged();
 }
 
+/*!Gets list of selected Data Owner objects.*/
 void SalomeApp_GLSelector::getSelection( SUIT_DataOwnerPtrList& aList ) const
 {
   if ( !myViewer )
@@ -49,6 +54,7 @@ void SalomeApp_GLSelector::getSelection( SUIT_DataOwnerPtrList& aList ) const
   }
 }
 
+/*!Sets to selected list of Data Owner objects.*/
 void SalomeApp_GLSelector::setSelection( const SUIT_DataOwnerPtrList& aList )
 {
   if ( !myViewer )
index 73766726265669cfeede96d0c9896a28fe92155c..ae1cb54adaa418ae2d9fa6a009bf7cedc3e2b078 100644 (file)
@@ -31,6 +31,7 @@
 
 using namespace std;
 
+/*!Constructor. Do nothing.*/
 SalomeApp_ImportOperation::SalomeApp_ImportOperation( SUIT_Application* app ) :
 SUIT_Operation( app )
 {
index 988ac450d462ae76d151453e24fdf54c10a51614..6f3bd20e116ba503b68e05edb16bfe51d19f7de9 100644 (file)
@@ -33,7 +33,7 @@ using namespace std;
 
 //================================================================
 // Function : computeEditGeometry
-// Purpose  : static function - used for resizing editing widget
+/*! Purpose  : static function - used for resizing editing widget*/
 //================================================================
 void computeEditGeometry(SalomeApp_ListViewItem* theItem,
                          SalomeApp_EntityEdit*   theWidget)
@@ -63,7 +63,7 @@ void computeEditGeometry(SalomeApp_ListViewItem* theItem,
 
 //================================================================
 // Function : SalomeApp_ListView::SalomeApp_ListView
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListView::SalomeApp_ListView( QWidget* parent )
 : QtxListView( parent )
@@ -90,7 +90,7 @@ SalomeApp_ListView::SalomeApp_ListView( QWidget* parent )
 
 //================================================================
 // Function : SalomeApp_ListView::~SalomeApp_ListView
-// Purpose  : destructor
+/*! Purpose  : destructor*/
 //================================================================
 SalomeApp_ListView::~SalomeApp_ListView()
 {
@@ -103,7 +103,7 @@ SalomeApp_ListView::~SalomeApp_ListView()
 
 //================================================================
 // Function : SalomeApp_ListView::updateViewer
-// Purpose  : updates all data viewer
+/*! Purpose  : updates all data viewer*/
 //================================================================
 void SalomeApp_ListView::updateViewer()
 {
@@ -120,7 +120,7 @@ void SalomeApp_ListView::updateViewer()
 
 //================================================================
 // Function : SalomeApp_ListView::updateSelected
-// Purpose  : updates currently selected item(s)
+/*! Purpose  : updates currently selected item(s)*/
 //================================================================
 void SalomeApp_ListView::updateSelected()
 {
@@ -137,7 +137,7 @@ void SalomeApp_ListView::updateSelected()
 
 //================================================================
 // Function : SalomeApp_ListView::popupClientType
-// Purpose  : returns popup client type
+/*! Purpose  : returns popup client type*/
 //================================================================
 QString SalomeApp_ListView::popupClientType() const
 {
@@ -146,7 +146,7 @@ QString SalomeApp_ListView::popupClientType() const
 
 //================================================================
 // Function : SalomeApp_ListView::contextMenuPopup
-// Purpose  : fills popup menu with items
+/*! Purpose  : fills popup menu with items*/
 //================================================================
 void SalomeApp_ListView::contextMenuPopup( QPopupMenu* aPopup )
 {
@@ -157,7 +157,7 @@ void SalomeApp_ListView::contextMenuPopup( QPopupMenu* aPopup )
 
 //================================================================
 // Function : SalomeApp_ListView::clear
-// Purpose  : clears view
+/*! Purpose  : clears view*/
 //================================================================
 void SalomeApp_ListView::clear()
 {
@@ -171,7 +171,7 @@ void SalomeApp_ListView::clear()
 
 //================================================================
 // Function : SalomeApp_ListView::isMouseEnabled
-// Purpose  : returms true if mouse events are enabled
+/*! Purpose  : returms true if mouse events are enabled*/
 //================================================================
 bool SalomeApp_ListView::isMouseEnabled()
 {
@@ -189,7 +189,7 @@ void SalomeApp_ListView::enableMouse(bool enable)
 
 //================================================================
 // Function : SalomeApp_ListView::eventFilter
-// Purpose  : event filter
+/*! Purpose  : event filter*/
 //================================================================
 bool SalomeApp_ListView::eventFilter(QObject* object, QEvent* event)
 {
@@ -205,7 +205,7 @@ bool SalomeApp_ListView::eventFilter(QObject* object, QEvent* event)
 
 //================================================================
 // Function : SalomeApp_ListView::enableEditing
-// Purpose  : setting editing of items availbale/not available
+/*! Purpose  : setting editing of items availbale/not available*/
 //================================================================
 void SalomeApp_ListView::enableEditing(bool theFlag)
 {
@@ -221,7 +221,7 @@ void SalomeApp_ListView::enableEditing(bool theFlag)
 
 //================================================================
 // Function : SalomeApp_ListView::isEnableEditing
-// Purpose  : says if editing is enabled
+/*! Purpose  : says if editing is enabled*/
 //================================================================
 bool SalomeApp_ListView::isEnableEditing()
 {
@@ -230,7 +230,7 @@ bool SalomeApp_ListView::isEnableEditing()
 
 //================================================================
 // Function : SalomeApp_ListView::accept
-// Purpose  : calls finishEditing(true)...
+/*! Purpose  : calls finishEditing(true)...*/
 //================================================================
 void SalomeApp_ListView::accept()
 {
@@ -239,7 +239,7 @@ void SalomeApp_ListView::accept()
 
 //================================================================
 // Function : QAD_ListView::onSelectionChanged
-// Purpose  : slot, called when selection changed in List Viewer
+/*! Purpose  : slot, called when selection changed in List Viewer*/
 //================================================================
 void SalomeApp_ListView::onSelectionChanged()
 {
@@ -273,7 +273,7 @@ void SalomeApp_ListView::onSelectionChanged()
 
 //================================================================
 // Function : SalomeApp_ListView::resizeEvent
-// Purpose  : called when Data Viewer is resized
+/*! Purpose  : called when Data Viewer is resized*/
 //================================================================
 void SalomeApp_ListView::resizeEvent( QResizeEvent * e)
 {
@@ -287,7 +287,7 @@ void SalomeApp_ListView::resizeEvent( QResizeEvent * e)
 
 //================================================================
 // Function : SalomeApp_ListView::onHeaderSizeChange
-// Purpose  : slot, called when columns sizes are changed
+/*! Purpose  : slot, called when columns sizes are changed*/
 //================================================================
 void SalomeApp_ListView::onHeaderSizeChange(int, int, int)
 {
@@ -299,7 +299,7 @@ void SalomeApp_ListView::onHeaderSizeChange(int, int, int)
 
 //================================================================
 // Function : SalomeApp_ListView::viewportPaintEvent
-// Purpose  : handler for paint event
+/*! Purpose  : handler for paint event*/
 //================================================================
 void SalomeApp_ListView::viewportPaintEvent(QPaintEvent* e)
 {
@@ -311,7 +311,7 @@ void SalomeApp_ListView::viewportPaintEvent(QPaintEvent* e)
 
 //================================================================
 // Function : SalomeApp_ListView::onEditOk
-// Purpose  : called when user finishes in editing of item
+/*! Purpose  : called when user finishes in editing of item*/
 //================================================================
 void SalomeApp_ListView::onEditOk()
 {
@@ -320,7 +320,7 @@ void SalomeApp_ListView::onEditOk()
 
 //================================================================
 // Function : SalomeApp_ListView::onEditCancel
-// Purpose  : called when user cancels item editing
+/*! Purpose  : called when user cancels item editing*/
 //================================================================
 void SalomeApp_ListView::onEditCancel()
 {
@@ -329,7 +329,7 @@ void SalomeApp_ListView::onEditCancel()
 
 //================================================================
 // Function : SalomeApp_ListView::finishEditing
-// Purpose  : finishes editing of entity
+/*! Purpose  : finishes editing of entity*/
 //================================================================
 UpdateType SalomeApp_ListView::finishEditing(bool ok)
 {
@@ -394,8 +394,9 @@ UpdateType SalomeApp_ListView::finishEditing(bool ok)
 
 //================================================================
 // Function : SalomeApp_ListView::tip
-// Purpose  : gets current tooltip for list view
-//            returns valid rect in success
+/*! Purpose  : gets current tooltip for list view
+ * \retval valid rect in success
+ */
 //================================================================
 QRect SalomeApp_ListView::tip(QPoint aPos,
                        QString& aText,
@@ -434,7 +435,7 @@ QRect SalomeApp_ListView::tip(QPoint aPos,
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView* parent) :
 QListViewItem( parent )
@@ -444,7 +445,7 @@ QListViewItem( parent )
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView*     parent,
                                   SalomeApp_ListViewItem* after) :
@@ -455,7 +456,7 @@ QListViewItem( parent, after )
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView*     parent,
                                   const QString&    theName,
@@ -468,7 +469,7 @@ QListViewItem(parent, theName)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView*     parent,
                                   const QString&    theName,
@@ -482,7 +483,7 @@ QListViewItem(parent, theName, theValue)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListViewItem* parent,
                                   const QString&    theName,
@@ -495,7 +496,7 @@ QListViewItem(parent, theName)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListViewItem* parent,
                                   SalomeApp_ListViewItem* after,
@@ -509,7 +510,7 @@ QListViewItem(parent, after, theName)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView*     parent,
                                   SalomeApp_ListViewItem* after,
@@ -524,7 +525,7 @@ QListViewItem(parent, after, theName)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListViewItem* parent,
                                   const QString&    theName,
@@ -539,7 +540,7 @@ QListViewItem(parent, theName, theValue)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListViewItem* parent,
                                   SalomeApp_ListViewItem* after,
@@ -554,7 +555,7 @@ QListViewItem(parent, after, theName, theValue)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView*     parent,
                                   SalomeApp_ListViewItem* after,
@@ -569,7 +570,7 @@ QListViewItem(parent, after, theName, theValue)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::~SalomeApp_ListViewItem
-// Purpose  : destructor
+/*! Purpose  : destructor*/
 //================================================================
 SalomeApp_ListViewItem::~SalomeApp_ListViewItem()
 {
@@ -577,7 +578,7 @@ SalomeApp_ListViewItem::~SalomeApp_ListViewItem()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::init
-// Purpose  : initialization
+/*! Purpose  : initialization*/
 //================================================================
 void SalomeApp_ListViewItem::init()
 {
@@ -591,7 +592,7 @@ void SalomeApp_ListViewItem::init()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::getName
-// Purpose  : as default returns text in the first column
+/*! Purpose  : as default returns text in the first column*/
 //================================================================
 QString SalomeApp_ListViewItem::getName() const
 {
@@ -600,7 +601,7 @@ QString SalomeApp_ListViewItem::getName() const
 
 //================================================================
 // Function : SalomeApp_ListViewItem::setName
-// Purpose  : as default sets text in the first column
+/*! Purpose  : as default sets text in the first column*/
 //================================================================
 UpdateType SalomeApp_ListViewItem::setName(const QString& theName)
 {
@@ -614,7 +615,7 @@ UpdateType SalomeApp_ListViewItem::setName(const QString& theName)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::getValue
-// Purpose  : as default returns text in the second column
+/*! Purpose  : as default returns text in the second column*/
 //================================================================
 QString SalomeApp_ListViewItem::getValue() const
 {
@@ -623,7 +624,7 @@ QString SalomeApp_ListViewItem::getValue() const
 
 //================================================================
 // Function : SalomeApp_ListViewItem::setValue
-// Purpose  : as default sets text in the second column
+/*! Purpose  : as default sets text in the second column*/
 //================================================================
 UpdateType SalomeApp_ListViewItem::setValue(const QString& theValue)
 {
@@ -637,7 +638,7 @@ UpdateType SalomeApp_ListViewItem::setValue(const QString& theValue)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::fullName
-// Purpose  : returns full path to the entity from the root
+/*! Purpose  : returns full path to the entity from the root*/
 //================================================================
 QString SalomeApp_ListViewItem::fullName()
 {
@@ -652,7 +653,7 @@ QString SalomeApp_ListViewItem::fullName()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::openAllLevels
-// Purpose  : expands all entities beginning from this level
+/*! Purpose  : expands all entities beginning from this level*/
 //================================================================
 void SalomeApp_ListViewItem::openAllLevels()
 {
@@ -666,7 +667,7 @@ void SalomeApp_ListViewItem::openAllLevels()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::updateAllLevels
-// Purpose  : update all entites beginning from this level
+/*! Purpose  : update all entites beginning from this level*/
 //================================================================
 void SalomeApp_ListViewItem::updateAllLevels()
 {
@@ -679,7 +680,7 @@ void SalomeApp_ListViewItem::updateAllLevels()
 
 //================================================================
 // Function : SalomeApp_EditBox::isEditable
-// Purpose  : return true if entity is editable
+/*! Purpose  : return true if entity is editable*/
 //================================================================
 bool SalomeApp_ListViewItem::isEditable() const
 {
@@ -688,7 +689,7 @@ bool SalomeApp_ListViewItem::isEditable() const
 
 //================================================================
 // Function : SalomeApp_ListViewItem::setEditable
-// Purpose  : sets editable flag fo the entity
+/*! Purpose  : sets editable flag fo the entity*/
 //================================================================
 void SalomeApp_ListViewItem::setEditable(bool theEditable)
 {
@@ -697,7 +698,7 @@ void SalomeApp_ListViewItem::setEditable(bool theEditable)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::isAccepted
-// Purpose  : returns true if entitiy is accepted after editing
+/*! Purpose  : returns true if entitiy is accepted after editing*/
 //================================================================
 bool SalomeApp_ListViewItem::isAccepted() const
 {
@@ -706,7 +707,7 @@ bool SalomeApp_ListViewItem::isAccepted() const
 
 //================================================================
 // Function : SalomeApp_ListViewItem::setAccepted
-// Purpose  : set entitiy accepted or not after editing
+/*! Purpose  : set entitiy accepted or not after editing*/
 //================================================================
 void SalomeApp_ListViewItem::setAccepted(bool theAccepted)
 {
@@ -715,8 +716,12 @@ void SalomeApp_ListViewItem::setAccepted(bool theAccepted)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::getEditingType
-// Purpose  : returns type of edit control (0 - edit box, 1 - combo box,
-//            2 - editable combo box),  default is edit box
+/*! Purpose  : 
+ * \retval type of edit control (default is edit box)
+ *     \li 0 - edit box
+ *     \li 1 - combo box
+ *     \li 2 - editable combo box
+ */
 //================================================================
 int SalomeApp_ListViewItem::getEditingType()
 {
@@ -725,8 +730,12 @@ int SalomeApp_ListViewItem::getEditingType()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::setEditingType
-// Purpose  : sets type of edit control (0 - edit box, 1 - combo box,
-//            2 - editable combo box), negative value means none
+/*! Purpose  : 
+ * \retval type of edit control (negative value means none)
+ *     \li 0 - edit box
+ *     \li 1 - combo box
+ *     \li 2 - editable combo box
+ */
 //================================================================
 void SalomeApp_ListViewItem::setEditingType(const int type)
 {
@@ -735,8 +744,10 @@ void SalomeApp_ListViewItem::setEditingType(const int type)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::getEditedColumn
-// Purpose  : returns edited column, default is last column
-//            negative value means there are no editable columns
+// Purpose  : 
+/*! \retval edited column, default is last column
+ *   negative value means there are no editable columns
+ */
 //================================================================
 int SalomeApp_ListViewItem::getEditedColumn()
 {
@@ -745,8 +756,10 @@ int SalomeApp_ListViewItem::getEditedColumn()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::getValueType
-// Purpose  : returns type of edited value (string, int, double)
-//            default is string
+// Purpose  : 
+/*!\retval type of edited value (string, int, double)
+ * default is string
+ */
 //================================================================
 int SalomeApp_ListViewItem::getValueType()
 {
@@ -755,7 +768,7 @@ int SalomeApp_ListViewItem::getValueType()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::setValueType
-// Purpose  : sets type of edited value
+/*! Purpose  : sets type of edited value*/
 //================================================================
 void SalomeApp_ListViewItem::setValueType(const int valueType)
 {
@@ -764,7 +777,7 @@ void SalomeApp_ListViewItem::setValueType(const int valueType)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::getUserType
-// Purpose  : sets type of edited value
+/*! Purpose  : sets type of edited value*/
 //================================================================
 int SalomeApp_ListViewItem::getUserType()
 {
@@ -773,7 +786,7 @@ int SalomeApp_ListViewItem::getUserType()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::setUserType
-// Purpose  : sets type of edited value
+/*! Purpose  : sets type of edited value*/
 //================================================================
 void SalomeApp_ListViewItem::setUserType(const int userType)
 {
@@ -782,8 +795,9 @@ void SalomeApp_ListViewItem::setUserType(const int userType)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::getButtons
-// Purpose  : returns buttons for editing widget (Apply (V), Cancel (X))
-//            default is both buttons
+/*! Purpose  : returns buttons for editing widget (Apply (V), Cancel (X))
+ * default is both buttons
+ */
 //================================================================
 int SalomeApp_ListViewItem::getButtons()
 {
@@ -792,7 +806,7 @@ int SalomeApp_ListViewItem::getButtons()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::getButtons
-// Purpose  : sets buttons for editing widget (Apply (V), Cancel (X))
+/*! Purpose  : sets buttons for editing widget (Apply (V), Cancel (X))*/
 //================================================================
 void SalomeApp_ListViewItem::setButtons(const int buttons)
 {
@@ -801,7 +815,7 @@ void SalomeApp_ListViewItem::setButtons(const int buttons)
 
 //================================================================
 // Function : SalomeApp_ListViewItem::startEditing
-// Purpose  : creates control for editing and fills it with values
+/*! Purpose  : creates control for editing and fills it with values*/
 //================================================================
 SalomeApp_EntityEdit* SalomeApp_ListViewItem::startEditing()
 {
@@ -830,7 +844,7 @@ SalomeApp_EntityEdit* SalomeApp_ListViewItem::startEditing()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::fillWidgetWithValues
-// Purpose  : fills widget with initial values (list or single value)
+/*! Purpose  : fills widget with initial values (list or single value)*/
 //================================================================
 void SalomeApp_ListViewItem::fillWidgetWithValues(SalomeApp_EntityEdit* theWidget)
 {
@@ -841,7 +855,7 @@ void SalomeApp_ListViewItem::fillWidgetWithValues(SalomeApp_EntityEdit* theWidge
 
 //================================================================
 // Function : SalomeApp_ListViewItem::finishEditing
-// Purpose  : finishes editing of entity
+/*! Purpose  : finishes editing of entity*/
 //================================================================
 UpdateType SalomeApp_ListViewItem::finishEditing(SalomeApp_EntityEdit* theWidget)
 {
@@ -869,7 +883,7 @@ UpdateType SalomeApp_ListViewItem::finishEditing(SalomeApp_EntityEdit* theWidget
 
 //================================================================
 // Function : SalomeApp_ListViewItem::tipRect
-// Purpose  : calculates rectangle which should contain item's tip
+/*! Purpose  : calculates rectangle which should contain item's tip*/
 //================================================================
 QRect SalomeApp_ListViewItem::tipRect()
 {
@@ -894,7 +908,7 @@ QRect SalomeApp_ListViewItem::tipRect()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::tipText
-// Purpose  : returns text for tooltip
+/*! Purpose  : returns text for tooltip*/
 //================================================================
 QString SalomeApp_ListViewItem::tipText()
 {
@@ -906,7 +920,7 @@ QString SalomeApp_ListViewItem::tipText()
 
 //================================================================
 // Function : SalomeApp_ListViewItem::textRect
-// Purpose  : calculates rect of item text in viewport coordinates
+/*! Purpose  : calculates rect of item text in viewport coordinates*/
 //================================================================
 QRect SalomeApp_ListViewItem::textRect(const int column) const
 {
@@ -944,7 +958,7 @@ QRect SalomeApp_ListViewItem::textRect(const int column) const
 
 //================================================================
 // Function : SalomeApp_ListViewItem::itemRect
-// Purpose  : calculates rect of item data in viewport coordinates
+/*! Purpose  : calculates rect of item data in viewport coordinates*/
 //================================================================
 QRect SalomeApp_ListViewItem::itemRect(const int column) const
 {
@@ -983,7 +997,7 @@ QRect SalomeApp_ListViewItem::itemRect(const int column) const
 
 //================================================================
 // Function : SalomeApp_EditBox::SalomeApp_EditBox
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_EditBox::SalomeApp_EditBox(QWidget* parent) :
 QLineEdit(parent)
@@ -992,7 +1006,7 @@ QLineEdit(parent)
 
 //================================================================
 // Function : SalomeApp_EditBox::keyPressEvent
-// Purpose  : event filter for key pressing
+/*! Purpose  : event filter for key pressing*/
 //================================================================
 void SalomeApp_EditBox::keyPressEvent( QKeyEvent *e )
 {
@@ -1009,7 +1023,7 @@ void SalomeApp_EditBox::keyPressEvent( QKeyEvent *e )
 
 //================================================================
 // Function : SalomeApp_ComboBox::SalomeApp_ComboBox
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_ComboBox::SalomeApp_ComboBox(bool rw, QWidget* parent, const char* name) :
 QComboBox(rw, parent, name)
@@ -1018,7 +1032,7 @@ QComboBox(rw, parent, name)
 
 //================================================================
 // Function : SalomeApp_ComboBox::findItem
-// Purpose  : searches item in list and returns its index
+/*! Purpose  : searches item in list and returns its index*/
 //================================================================
 int SalomeApp_ComboBox::findItem(const QString& theText)
 {
@@ -1030,7 +1044,7 @@ int SalomeApp_ComboBox::findItem(const QString& theText)
 
 //================================================================
 // Function : SalomeApp_ComboBox::insertItem
-// Purpose  : adds item in combo box
+/*! Purpose  : adds item in combo box*/
 //================================================================
 void SalomeApp_ComboBox::insertItem(const QString& theValue,
                              int            theIndex)
@@ -1041,7 +1055,7 @@ void SalomeApp_ComboBox::insertItem(const QString& theValue,
 
 //================================================================
 // Function : SalomeApp_ComboBox::insertList
-// Purpose  : adds list of items in combo box
+/*! Purpose  : adds list of items in combo box*/
 //================================================================
 void SalomeApp_ComboBox::insertList(const QStringList& theList)
 {
@@ -1051,7 +1065,7 @@ void SalomeApp_ComboBox::insertList(const QStringList& theList)
 
 //================================================================
 // Function : SalomeApp_ComboBox::insertItem
-// Purpose  : adds item in combo box
+/*! Purpose  : adds item in combo box*/
 //================================================================
 void SalomeApp_ComboBox::insertItem(const int theValue)
 {
@@ -1071,7 +1085,7 @@ void SalomeApp_ComboBox::insertItem(const int theValue)
 
 //================================================================
 // Function : SalomeApp_ComboBox::insertList
-// Purpose  : adds list of items in combo box
+/*! Purpose  : adds list of items in combo box*/
 //================================================================
 void SalomeApp_ComboBox::insertList(const TColStd_ListOfInteger& theList)
 {
@@ -1081,7 +1095,7 @@ void SalomeApp_ComboBox::insertList(const TColStd_ListOfInteger& theList)
 
 //================================================================
 // Function : SalomeApp_ComboBox::insertItem
-// Purpose  : adds item in combo box
+/*! Purpose  : adds item in combo box*/
 //================================================================
 void SalomeApp_ComboBox::insertItem(const double theValue)
 {
@@ -1101,7 +1115,7 @@ void SalomeApp_ComboBox::insertItem(const double theValue)
 
 //================================================================
 // Function : SalomeApp_ComboBox::insertList
-// Purpose  : adds list of items in combo box
+/*! Purpose  : adds list of items in combo box*/
 //================================================================
 void SalomeApp_ComboBox::insertList(const TColStd_ListOfReal& theList)
 {
@@ -1120,7 +1134,7 @@ void SalomeApp_ComboBox::insertList(const TColStd_ListOfReal& theList)
 
 //================================================================
 // Function : SalomeApp_EntityEdit::SalomeApp_EntityEdit
-// Purpose  : constructor
+/*! Purpose  : constructor*/
 //================================================================
 SalomeApp_EntityEdit::SalomeApp_EntityEdit(QWidget* parent,
                               int      controlType,
@@ -1212,7 +1226,7 @@ myCancelBtn(0)
 
 //================================================================
 // Function : SalomeApp_EntityEdit::~SalomeApp_EntityEdit
-// Purpose  : destructor
+/*! Purpose  : destructor*/
 //================================================================
 SalomeApp_EntityEdit::~SalomeApp_EntityEdit()
 {
@@ -1220,7 +1234,7 @@ SalomeApp_EntityEdit::~SalomeApp_EntityEdit()
 
 //================================================================
 // Function : SalomeApp_EntityEdit::clear
-// Purpose  : clears edit/combo box
+/*! Purpose  : clears edit/combo box*/
 //================================================================
 void SalomeApp_EntityEdit::clear()
 {
@@ -1232,7 +1246,7 @@ void SalomeApp_EntityEdit::clear()
 
 //================================================================
 // Function : SalomeApp_EntityEdit::getText
-// Purpose  : returns current text in edit box or combo box
+/*! Purpose  : returns current text in edit box or combo box*/
 //================================================================
 QString SalomeApp_EntityEdit::getText()
 {
@@ -1246,7 +1260,7 @@ QString SalomeApp_EntityEdit::getText()
 
 //================================================================
 // Function : SalomeApp_EntityEdit::setText
-// Purpose  : sets text
+/*! Purpose  : sets text*/
 //================================================================
 void SalomeApp_EntityEdit::setText(const QString& theText)
 {
@@ -1264,8 +1278,9 @@ void SalomeApp_EntityEdit::setText(const QString& theText)
 
 //================================================================
 // Function : SalomeApp_EntityEdit::insertItem
-// Purpose  : adds item in combo box,
-//            sets it current if theSetCurrent is true
+/*! Purpose  : adds item in combo box,
+ *            sets it current if theSetCurrent is true
+ */
 //================================================================
 void SalomeApp_EntityEdit::insertItem(const QString& theValue,
                                bool           theSetCurrent,
@@ -1289,8 +1304,9 @@ void SalomeApp_EntityEdit::insertItem(const QString& theValue,
 
 //================================================================
 // Function : SalomeApp_EntityEdit::insertList
-// Purpose  : adds items in combo box,
-//            sets item theCurrent as current
+/*! Purpose  : adds items in combo box,
+ *            sets item theCurrent as current
+ */
 //================================================================
 void SalomeApp_EntityEdit::insertList(const QStringList& theList,
                                const int          theCurrent)
@@ -1303,8 +1319,9 @@ void SalomeApp_EntityEdit::insertList(const QStringList& theList,
 
 //================================================================
 // Function : SalomeApp_EntityEdit::insertItem
-// Purpose  : adds item in combo box,
-//            sets it current if theSetCurrent is true
+/*! Purpose  : adds item in combo box,
+ *            sets it current if theSetCurrent is true
+ */
 //================================================================
 void SalomeApp_EntityEdit::insertItem(const int theValue,
                                bool      theSetCurrent)
@@ -1318,8 +1335,9 @@ void SalomeApp_EntityEdit::insertItem(const int theValue,
 
 //================================================================
 // Function : SalomeApp_EntityEdit::insertList
-// Purpose  : adds items in combo box,
-//            sets item theCurrent as current
+/*! Purpose  : adds items in combo box,
+ *            sets item theCurrent as current
+ */
 //================================================================
 void SalomeApp_EntityEdit::insertList(const TColStd_ListOfInteger& theList,
                                const int                    theCurrent)
@@ -1353,8 +1371,9 @@ void SalomeApp_EntityEdit::insertItem(const double theValue,
 
 //================================================================
 // Function : SalomeApp_EntityEdit::insertList
-// Purpose  : adds items in combo box,
-//            sets item theCurrent as current
+/*! Purpose  : adds items in combo box,
+ *            sets item theCurrent as current
+ */
 //================================================================
 void SalomeApp_EntityEdit::insertList(const TColStd_ListOfReal& theList,
                                const int                 theCurrent)
@@ -1373,7 +1392,7 @@ void SalomeApp_EntityEdit::insertList(const TColStd_ListOfReal& theList,
 
 //================================================================
 // Function : SalomeApp_EntityEdit::getControl
-// Purpose  : gets actual widget
+/*! Purpose  : gets actual widget*/
 //================================================================
 QWidget* SalomeApp_EntityEdit::getControl()
 {
@@ -1387,7 +1406,7 @@ QWidget* SalomeApp_EntityEdit::getControl()
 
 //================================================================
 // Function : SalomeApp_EntityEdit::setFocus
-// Purpose  : redirect focus to corresponding widget
+/*! Purpose  : redirect focus to corresponding widget*/
 //================================================================
 void SalomeApp_EntityEdit::setFocus()
 {
@@ -1403,7 +1422,7 @@ void SalomeApp_EntityEdit::setFocus()
 
 //================================================================
 // Function : SalomeApp_EntityEdit::setValidator
-// Purpose  : sets validator for the control
+/*! Purpose  : sets validator for the control*/
 //================================================================
 void SalomeApp_EntityEdit::setValidator(const QValidator* theValidator)
 {
@@ -1415,7 +1434,7 @@ void SalomeApp_EntityEdit::setValidator(const QValidator* theValidator)
 
 //================================================================
 // Function : SalomeApp_EntityEdit::keyPressEvent
-// Purpose  : event filter for KeyPress event
+/*! Purpose  : event filter for KeyPress event*/
 //================================================================
 void SalomeApp_EntityEdit::keyPressEvent( QKeyEvent * e)
 {
@@ -1428,7 +1447,7 @@ void SalomeApp_EntityEdit::keyPressEvent( QKeyEvent * e)
 
 //================================================================
 // Function : SalomeApp_EntityEdit::onComboActivated
-// Purpose  : called when item activated in combo box
+/*! Purpose  : called when item activated in combo box*/
 //================================================================
 void SalomeApp_EntityEdit::onComboActivated(const QString& theText)
 {
@@ -1437,7 +1456,7 @@ void SalomeApp_EntityEdit::onComboActivated(const QString& theText)
 
 //================================================================
 // Function : SalomeApp_EntityEdit::onTextChanged
-// Purpose  : slot, called when text changed in line edit
+/*! Purpose  : slot, called when text changed in line edit*/
 //================================================================
 void SalomeApp_EntityEdit::onTextChanged(const QString& theText)
 {
@@ -1449,7 +1468,7 @@ void SalomeApp_EntityEdit::onTextChanged(const QString& theText)
 
 //================================================================
 // Function : SalomeApp_EntityEdit::onCancel
-// Purpose  : slot, called when user presses Cancel button
+/*! Purpose  : slot, called when user presses Cancel button*/
 //================================================================
 void SalomeApp_EntityEdit::onCancel()
 {
@@ -1463,7 +1482,7 @@ void SalomeApp_EntityEdit::onCancel()
 
 //================================================================
 // Function : SalomeApp_EntityEdit::onApply
-// Purpose  : slot, called when user presses Apply button
+/*! Purpose  : slot, called when user presses Apply button*/
 //================================================================
 void SalomeApp_EntityEdit::onApply()
 {
@@ -1477,7 +1496,7 @@ void SalomeApp_EntityEdit::onApply()
 
 //================================================================
 // Function : SalomeApp_EntityEdit::showButtons
-// Purpose  : shows/hides buttons
+/*! Purpose  : shows/hides buttons*/
 //================================================================
 void SalomeApp_EntityEdit::showButtons(bool show)
 {
@@ -1489,7 +1508,7 @@ void SalomeApp_EntityEdit::showButtons(bool show)
 
 //================================================================
 // Function : SalomeApp_EntityEdit::setDuplicatesEnabled
-// Purpose  : enables/disables data duplication (for combo box)
+/*! Purpose  : enables/disables data duplication (for combo box)*/
 //================================================================
 void SalomeApp_EntityEdit::setDuplicatesEnabled(bool enabled)
 {
index 3b09d2ddd89cbe0b6ca9f960cb5c818c8be32060..22de8288c3e88791cdcddf439bbea534f929a968 100644 (file)
 
 #include <QtxPopupMgr.h>
 
+/*!Constructor.*/
 SalomeApp_Module::SalomeApp_Module( const QString& name )
 : CAM_Module( name ),
 myPopupMgr( 0 )
 {
 }
 
+/*!Destructor.*/
 SalomeApp_Module::~SalomeApp_Module()
 {
 }
 
+/*!Initialize module.*/
 void SalomeApp_Module::initialize( CAM_Application* app )
 {
   CAM_Module::initialize( app );
@@ -38,6 +41,7 @@ void SalomeApp_Module::initialize( CAM_Application* app )
     resMgr->raiseTranslators( name() );
 }
 
+/*!Activate module.*/
 bool SalomeApp_Module::activateModule( SUIT_Study* study )
 {
   bool res = CAM_Module::activateModule( study );
@@ -48,52 +52,64 @@ bool SalomeApp_Module::activateModule( SUIT_Study* study )
   return res;
 }
 
+/*!Deactivate module.*/
 bool SalomeApp_Module::deactivateModule( SUIT_Study* )
 {
   return true;
 }
 
+/*!NOT IMPLEMENTED*/
 void SalomeApp_Module::selectionChanged()
 {
 }
 
+/*!NOT IMPLEMENTED*/
 void SalomeApp_Module::MenuItem()
 {
 }
 
+/*!NOT IMPLEMENTED*/
 void SalomeApp_Module::windows( QMap<int, int>& ) const
 {
 }
 
+/*!NOT IMPLEMENTED*/
 void SalomeApp_Module::viewManagers( QStringList& ) const
 {
 }
 
+/*!NOT IMPLEMENTED*/
 void SalomeApp_Module::createPreferences()
 {
 }
 
+/*!NOT IMPLEMENTED*/
 void SalomeApp_Module::preferencesChanged( const QString&, const QString& )
 {
 }
 
+/*!Gets application.*/
 SalomeApp_Application* SalomeApp_Module::getApp() const
 {
   return (SalomeApp_Application*)application();
 }
 
+/*!NOT IMPLEMENTED*/
 void SalomeApp_Module::onModelOpened()
 {
 }
 
+/*!NOT IMPLEMENTED*/
 void SalomeApp_Module::onModelSaved()
 {
 }
 
+/*!NOT IMPLEMENTED*/
 void SalomeApp_Module::onModelClosed()
 {
 }
 
+/*!Gets popup manager.(create if not exist)*/
 QtxPopupMgr* SalomeApp_Module::popupMgr()
 {
   if ( !myPopupMgr )
@@ -101,6 +117,7 @@ QtxPopupMgr* SalomeApp_Module::popupMgr()
   return myPopupMgr;
 }
 
+/*!Gets preferences.*/
 SalomeApp_Preferences* SalomeApp_Module::preferences() const
 {
   SalomeApp_Preferences* pref = 0;
@@ -109,11 +126,13 @@ SalomeApp_Preferences* SalomeApp_Module::preferences() const
   return pref;
 }
 
+/*!Create new instance of data model and return it.*/
 CAM_DataModel* SalomeApp_Module::createDataModel()
 {
   return new SalomeApp_DataModel(this);
 }
 
+/*!Update object browser.*/
 void SalomeApp_Module::updateObjBrowser( bool updateDataModel, SUIT_DataObject* root )
 {
   if( updateDataModel )
@@ -123,6 +142,7 @@ void SalomeApp_Module::updateObjBrowser( bool updateDataModel, SUIT_DataObject*
   getApp()->objectBrowser()->updateTree( root );
 }
 
+/*!Context menu popup.*/
 void SalomeApp_Module::contextMenuPopup( const QString& client, QPopupMenu* menu, QString& /*title*/ )
 {
   SalomeApp_Selection* sel = createSelection();
@@ -131,11 +151,13 @@ void SalomeApp_Module::contextMenuPopup( const QString& client, QPopupMenu* menu
   delete sel;
 }
 
+/*!Create and return instance of SalomeApp_Selection.*/
 SalomeApp_Selection* SalomeApp_Module::createSelection() const
 {
   return new SalomeApp_Selection();
 }
 
+/*!Add preference to preferences.*/
 int SalomeApp_Module::addPreference( const QString& label )
 {
   SalomeApp_Preferences* pref = preferences();
@@ -149,6 +171,7 @@ int SalomeApp_Module::addPreference( const QString& label )
   return pref->addPreference( label, catId );
 }
 
+/*!Add preference to preferences.*/
 int SalomeApp_Module::addPreference( const QString& label, const int pId, const int type,
                                     const QString& section, const QString& param )
 {
@@ -159,6 +182,7 @@ int SalomeApp_Module::addPreference( const QString& label, const int pId, const
   return pref->addPreference( moduleName(), label, pId, type, section, param );
 }
 
+/*!Gets property of preferences.*/
 QVariant SalomeApp_Module::preferenceProperty( const int id, const QString& prop ) const
 {
   QVariant var;
@@ -168,6 +192,8 @@ QVariant SalomeApp_Module::preferenceProperty( const int id, const QString& prop
   return var;
 }
 
+
+/*!Set property of preferences.*/
 void SalomeApp_Module::setPreferenceProperty( const int id, const QString& prop, const QVariant& var )
 {
   SalomeApp_Preferences* pref = preferences();
index 7ac60246213037c116f0bc6601f8ba9eff094085..e6b62ed130ed04c22599d5443a928b06d7d54ec9 100644 (file)
@@ -29,8 +29,7 @@ class SalomeApp_Application;
 class SalomeApp_Preferences;
 class SalomeApp_SelectionManager;
 
-/*
-  Class : SalomeApp_Module
+/*!
   Description : Base class for all salome modules
 */
 
@@ -46,20 +45,19 @@ public:
   virtual void                        windows( QMap<int, int>& ) const;
   virtual void                        viewManagers( QStringList& ) const;
 
-  // engineIOR() should be a pure virtual method, to avoid logical errors!
-  //
-  // Implementation in derived classes can return the following values:
-  // "" (empty string)   - means that this is a light module, default engine should be used for interaction with SALOMEDS persistence
-  // "-1"                - means that this is a light module, SALOMEDS persistence is not used at all
-  // module`s engine IOR - means that this is a standard SALOME module with a CORBA engine
-  //
+  /*! engineIOR() should be a pure virtual method, to avoid logical errors!\n
+   * Implementation in derived classes can return the following values:\n
+   * module`s engine IOR - means that this is a standard SALOME module with a CORBA engine
+   * \li "" (empty string)   - means that this is a light module, default engine should be used for interaction with SALOMEDS persistence
+   * \li "-1"                - means that this is a light module, SALOMEDS persistence is not used at all\n
+   */
   virtual QString                     engineIOR() const = 0;
 
   virtual void                        contextMenuPopup( const QString&, QPopupMenu*, QString& );
 
   virtual void                        createPreferences();
 
-  // Convenient shortcuts
+  /*! Convenient shortcuts*/
   SalomeApp_Application*              getApp() const;
   
   void                                updateObjBrowser( bool = true, SUIT_DataObject* = 0 );
index f806cbade70d8d3bc9bd27d6ed2af050ac8f5277..f9c2d1e48683697a2067906d35f325cc17a7b3ab 100644 (file)
@@ -17,6 +17,7 @@
 #include <qpixmap.h>
 using namespace std;
 
+/*!Default icon*/
 static const char* const default_icon[] = { 
 "48 48 17 1",
 ". c None",
@@ -87,9 +88,9 @@ static const char* const default_icon[] = {
 
 //==============================================================================================================================
 /*!
- *  SalomeApp_ModuleDlg::SalomeApp_ModuleDlg
+ *  SalomeApp_ModuleDlg::SalomeApp_ModuleDlg \n
  *
- *  Constructor
+ *  Constructor.
  */
 //==============================================================================================================================
 SalomeApp_ModuleDlg::SalomeApp_ModuleDlg ( QWidget * parent, const QString& component, const QPixmap icon )
index 925a1390d16f28d5dbe5a53674611660e06fe69e..cf0a5775cb5b1f7f3ff2f90db94a03670014cef6 100644 (file)
@@ -19,7 +19,7 @@ class QPushButton;
 
 //=================================================================================
 // class    : SalomeApp_NameDlg
-// purpose  : Common <Rename> dialog box class
+/*! purpose  : Common <Rename> dialog box class*/
 //=================================================================================
 class SalomeApp_NameDlg : public QDialog
 { 
index 8ae0c9affe1c50569ec531db7a1d506f71789590..7387934665815890c891665dba98bc311851a550 100644 (file)
@@ -4,15 +4,20 @@
 #include "SalomeApp_DataObject.h"
 #include "SalomeApp_DataOwner.h"
 
+/*!
+  Constructor.
+*/
 SalomeApp_OBFilter::SalomeApp_OBFilter( SalomeApp_SelectionMgr* theSelMgr )
 {
   mySelMgr = theSelMgr;
 }
 
+/*!Destructor.*/
 SalomeApp_OBFilter::~SalomeApp_OBFilter()
 {
 }
 
+/*!Checks: data object is ok?*/
 bool SalomeApp_OBFilter::isOk( const SUIT_DataObject* theDataObj ) const
 {
   const SalomeApp_DataObject* obj = dynamic_cast<const SalomeApp_DataObject*>( theDataObj );
index 5caa0ade32a932f439b294bf42ed1436ae3e9083..9c77418a047501e22227d02f7e00ac9ddc7a3f86 100644 (file)
@@ -7,6 +7,9 @@
 
 #include <SUIT_DataObjectIterator.h>
 
+/*!
+  Constructor
+*/
 SalomeApp_OBSelector::SalomeApp_OBSelector( OB_Browser* ob, SUIT_SelectionMgr* mgr )
 : SUIT_Selector( mgr, ob ),
   myBrowser( ob )
@@ -16,16 +19,24 @@ SalomeApp_OBSelector::SalomeApp_OBSelector( OB_Browser* ob, SUIT_SelectionMgr* m
   }    
 }
 
+/*!
+  Destructor
+*/
 SalomeApp_OBSelector::~SalomeApp_OBSelector()
 {
 }
 
+/*!
+  Gets browser.
+*/
 OB_Browser* SalomeApp_OBSelector::browser() const
 {
   return myBrowser;
 }
 
-
+/*!
+  Gets selection.
+*/
 void SalomeApp_OBSelector::getSelection( SUIT_DataOwnerPtrList& list ) const
 {
   if ( !myBrowser )
@@ -45,6 +56,7 @@ void SalomeApp_OBSelector::getSelection( SUIT_DataOwnerPtrList& list ) const
   }
 }
 
+/*!Sets selection.*/
 void SalomeApp_OBSelector::setSelection( const SUIT_DataOwnerPtrList& list )
 {
   if ( !myBrowser )
@@ -64,11 +76,13 @@ void SalomeApp_OBSelector::setSelection( const SUIT_DataOwnerPtrList& list )
   myBrowser->setSelected( objList );
 }
 
+/*!On selection changed.*/
 void SalomeApp_OBSelector::onSelectionChanged()
 {
   selectionChanged();
 }
 
+/*!Fill entries.*/
 void SalomeApp_OBSelector::fillEntries( QMap<QString, SalomeApp_DataObject*>& entires )
 {
   entires.clear();
index 3120d05f7e2f30c7976c61008dc1f8bc14ad2b89..312d4fef5966c67d462d1db03dca53e2eed8074b 100644 (file)
@@ -18,6 +18,7 @@ public:
 
   OB_Browser*  browser() const;
 
+  /*!Return "ObjectBrowser"*/
   virtual QString type() const { return "ObjectBrowser"; }
 
 private slots:
index b394d5b3de35513e6ca07dae9fac8f27a9cc03e4..56ceb353d67e08faac9be7576e5657534278cf11 100644 (file)
@@ -7,7 +7,9 @@
 #include <AIS_ListOfInteractive.hxx>
 #include <AIS_ListIteratorOfListOfInteractive.hxx>
 
-
+/*!
+  Constructor
+*/
 SalomeApp_OCCSelector::SalomeApp_OCCSelector( OCCViewer_Viewer* viewer, SUIT_SelectionMgr* mgr )
 : SUIT_Selector( mgr, viewer ),
   myViewer( viewer )
@@ -16,20 +18,28 @@ SalomeApp_OCCSelector::SalomeApp_OCCSelector( OCCViewer_Viewer* viewer, SUIT_Sel
     connect( myViewer, SIGNAL( selectionChanged() ), this, SLOT( onSelectionChanged() ) );
 }
 
+/*!
+  Destructor.
+*/
 SalomeApp_OCCSelector::~SalomeApp_OCCSelector()
 {
 }
 
+/*!
+  Gets viewer.
+*/
 OCCViewer_Viewer* SalomeApp_OCCSelector::viewer() const
 {
   return myViewer;
 }
 
+/*!On selection changed.*/
 void SalomeApp_OCCSelector::onSelectionChanged()
 {
   selectionChanged();
 }
 
+/*!Gets selection list.*/
 void SalomeApp_OCCSelector::getSelection( SUIT_DataOwnerPtrList& aList ) const
 {
   if ( !myViewer )
@@ -46,6 +56,7 @@ void SalomeApp_OCCSelector::getSelection( SUIT_DataOwnerPtrList& aList ) const
     }
 }
 
+/*!Sets selection list.*/
 void SalomeApp_OCCSelector::setSelection( const SUIT_DataOwnerPtrList& aList )
 {
   if ( !myViewer )
@@ -77,6 +88,7 @@ void SalomeApp_OCCSelector::setSelection( const SUIT_DataOwnerPtrList& aList )
   myViewer->setObjectsSelected( aSelList );
 }
 
+/*!Gets entry ob object.*/
 QString SalomeApp_OCCSelector::entry( const Handle(AIS_InteractiveObject)& anAIS ) const
 {
   if ( anAIS.IsNull() || !anAIS->HasOwner() )
index e6c59a030b279080cc0d686d74a25daca8039768..d48cf410bdab02175bead80f32a8bfd2bad636b2 100755 (executable)
@@ -7,21 +7,33 @@
 
 #include <qlayout.h>
 
+/*!
+  Constructor.Initialize by resource manager and parent QWidget.
+*/
 SalomeApp_Preferences::SalomeApp_Preferences( QtxResourceMgr* resMgr, QWidget* parent )
 : QtxListResourceEdit( resMgr, parent )
 {
 }
 
+/*!
+  Destructor.
+*/
 SalomeApp_Preferences::~SalomeApp_Preferences()
 {
 }
 
+/*!
+  Adds preference.
+*/
 int SalomeApp_Preferences::addPreference( const QString& label, const int pId, const int type,
                                          const QString& section, const QString& param )
 {
   return addItem( label, pId, type, section, param );
 }
 
+/*!
+  Adds preference.
+*/
 int SalomeApp_Preferences::addPreference( const QString& mod, const QString& label, const int pId,
                                          const int type, const QString& section, const QString& param )
 {
@@ -31,6 +43,9 @@ int SalomeApp_Preferences::addPreference( const QString& mod, const QString& lab
   return id;
 }
 
+/*!
+  Checks: is preferences has module with name \a mod.
+*/
 bool SalomeApp_Preferences::hasModule( const QString& mod ) const
 {
   bool res = false;
@@ -39,15 +54,18 @@ bool SalomeApp_Preferences::hasModule( const QString& mod ) const
   return res;
 }
 
+/*!Do nothing.*/
 void SalomeApp_Preferences::onHelp()
 {
 }
 
+/*!Store preferences on apply.*/
 void SalomeApp_Preferences::onApply()
 {
   store();
 }
 
+/*!Emit preference changed.*/
 void SalomeApp_Preferences::changedResources( const QMap<Item*, QString>& map )
 {
   for ( QMap<Item*, QString>::ConstIterator it = map.begin(); it != map.end(); ++it )
@@ -59,6 +77,7 @@ void SalomeApp_Preferences::changedResources( const QMap<Item*, QString>& map )
   }
 }
 
+/*!Gets module name by \a id, if exist.*/
 QString SalomeApp_Preferences::module( const int id ) const
 {
   QString mod;
index 8f7d5d5e735953fa1f7ba3bfec36877bed2b8787..1914fb4f7baabaf8c8168f6a611c752415641d46 100755 (executable)
@@ -8,6 +8,9 @@
 #include <qvbox.h>
 #include <qlayout.h>
 
+/*!
+  Constructor.
+*/
 SalomeApp_PreferencesDlg::SalomeApp_PreferencesDlg( SalomeApp_Preferences* prefs, QWidget* parent )
 : QtxDialog( parent, 0, true, false, OK | Cancel | Apply ),
 myPrefs( prefs )
@@ -29,6 +32,9 @@ myPrefs( prefs )
   connect( this, SIGNAL( dlgApply() ), this, SLOT( onApply() ) );
 }
 
+/*!
+  Destructor.
+*/
 SalomeApp_PreferencesDlg::~SalomeApp_PreferencesDlg()
 {
   if ( !myPrefs )
@@ -38,6 +44,7 @@ SalomeApp_PreferencesDlg::~SalomeApp_PreferencesDlg()
   myPrefs = 0;
 }
 
+/*!Show dialog.*/
 void SalomeApp_PreferencesDlg::show()
 {
   myPrefs->retrieve();
@@ -46,6 +53,7 @@ void SalomeApp_PreferencesDlg::show()
   QtxDialog::show();
 }
 
+/*!Store preferences on accept.*/
 void SalomeApp_PreferencesDlg::accept()
 {
   QtxDialog::accept();
@@ -53,6 +61,7 @@ void SalomeApp_PreferencesDlg::accept()
   myPrefs->store();
 }
 
+/*!Reject. Restore preferences from backup.*/
 void SalomeApp_PreferencesDlg::reject()
 {
   QtxDialog::reject();
@@ -60,10 +69,12 @@ void SalomeApp_PreferencesDlg::reject()
   myPrefs->fromBackup();
 }
 
+/*!Do nothing.*/
 void SalomeApp_PreferencesDlg::onHelp()
 {
 }
 
+/*!Store preferences on apply.*/
 void SalomeApp_PreferencesDlg::onApply()
 {
   myPrefs->store();
index 68ae7ab0838578c7a38a888cdcd1086a61cc860a..16c798f23f9e5a7fcca0e3131f8b3f0cf7d0c089 100755 (executable)
@@ -10,6 +10,7 @@
 
 class SalomeApp_Preferences;
 
+/*!Preferences dialog.*/
 class SALOMEAPP_EXPORT SalomeApp_PreferencesDlg : public QtxDialog
 {
   Q_OBJECT
index 1adef677b6aa24e2ab9f5edb1798386898aae575..7cf6ce66deb9234d7a25e34e84d94aded25c87a1 100755 (executable)
@@ -45,13 +45,16 @@ SalomeApp_PyInterp::SalomeApp_PyInterp(): PythonConsole_PyInterp()
 {
 }
 
+/*!
+ * Destructor.
+ */
 SalomeApp_PyInterp::~SalomeApp_PyInterp()
 {
 }
  
-/*!
+/*!\class SalomeApp_PyInterp
  * EDF-CCAR
- * When SALOME uses multi Python interpreter feature,
+ * Wasashen SALOME uses multi Python interpreter feature,
  * Every study has its own interpreter and thread state (_tstate = Py_NewInterpreter())
  * This is fine because every study has its own modules (sys.modules) stdout and stderr
  * BUT some Python modules must be imported only once. In multi interpreter context Python
@@ -70,7 +73,7 @@ SalomeApp_PyInterp::~SalomeApp_PyInterp()
 
 bool SalomeApp_PyInterp::initContext()
 {
-  /*
+  /*!
    * The GIL is assumed to be held
    * It is the caller responsability caller to acquire the GIL
    * It will still be held on initContext output
index 3a45e9ecff3cf446c0391cb23a8fb7af414e7cd1..2395fc377ed6da10d6cf9b1587c828ef68f54958 100644 (file)
@@ -9,15 +9,24 @@
 #include "SUIT_Session.h"
 #include "SUIT_ViewWindow.h"
 
+/*!
+  Constructor
+*/
 SalomeApp_Selection::SalomeApp_Selection()
 : myStudy( 0 )
 {
 }
 
+/*!
+  Destructor.
+*/
 SalomeApp_Selection::~SalomeApp_Selection()
 {
 }
 
+/*!
+  Initializetion.
+*/
 void SalomeApp_Selection::init( const QString& client, SalomeApp_SelectionMgr* mgr)
 {
   myPopupClient = client;
@@ -42,16 +51,25 @@ void SalomeApp_Selection::init( const QString& client, SalomeApp_SelectionMgr* m
   }
 }
 
+/*!
+  Gets count of entries.
+*/
 int SalomeApp_Selection::count() const
 {
   return myEntries.count();
 }
 
+/*!
+  Gets QtxValue();
+*/
 QtxValue SalomeApp_Selection::param( const int, const QString& p ) const
 {
   return QtxValue();
 }
 
+/*!
+  Gets global parameters. client, isActiveView, activeView etc.
+*/
 QtxValue SalomeApp_Selection::globalParam( const QString& p ) const
 {
   if      ( p == "client" )        return QtxValue( myPopupClient );
@@ -60,10 +78,16 @@ QtxValue SalomeApp_Selection::globalParam( const QString& p ) const
   else                             return QtxPopupMgr::Selection::globalParam( p );
 }
 
+/*!
+  Do nothing.
+*/
 void SalomeApp_Selection::processOwner( const SalomeApp_DataOwner* )
 {
 }
 
+/*!
+  Gets entry with index \a index.
+*/
 QString SalomeApp_Selection::entry( const int index ) const
 {
   if ( index >= 0 && index < count() )
@@ -71,6 +95,9 @@ QString SalomeApp_Selection::entry( const int index ) const
   return QString();
 }
 
+/*!
+  Gets type of active view manager.
+*/
 QString SalomeApp_Selection::activeViewType() const
 {
   SUIT_ViewWindow* win = activeVW();
@@ -82,6 +109,9 @@ QString SalomeApp_Selection::activeViewType() const
   return QString::null;
 }
 
+/*!
+  Gets active view window.
+*/
 SUIT_ViewWindow* SalomeApp_Selection::activeVW() const
 {
   SUIT_Session* session = SUIT_Session::session();
index b3fca5bc91727ca546325d6317f15ff5e36703c0..15fa8646c47fe06484bb175b80e47d6d5d5f5c6a 100644 (file)
@@ -53,6 +53,7 @@ public:
 
 protected:
   QString                        entry( const int ) const;
+  /*!Gets study.*/
   SalomeApp_Study*               study() const { return myStudy; }
   QString                        activeViewType() const;
   SUIT_ViewWindow*               activeVW() const;
index 8c432279c675703b1c5f8e00ba8194bd94450162..c186fad5f6970b682838cca6da229d65f4ff37ae 100644 (file)
 
 #include "SALOMEDSClient.hxx"
 
+/*!
+  Constructor.
+*/
 SalomeApp_SelectionMgr::SalomeApp_SelectionMgr( SalomeApp_Application* app, const bool fb )
 : SUIT_SelectionMgr( fb ),
 myApp( app )
 {
 }
 
+/*!
+  Destructor.
+*/
 SalomeApp_SelectionMgr::~SalomeApp_SelectionMgr()
 {
 }
 
+/*!
+  Gets application.
+*/
 SalomeApp_Application* SalomeApp_SelectionMgr::application() const
 {
   return myApp;
 }
 
-/*
-  get all selected objects from selection manager
-
+/*!
+  Get all selected objects from selection manager
 */
 void SalomeApp_SelectionMgr::selectedObjects( SALOME_ListIO& theList, const QString& theType ) const
 {
@@ -56,6 +64,9 @@ void SalomeApp_SelectionMgr::selectedObjects( SALOME_ListIO& theList, const QStr
   }
 }
 
+/*!
+  Append selected objects.
+*/
 void SalomeApp_SelectionMgr::setSelectedObjects( const SALOME_ListIO& lst, const bool append )
 {
   SUIT_DataOwnerPtrList owners;
@@ -68,6 +79,9 @@ void SalomeApp_SelectionMgr::setSelectedObjects( const SALOME_ListIO& lst, const
   setSelected( owners, append );
 }
 
+/*!
+  Emit current selection changed.
+*/
 void SalomeApp_SelectionMgr::selectionChanged( SUIT_Selector* theSel )
 {
   SUIT_SelectionMgr::selectionChanged( theSel );
@@ -75,9 +89,8 @@ void SalomeApp_SelectionMgr::selectionChanged( SUIT_Selector* theSel )
   emit currentSelectionChanged();
 }
 
-/*
+/*!
   get map of indexes for the given SALOME_InteractiveObject
-
 */
 void SalomeApp_SelectionMgr::GetIndexes( const Handle(SALOME_InteractiveObject)& IObject, 
                                         TColStd_IndexedMapOfInteger& theIndex)
@@ -97,9 +110,8 @@ void SalomeApp_SelectionMgr::GetIndexes( const Handle(SALOME_InteractiveObject)&
   
 }
 
-/*
+/*!
   get map of indexes for the given entry of SALOME_InteractiveObject
-
 */
 void SalomeApp_SelectionMgr::GetIndexes( const QString& theEntry, TColStd_IndexedMapOfInteger& theIndex )
 {
@@ -118,6 +130,9 @@ void SalomeApp_SelectionMgr::GetIndexes( const QString& theEntry, TColStd_Indexe
 
 }
 
+/*!
+  Add or remove interactive objects from selection manager.
+*/
 bool SalomeApp_SelectionMgr::AddOrRemoveIndex( const Handle(SALOME_InteractiveObject)& IObject, 
                                               const TColStd_MapOfInteger& theIndexes, 
                                               bool modeShift)
@@ -163,9 +178,8 @@ bool SalomeApp_SelectionMgr::AddOrRemoveIndex( const Handle(SALOME_InteractiveOb
 
 }
 
-/*
+/*!
   select 'subobjects' with given indexes
-
 */
 void SalomeApp_SelectionMgr::selectObjects( const Handle(SALOME_InteractiveObject)& IObject, 
                                            TColStd_IndexedMapOfInteger theIndex, bool append )
@@ -185,9 +199,8 @@ void SalomeApp_SelectionMgr::selectObjects( const Handle(SALOME_InteractiveObjec
 
 }
 
-/*
+/*!
   select 'subobjects' with given indexes
-
 */
 void SalomeApp_SelectionMgr::selectObjects( MapIOOfMapOfInteger theMapIO, bool append )
 {
@@ -210,9 +223,8 @@ void SalomeApp_SelectionMgr::selectObjects( MapIOOfMapOfInteger theMapIO, bool a
 
 }
 
-/*
+/*!
   get map of selected subowners : object's entry <-> map of indexes
-
 */
 void SalomeApp_SelectionMgr::selectedSubOwners( MapEntryOfMapOfInteger& theMap )
 {
index 539412f9d93000bac04e09b185068795479a9786..d01cdd9f8c6421863209f96e634d0b354e7fd606 100644 (file)
 
 #include "utilities.h"
 
+/*!
+  Constructor.
+*/
 SalomeApp_Study::SalomeApp_Study( SUIT_Application* app )
 : CAM_Study( app )
 {
 }  
 
+/*!
+  Destructor.
+*/
 SalomeApp_Study::~SalomeApp_Study()
 {
 }
 
+/*!
+  Gets study id.
+*/
 int SalomeApp_Study::id() const
 {
   int id = -1;
@@ -29,11 +38,17 @@ int SalomeApp_Study::id() const
   return id;
 }
 
+/*!
+  Gets studyDS pointer.
+*/
 _PTR(Study) SalomeApp_Study::studyDS() const
 {
   return myStudyDS;
 }
 
+/*!
+  Create document.
+*/
 void SalomeApp_Study::createDocument()
 {
   MESSAGE( "openDocument" );
@@ -57,7 +72,7 @@ void SalomeApp_Study::createDocument()
 
 //=======================================================================
 // name    : openDocument
-// Purpose : Open document
+/*! Purpose : Open document*/
 //=======================================================================
 bool SalomeApp_Study::openDocument( const QString& theFileName )
 {
@@ -91,7 +106,7 @@ bool SalomeApp_Study::openDocument( const QString& theFileName )
 
 //=======================================================================
 // name    : loadDocument
-// Purpose : Connects GUI study to SALOMEDS one already loaded into StudyManager
+/*! Purpose : Connects GUI study to SALOMEDS one already loaded into StudyManager*/
 //=======================================================================
 bool SalomeApp_Study::loadDocument( const QString& theStudyName )
 {
@@ -129,7 +144,7 @@ bool SalomeApp_Study::loadDocument( const QString& theStudyName )
 
 //=======================================================================
 // name    : saveDocumentAs
-// Purpose : Save document
+/*! Purpose : Save document */
 //=======================================================================
 bool SalomeApp_Study::saveDocumentAs( const QString& theFileName )
 {
@@ -159,7 +174,7 @@ bool SalomeApp_Study::saveDocumentAs( const QString& theFileName )
 
 //=======================================================================
 // name    : saveDocument
-// Purpose : Save document
+/*! Purpose : Save document */
 //=======================================================================
 void SalomeApp_Study::saveDocument()
 {
@@ -186,7 +201,7 @@ void SalomeApp_Study::saveDocument()
 
 //================================================================
 // Function : closeDocument
-// Purpose  : 
+/*! Purpose  : Close document */
 //================================================================
 void SalomeApp_Study::closeDocument(bool permanently)
 {
@@ -208,7 +223,7 @@ void SalomeApp_Study::closeDocument(bool permanently)
 
 //================================================================
 // Function : isModified
-// Purpose  : 
+/*! Purpose  : Check data model on modifications.*/
 //================================================================
 bool SalomeApp_Study::isModified() const
 {
@@ -226,7 +241,7 @@ bool SalomeApp_Study::isModified() const
 
 //================================================================
 // Function : isSaved
-// Purpose  : 
+/*! Purpose  : Check: data model is saved?*/
 //================================================================
 bool SalomeApp_Study::isSaved() const
 {
@@ -242,11 +257,17 @@ bool SalomeApp_Study::isSaved() const
   return isAllSaved; 
 }
 
+/*!
+  Set studyDS.
+*/
 void SalomeApp_Study::setStudyDS( const _PTR(Study)& s )
 {
   myStudyDS = s;
 }
 
+/*!
+  Insert data model.
+*/
 void SalomeApp_Study::dataModelInserted (const CAM_DataModel* dm)
 {
   MESSAGE("SalomeApp_Study::dataModelInserted() : module name() = " << dm->module()->name());
@@ -272,6 +293,9 @@ void SalomeApp_Study::dataModelInserted (const CAM_DataModel* dm)
   }
 }
 
+/*!
+  Open data model
+*/
 bool SalomeApp_Study::openDataModel( const QString& studyName, CAM_DataModel* dm )
 {
   if (!dm)
@@ -287,6 +311,9 @@ bool SalomeApp_Study::openDataModel( const QString& studyName, CAM_DataModel* dm
   return false;
 }
 
+/*!
+  Create new study name.
+*/
 QString SalomeApp_Study::newStudyName() const
 {
   std::vector<std::string> studies = SalomeApp_Application::studyMgr()->GetOpenStudies();
index 616af1f86b29a5d7a2c074de891824d25ec0b65d..35015ee04347cdd6c1b59d076d8321651b08bcfb 100644 (file)
@@ -30,7 +30,7 @@ using namespace std;
 class SalomeApp_PropItem : public SalomeApp_ListViewItem
 {
 public:
-// constructor  
+  /*! constructor  */
   SalomeApp_PropItem(SalomeApp_ListView* parent,
                     const QString       theName,
                     const bool          theEditable,
@@ -39,7 +39,7 @@ public:
   {
     setUserType(theUserType);
   }
-// constructor
+  /*! constructor */
   SalomeApp_PropItem(SalomeApp_ListView*     parent,
                     SalomeApp_ListViewItem* after,
                     const QString     theName,
@@ -49,7 +49,7 @@ public:
   {
     setUserType(theUserType);
   }
-// fills widget with initial values (list or single value)
+  /*! fills widget with initial values (list or single value)*/
   void fillWidgetWithValues( SalomeApp_EntityEdit* theWidget )
   {
     QStringList list;
@@ -105,7 +105,7 @@ public:
       }
     }
   }
-// finishes editing of entity
+  /*! finishes editing of entity */
   virtual UpdateType finishEditing( SalomeApp_EntityEdit* theWidget ) {
     if ( getUserType() == SalomeApp_StudyPropertiesDlg::prpModificationsId )
       return utCancel;
@@ -114,6 +114,7 @@ public:
   }
 };
 
+/*!Constructor. Initialize study properties dialog.*/
 SalomeApp_StudyPropertiesDlg::SalomeApp_StudyPropertiesDlg(QWidget* parent)
      : QDialog(parent, "", TRUE, WStyle_Customize | WStyle_NormalBorder | WStyle_Title | WStyle_SysMenu ),
        myChanged( false )
@@ -154,10 +155,16 @@ SalomeApp_StudyPropertiesDlg::SalomeApp_StudyPropertiesDlg(QWidget* parent)
   connect(myCancelBtn, SIGNAL(clicked()), this, SLOT(reject()));
 }
 
+/*!
+  Destructor.
+*/
 SalomeApp_StudyPropertiesDlg::~SalomeApp_StudyPropertiesDlg()
 {
 }
 
+/*!
+  Data initializetion for dialog.(Study author's name, date of creation etc.)
+*/
 void SalomeApp_StudyPropertiesDlg::initData()
 {
   bool hasData = myStudyDoc;
@@ -226,11 +233,17 @@ void SalomeApp_StudyPropertiesDlg::initData()
   myOKBtn->setEnabled(hasData);
 }
 
+/*!
+  accept data. Return true.
+*/
 bool SalomeApp_StudyPropertiesDlg::acceptData()
 {
   return TRUE;
 }
 
+/*!
+  Fill properties attributes.
+*/
 void SalomeApp_StudyPropertiesDlg::onOK()
 {
   myPropList->accept();
@@ -262,6 +275,9 @@ void SalomeApp_StudyPropertiesDlg::onOK()
   }
 }
 
+/*!
+  Check is properties chenged?
+*/
 bool SalomeApp_StudyPropertiesDlg::propChanged() {
   _PTR(AttributeStudyProperties) propAttr = myStudyDoc->GetProperties();
   if ( propAttr ) {
index 67e2a32b62a09f69ff959494fa27f6a8e7116e6e..950dac641a1c8edde2525a21f4938f00e2eea835 100644 (file)
@@ -6,6 +6,9 @@
 
 #include <utilities.h>
 
+/*!
+  Convert QColor to Quantity_Color, if QColor is valid.
+*/
 Quantity_Color SalomeApp_Tools::color( const QColor& c )
 {
        Quantity_Color aColor;
@@ -14,11 +17,17 @@ Quantity_Color SalomeApp_Tools::color( const QColor& c )
        return aColor;
 }
 
+/*!
+  Convert Quantity_Color to QColor.
+*/
 QColor SalomeApp_Tools::color( const Quantity_Color& c )
 {
        return QColor( (int)( c.Red() * 255 ), (int)( c.Green() * 255 ), (int)( c.Blue() * 255 ) );
 }
 
+/*!
+  Gets message on exception \a S_ex.
+*/
 QString SalomeApp_Tools::ExceptionToString( const SALOME::SALOME_Exception& S_ex )
 {
   QString message;
@@ -59,6 +68,9 @@ QString SalomeApp_Tools::ExceptionToString( const SALOME::SALOME_Exception& S_ex
   return message;
 }
 
+/*!
+  Gets message box on exception \a S_ex.
+*/
 void SalomeApp_Tools::QtCatchCorbaException( const SALOME::SALOME_Exception& S_ex )
 {
   QString message = ExceptionToString( S_ex );
index 6a7b8e0e61519a1164053d129d9cc9f3e777aeaa..20b3c6c0ab5c0c1bdc8d5ee18fd77f0861c22c1d 100644 (file)
@@ -13,6 +13,9 @@
 #include <SALOMEconfig.h>
 #include CORBA_CLIENT_HEADER(SALOME_Exception)
 
+/*! 
+  Class which provide color converter and exception message box.
+*/
 class SALOMEAPP_EXPORT SalomeApp_Tools : public SUIT_Tools
 {
 public:
index 13d4a730db47e1d9cf7c9cedf14384cef5885e30..92216b6675fcfa0740a217a53bae50f6d124acee 100644 (file)
@@ -5,16 +5,25 @@
 
 #include <SALOMEDS_SObject.hxx>
 
+/*!
+  Constructor.
+*/
 SalomeApp_TypeFilter::SalomeApp_TypeFilter( SalomeApp_Study* study, const QString& kind )
   : SalomeApp_Filter( study ) 
 {
   myKind = kind;
 }
 
+/*!
+  Destructor.
+*/
 SalomeApp_TypeFilter::~SalomeApp_TypeFilter()
 {
 }
 
+/*!
+  Check: data owner is valid?
+*/
 bool SalomeApp_TypeFilter::isOk( const SUIT_DataOwner* sOwner ) const
 {  
   const SalomeApp_DataOwner* owner = dynamic_cast<const SalomeApp_DataOwner*> ( sOwner );
index 59efba9d2ef0965e617a3dc272499feb6809c6a7..da06557582b8ea2883cbc035f519775a5ac72387 100644 (file)
@@ -5,6 +5,9 @@
 
 #include "SalomeApp_Filter.h"
 
+/*!
+  Class which provide data owner validation.
+*/
 class SALOMEAPP_EXPORT SalomeApp_TypeFilter: public SalomeApp_Filter
 {
 public:
index a23a150ad548b1d7500e6a44c443d4b480a5365f..c3d53c11dcb1987bf90ad93259489a066bf380f7 100644 (file)
@@ -21,6 +21,9 @@ static int MYDEBUG = 1;
 static int MYDEBUG = 0;
 #endif
 
+/*!
+  Constructor.
+*/
 SalomeApp_SVTKDataOwner
 ::SalomeApp_SVTKDataOwner( const Handle(SALOME_InteractiveObject)& theIO,
                           const TColStd_IndexedMapOfInteger& theIds,
@@ -33,11 +36,17 @@ SalomeApp_SVTKDataOwner
   myIds = theIds; // workaround - there is no constructor copy for the container
 }
 
+/*!
+  Destuctor.
+*/
 SalomeApp_SVTKDataOwner
 ::~SalomeApp_SVTKDataOwner()
 {
 }
 
+/*!
+  Gets actor pointer.
+*/
 SALOME_Actor* 
 SalomeApp_SVTKDataOwner
 ::GetActor() const
@@ -45,7 +54,9 @@ SalomeApp_SVTKDataOwner
   return myActor.GetPointer();
 }
 
-
+/*!
+  Constructor.
+*/
 SalomeApp_VTKSelector
 ::SalomeApp_VTKSelector( SVTK_Viewer* viewer, 
                         SUIT_SelectionMgr* mgr ): 
@@ -56,11 +67,17 @@ SalomeApp_VTKSelector
     connect( myViewer, SIGNAL( selectionChanged() ), this, SLOT( onSelectionChanged() ) );
 }
 
+/*!
+  Destructor.
+*/
 SalomeApp_VTKSelector
 ::~SalomeApp_VTKSelector()
 {
 }
 
+/*!
+  Gets viewer.
+*/
 SVTK_Viewer* 
 SalomeApp_VTKSelector
 ::viewer() const
@@ -68,6 +85,9 @@ SalomeApp_VTKSelector
   return myViewer;
 }
 
+/*!
+  Gets type of salome vtk viewer.
+*/
 QString
 SalomeApp_VTKSelector
 ::type() const
@@ -75,6 +95,9 @@ SalomeApp_VTKSelector
   return SVTK_Viewer::Type(); 
 }
 
+/*!
+  On selection changed.
+*/
 void
 SalomeApp_VTKSelector
 ::onSelectionChanged()
@@ -82,6 +105,9 @@ SalomeApp_VTKSelector
   selectionChanged();
 }
 
+/*!
+  Gets list of selected data owners.(output \a aList).
+*/
 void
 SalomeApp_VTKSelector
 ::getSelection( SUIT_DataOwnerPtrList& aList ) const
@@ -112,6 +138,9 @@ SalomeApp_VTKSelector
   }
 }
 
+/*!
+  Sets selection to selector from data owner list \a theList.
+*/
 void 
 SalomeApp_VTKSelector
 ::setSelection( const SUIT_DataOwnerPtrList& theList )
index 00420acc0d79574981ec4fa89d600aa7931a16c9..1834c979fa27248d96df0135857e29c9860bcccf 100644 (file)
@@ -16,6 +16,9 @@
 class SALOME_Actor;
 class SVTK_Viewer;
 
+/*!
+  Provide salome vtk data owner list.
+*/
 class SalomeApp_SVTKDataOwner : public SalomeApp_DataOwner
 {
  public:
@@ -25,11 +28,13 @@ class SalomeApp_SVTKDataOwner : public SalomeApp_DataOwner
                             SALOME_Actor* theActor = NULL);
     virtual ~SalomeApp_SVTKDataOwner();
 
+    /*!Gets dataowners ids list.*/
     const TColStd_IndexedMapOfInteger& GetIds() const
     {
       return myIds;
     }
 
+    /*!Gets selection mode.*/
     Selection_Mode GetMode() const 
     { 
       return mySelectionMode; 
@@ -44,6 +49,9 @@ class SalomeApp_SVTKDataOwner : public SalomeApp_DataOwner
 };
 
 
+/*!
+  Provide salome vtk selection of data owners.
+*/
 class SALOMEAPP_EXPORT SalomeApp_VTKSelector : public SUIT_Selector
 {
   Q_OBJECT;
index 1e80f727f057aa156ca8a6aad1c7c2266a4ae77d..79b7868671f7c517e225b40d183c4f07509ca107 100644 (file)
@@ -3,6 +3,9 @@
 #include <qobjectlist.h>
 #include <qwidgetstack.h>
 
+/*!
+  Constructor.
+*/
 SalomeApp_WidgetContainer::SalomeApp_WidgetContainer( const int type, QWidget* parent )
 : QDockWindow( QDockWindow::InDock, parent ),
 myType( type )
@@ -11,10 +14,16 @@ myType( type )
   myStack->show();
 }
 
+/*!
+  Destructor.
+*/
 SalomeApp_WidgetContainer::~SalomeApp_WidgetContainer()
 {
 }
 
+/*!
+  Checks: is widget container is empty?
+*/
 bool SalomeApp_WidgetContainer::isEmpty() const
 {
   const QObjectList* lst = myStack->children();
@@ -30,16 +39,26 @@ bool SalomeApp_WidgetContainer::isEmpty() const
   return res;
 }
 
+/*!
+  Gets type of widget container.
+*/
 int SalomeApp_WidgetContainer::type() const
 {
   return myType;
 }
 
+/*!
+  Checks: is container contains widget with id \a id.
+*/
 bool SalomeApp_WidgetContainer::contains( const int id ) const
 {
   return myStack->widget( id ) != 0;
 }
 
+/*!
+ * Insert widget(\a wid with id \a id) to container.And return id of widget in stack.
+ *\warning remove widget with id = \a id , if it was in container.
+ */
 int SalomeApp_WidgetContainer::insert( const int id, QWidget* wid )
 {
   if ( id == -1 || !wid )
@@ -57,6 +76,9 @@ int SalomeApp_WidgetContainer::insert( const int id, QWidget* wid )
   return stackId;
 }
 
+/*!
+  Remove widget from stack by widget \a id.
+*/
 void SalomeApp_WidgetContainer::remove( const int id )
 {
   remove( myStack->widget( id ) );
@@ -64,6 +86,9 @@ void SalomeApp_WidgetContainer::remove( const int id )
   setCaption( myStack->visibleWidget() ? myStack->visibleWidget()->caption() : QString::null );
 }
 
+/*!
+  Remove widget(\a wid) from stack.
+*/
 void SalomeApp_WidgetContainer::remove( QWidget* wid )
 {
   myStack->removeWidget( wid );
@@ -71,6 +96,9 @@ void SalomeApp_WidgetContainer::remove( QWidget* wid )
   setCaption( myStack->visibleWidget() ? myStack->visibleWidget()->caption() : QString::null );
 }
 
+/*!
+  Raise widget with id = \a id.
+*/
 void SalomeApp_WidgetContainer::activate( const int id )
 {
   myStack->raiseWidget( id );
@@ -78,6 +106,9 @@ void SalomeApp_WidgetContainer::activate( const int id )
   setCaption( myStack->visibleWidget() ? myStack->visibleWidget()->caption() : QString::null );
 }
 
+/*!
+  Raise widget (\a wid).
+*/
 void SalomeApp_WidgetContainer::activate( QWidget* wid )
 {
   myStack->raiseWidget( wid );
@@ -85,11 +116,17 @@ void SalomeApp_WidgetContainer::activate( QWidget* wid )
   setCaption( myStack->visibleWidget() ? myStack->visibleWidget()->caption() : QString::null );
 }
 
+/*!
+  Gets widget from container list(stack) by id = \a id.
+*/
 QWidget* SalomeApp_WidgetContainer::widget( const int id ) const
 {
   return myStack->widget( id );
 }
 
+/*!
+  Gets visible widget.
+*/
 QWidget* SalomeApp_WidgetContainer::active() const
 {
   return myStack->visibleWidget();
index 9a4311ba62c7156609feec9562f439c407f39e33..67e15f4bca98583b55fd0864ad2efd987e56f056 100644 (file)
@@ -8,6 +8,9 @@
 class QWidget;
 class QWidgetStack;
 
+/*!
+  Class which privade widget container.
+*/
 class SALOMEAPP_EXPORT SalomeApp_WidgetContainer : public QDockWindow
 {
     Q_OBJECT