From 0732fb7e8dfe89e7d027c7d621ef4c14e5935aa0 Mon Sep 17 00:00:00 2001 From: asl Date: Thu, 4 May 2006 07:17:28 +0000 Subject: [PATCH] doxygen comments --- src/LightApp/LightApp_AboutDlg.h | 8 +++---- src/LightApp/LightApp_Displayer.h | 5 +++++ src/LightApp/LightApp_GLSelector.h | 4 ++++ src/LightApp/LightApp_ModuleDlg.h | 5 +++++ src/LightApp/LightApp_OBFilter.h | 4 ++++ src/LightApp/LightApp_OBSelector.h | 4 ++++ src/LightApp/LightApp_OCCSelector.h | 4 ++++ src/LightApp/LightApp_Preferences.h | 5 +++++ src/LightApp/LightApp_PreferencesDlg.h | 4 ++++ src/LightApp/LightApp_Selection.h | 8 ++++++- src/LightApp/LightApp_SelectionMgr.h | 4 ++++ src/LightApp/LightApp_ShowHideOp.h | 6 ++++++ src/LightApp/LightApp_Study.h | 5 +++++ src/LightApp/LightApp_VTKSelector.h | 3 ++- src/OBJECT/Handle_SALOME_AISObject.hxx | 8 +++++++ src/OBJECT/Handle_SALOME_AISShape.hxx | 8 +++++++ src/OBJECT/Handle_SALOME_Filter.hxx | 8 +++++++ .../Handle_SALOME_InteractiveObject.hxx | 8 +++++++ src/OBJECT/Handle_SALOME_ListNodeOfListIO.hxx | 8 +++++++ src/OBJECT/Handle_SALOME_TypeFilter.hxx | 8 +++++++ src/OBJECT/SALOME_ListIO.hxx | 4 ++++ src/OBJECT/SALOME_ListNodeOfListIO.hxx | 5 ++++- src/Session/InquireServersQThread.cxx | 21 +++++++++++++++++++ src/Session/SalomeApp_Engine_i.cxx | 3 +++ 24 files changed, 143 insertions(+), 7 deletions(-) diff --git a/src/LightApp/LightApp_AboutDlg.h b/src/LightApp/LightApp_AboutDlg.h index c59cc938b..869151599 100644 --- a/src/LightApp/LightApp_AboutDlg.h +++ b/src/LightApp/LightApp_AboutDlg.h @@ -10,12 +10,12 @@ #include -/*! - Descr: LightApp help about dialog -*/ - class QLabel; +/*! + \class LightApp_AboutDlg + LightApp help about dialog +*/ class LIGHTAPP_EXPORT LightApp_AboutDlg : public QtxDialog { Q_OBJECT diff --git a/src/LightApp/LightApp_Displayer.h b/src/LightApp/LightApp_Displayer.h index f0896eb8f..cc1eb89d1 100644 --- a/src/LightApp/LightApp_Displayer.h +++ b/src/LightApp/LightApp_Displayer.h @@ -24,6 +24,11 @@ class QString; +/*! + \class LightApp_Displayer + Uniform mechanism of display/erase of objects in different views. + Objects are specified by string entry +*/ class LightApp_Displayer : public SALOME_Displayer { public: diff --git a/src/LightApp/LightApp_GLSelector.h b/src/LightApp/LightApp_GLSelector.h index f58bb761a..7447490ee 100644 --- a/src/LightApp/LightApp_GLSelector.h +++ b/src/LightApp/LightApp_GLSelector.h @@ -28,6 +28,10 @@ #include #include +/*! + \class LightApp_GLSelector + Custom selector to get/set selection from GL viewer +*/ class LIGHTAPP_EXPORT LightApp_GLSelector : public SUIT_Selector { Q_OBJECT diff --git a/src/LightApp/LightApp_ModuleDlg.h b/src/LightApp/LightApp_ModuleDlg.h index 526f16f22..135e58c40 100644 --- a/src/LightApp/LightApp_ModuleDlg.h +++ b/src/LightApp/LightApp_ModuleDlg.h @@ -19,6 +19,11 @@ class QFrame; class QLabel; class QPushButton; +/*! + \class LightApp_ModuleDlg + Dialog allows to choose action on module activation when there is no document. + It is possible to create new document, to open existing or to cancel module activation +*/ class LIGHTAPP_EXPORT LightApp_ModuleDlg : public QDialog { Q_OBJECT diff --git a/src/LightApp/LightApp_OBFilter.h b/src/LightApp/LightApp_OBFilter.h index 4ea292132..69db84c2c 100644 --- a/src/LightApp/LightApp_OBFilter.h +++ b/src/LightApp/LightApp_OBFilter.h @@ -24,6 +24,10 @@ class LightApp_SelectionMgr; +/*! + \class LightApp_OBFilter + Custom Object Browser filter, that checks correctness of object by all filters set in selection manager +*/ class LIGHTAPP_EXPORT LightApp_OBFilter: public OB_Filter { public: diff --git a/src/LightApp/LightApp_OBSelector.h b/src/LightApp/LightApp_OBSelector.h index e8fc44371..a3928ccd9 100644 --- a/src/LightApp/LightApp_OBSelector.h +++ b/src/LightApp/LightApp_OBSelector.h @@ -27,6 +27,10 @@ class OB_Browser; class LightApp_DataObject; +/*! + \class LightApp_OBSelector + Custom selector to get/set selection from object browser +*/ class LIGHTAPP_EXPORT LightApp_OBSelector : public SUIT_Selector { Q_OBJECT diff --git a/src/LightApp/LightApp_OCCSelector.h b/src/LightApp/LightApp_OCCSelector.h index 5a53992e0..619a4739e 100644 --- a/src/LightApp/LightApp_OCCSelector.h +++ b/src/LightApp/LightApp_OCCSelector.h @@ -27,6 +27,10 @@ class Handle_AIS_InteractiveObject; +/*! + \class LightApp_OCCSelector + Custom selector to get/set selection from OCC viewer +*/ class LIGHTAPP_EXPORT LightApp_OCCSelector : public SUIT_Selector { Q_OBJECT diff --git a/src/LightApp/LightApp_Preferences.h b/src/LightApp/LightApp_Preferences.h index 2aa97f143..bcd39127b 100644 --- a/src/LightApp/LightApp_Preferences.h +++ b/src/LightApp/LightApp_Preferences.h @@ -31,6 +31,11 @@ class QtxResourceMgr; +/*! + \class LightApp_Preferences + Custom preference container. Assign each preference category with module. + Emits signal on preference changing +*/ class LIGHTAPP_EXPORT LightApp_Preferences : public QtxListResourceEdit { Q_OBJECT diff --git a/src/LightApp/LightApp_PreferencesDlg.h b/src/LightApp/LightApp_PreferencesDlg.h index 91c9d3439..3a89ac82c 100644 --- a/src/LightApp/LightApp_PreferencesDlg.h +++ b/src/LightApp/LightApp_PreferencesDlg.h @@ -28,6 +28,10 @@ class LightApp_Preferences; +/*! + \class LightApp_PreferencesDlg + Dialog for preferences edition +*/ class LIGHTAPP_EXPORT LightApp_PreferencesDlg : public QtxDialog { Q_OBJECT diff --git a/src/LightApp/LightApp_Selection.h b/src/LightApp/LightApp_Selection.h index 79cc0fac6..606f4c27a 100644 --- a/src/LightApp/LightApp_Selection.h +++ b/src/LightApp/LightApp_Selection.h @@ -37,7 +37,13 @@ class LightApp_DataOwner; class LightApp_Study; class SUIT_ViewWindow; - +/*! + \class LightApp_Selection + Custom selection class, allowing to build popup with rules on the base + of owners selected in all selectors (popup client has more priority). + It is able to return values of standard object properties + (isVisible,isComponent,canBeDisplayed,isReference, etc) +*/ class LIGHTAPP_EXPORT LightApp_Selection : public QtxPopupMgr::Selection { public: diff --git a/src/LightApp/LightApp_SelectionMgr.h b/src/LightApp/LightApp_SelectionMgr.h index 8546dadfe..20d03efa6 100644 --- a/src/LightApp/LightApp_SelectionMgr.h +++ b/src/LightApp/LightApp_SelectionMgr.h @@ -36,6 +36,10 @@ class LightApp_Application; +/*! + Custom selection manager, allowing to work with object selection + (additionally to data owners) and to access to sub-selection of objects +*/ class LIGHTAPP_EXPORT LightApp_SelectionMgr : public SUIT_SelectionMgr { Q_OBJECT diff --git a/src/LightApp/LightApp_ShowHideOp.h b/src/LightApp/LightApp_ShowHideOp.h index cac7b918d..d84ef52c8 100644 --- a/src/LightApp/LightApp_ShowHideOp.h +++ b/src/LightApp/LightApp_ShowHideOp.h @@ -23,6 +23,12 @@ #include "LightApp_Operation.h" class LightApp_Displayer; + +/*! + \class LightApp_ShowHideOp + Standard operation allowing to show/hide selected objects + corresponding to any module with help of module displayer +*/ class LIGHTAPP_EXPORT LightApp_ShowHideOp : public LightApp_Operation { Q_OBJECT diff --git a/src/LightApp/LightApp_Study.h b/src/LightApp/LightApp_Study.h index 2e0ac3226..2b8cf30c4 100644 --- a/src/LightApp/LightApp_Study.h +++ b/src/LightApp/LightApp_Study.h @@ -32,6 +32,11 @@ class SUIT_Application; class CAM_DataModel; +/*! + Custom study, using for open/close of documents HDF format. + Data of each module can be saved to different files, those + after that are combined into one HDF file +*/ class LIGHTAPP_EXPORT LightApp_Study : public CAM_Study { Q_OBJECT diff --git a/src/LightApp/LightApp_VTKSelector.h b/src/LightApp/LightApp_VTKSelector.h index fd4247b7f..96582d555 100644 --- a/src/LightApp/LightApp_VTKSelector.h +++ b/src/LightApp/LightApp_VTKSelector.h @@ -72,7 +72,8 @@ class LIGHTAPP_EXPORT LightApp_SVTKDataOwner : public LightApp_DataOwner /*! - Provide vtk selection of data owners. + \class LightApp_VTKSelector + Custom selector to get/set selection from object browser */ class LIGHTAPP_EXPORT LightApp_VTKSelector : public SUIT_Selector { diff --git a/src/OBJECT/Handle_SALOME_AISObject.hxx b/src/OBJECT/Handle_SALOME_AISObject.hxx index 98dede911..1fd37e08b 100755 --- a/src/OBJECT/Handle_SALOME_AISObject.hxx +++ b/src/OBJECT/Handle_SALOME_AISObject.hxx @@ -40,10 +40,18 @@ class Standard_Transient; class Handle_Standard_Type; +/*! + \class Handle(AIS_InteractiveObject) + Smart pointer (handle) to AIS_InteractiveObject +*/ class Handle(AIS_InteractiveObject); class SALOME_AISObject; Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_AISObject); +/*! + \class Handle(SALOME_AISObject) + Smart pointer (handle) to SALOME_AISObject +*/ class Handle(SALOME_AISObject) : public Handle(AIS_InteractiveObject) { public: inline void* operator new(size_t,void* anAddress) diff --git a/src/OBJECT/Handle_SALOME_AISShape.hxx b/src/OBJECT/Handle_SALOME_AISShape.hxx index 65a1bc6d9..525fbada5 100755 --- a/src/OBJECT/Handle_SALOME_AISShape.hxx +++ b/src/OBJECT/Handle_SALOME_AISShape.hxx @@ -40,10 +40,18 @@ class Standard_Transient; class Handle_Standard_Type; +/*! + \class Handle(AIS_Shape) + Smart pointer (handle) to AIS_Shape +*/ class Handle(AIS_Shape); class SALOME_AISShape; Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_AISShape); +/*! + \class Handle(SALOME_AISShape) + Smart pointer (handle) to SALOME_AISShape +*/ class Handle(SALOME_AISShape) : public Handle(AIS_Shape) { public: inline void* operator new(size_t,void* anAddress) diff --git a/src/OBJECT/Handle_SALOME_Filter.hxx b/src/OBJECT/Handle_SALOME_Filter.hxx index 49eb7b877..dc169db53 100644 --- a/src/OBJECT/Handle_SALOME_Filter.hxx +++ b/src/OBJECT/Handle_SALOME_Filter.hxx @@ -40,10 +40,18 @@ class Standard_Transient; class Handle_Standard_Type; +/*! + \class Handle(MMgt_TShared) + Smart pointer (handle) to MMgt_TShared +*/ class Handle(MMgt_TShared); class SALOME_Filter; Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_Filter); +/*! + \class Handle(SALOME_Filter) + Smart pointer (handle) to SALOME_Filter +*/ class Handle(SALOME_Filter) : public Handle(MMgt_TShared) { public: inline void* operator new(size_t,void* anAddress) diff --git a/src/OBJECT/Handle_SALOME_InteractiveObject.hxx b/src/OBJECT/Handle_SALOME_InteractiveObject.hxx index 767dfec3f..e4f3622fb 100755 --- a/src/OBJECT/Handle_SALOME_InteractiveObject.hxx +++ b/src/OBJECT/Handle_SALOME_InteractiveObject.hxx @@ -40,10 +40,18 @@ class Standard_Transient; class Handle_Standard_Type; +/*! + \class Handle(MMgt_TShared) + Smart pointer (handle) to MMgt_TShared +*/ class Handle(MMgt_TShared); class SALOME_InteractiveObject; Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_InteractiveObject); +/*! + \class Handle(SALOME_InteractiveObject) + Smart pointer (handle) to SALOME_InteractiveObject +*/ class Handle(SALOME_InteractiveObject) : public Handle(MMgt_TShared) { public: void* operator new(size_t,void* anAddress) diff --git a/src/OBJECT/Handle_SALOME_ListNodeOfListIO.hxx b/src/OBJECT/Handle_SALOME_ListNodeOfListIO.hxx index 0df5e98be..986a4da6e 100644 --- a/src/OBJECT/Handle_SALOME_ListNodeOfListIO.hxx +++ b/src/OBJECT/Handle_SALOME_ListNodeOfListIO.hxx @@ -40,10 +40,18 @@ class Standard_Transient; class Handle_Standard_Type; +/*! + \class Handle(TCollection_MapNode) + Smart pointer (handle) to TCollection_MapNode +*/ class Handle(TCollection_MapNode); class SALOME_ListNodeOfListIO; Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_ListNodeOfListIO); +/*! + \class Handle(SALOME_ListNodeOfListIO) + Smart pointer (handle) to SALOME_ListNodeOfListIO +*/ class Handle(SALOME_ListNodeOfListIO) : public Handle(TCollection_MapNode) { public: void* operator new(size_t,void* anAddress) diff --git a/src/OBJECT/Handle_SALOME_TypeFilter.hxx b/src/OBJECT/Handle_SALOME_TypeFilter.hxx index 4fdd91368..b41dc2bac 100644 --- a/src/OBJECT/Handle_SALOME_TypeFilter.hxx +++ b/src/OBJECT/Handle_SALOME_TypeFilter.hxx @@ -40,10 +40,18 @@ class Standard_Transient; class Handle_Standard_Type; +/*! + \class Handle(SALOME_Filter) + Smart pointer (handle) to SALOME_Filter +*/ class Handle(SALOME_Filter); class SALOME_TypeFilter; Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_TypeFilter); +/*! + \class Handle(SALOME_TypeFilter) + Smart pointer (handle) to SALOME_TypeFilter +*/ class Handle(SALOME_TypeFilter) : public Handle(SALOME_Filter) { public: inline void* operator new(size_t,void* anAddress) diff --git a/src/OBJECT/SALOME_ListIO.hxx b/src/OBJECT/SALOME_ListIO.hxx index e028e243f..43cc9f8ff 100644 --- a/src/OBJECT/SALOME_ListIO.hxx +++ b/src/OBJECT/SALOME_ListIO.hxx @@ -55,6 +55,10 @@ class SALOME_ListNodeOfListIO; #include #endif +/*! + \class SALOME_ListIO + List of SALOME interactive objects +*/ class SALOME_ListIO { public: diff --git a/src/OBJECT/SALOME_ListNodeOfListIO.hxx b/src/OBJECT/SALOME_ListNodeOfListIO.hxx index 9aed956f8..7734399e4 100644 --- a/src/OBJECT/SALOME_ListNodeOfListIO.hxx +++ b/src/OBJECT/SALOME_ListNodeOfListIO.hxx @@ -47,7 +47,10 @@ class SALOME_InteractiveObject; class SALOME_ListIO; class SALOME_ListIteratorOfListIO; - +/*! + \class SALOME_ListNodeOfListIO + Auxiliary class, represents list node for SALOME_ListIO +*/ class SALOME_ListNodeOfListIO : public TCollection_MapNode { public: diff --git a/src/Session/InquireServersQThread.cxx b/src/Session/InquireServersQThread.cxx index 43bee4c5d..b022744f7 100755 --- a/src/Session/InquireServersQThread.cxx +++ b/src/Session/InquireServersQThread.cxx @@ -140,6 +140,10 @@ InquireServersGUI::InquireServersGUI() myThread->start(); } +/*! + Sets pixmap of splash screen + \param pix - new pixmap +*/ void InquireServersGUI::setPixmap( QPixmap pix ) { if ( !pix.isNull() ) @@ -159,6 +163,11 @@ InquireServersGUI::~InquireServersGUI() delete myThread; } +/*! + Gets parameters from qApp + \param _argc - variable to return number of arguments + \param _argv - variable to return array of arguments +*/ void InquireServersGUI::getArgs( int& _argc, char *** _argv) { _argc = qApp->argc(); @@ -175,6 +184,9 @@ void InquireServersGUI::ClickOnCancel() qApp->exit( 1 ); } +/*! + Custom event filter +*/ void InquireServersGUI::customEvent( QCustomEvent* pe ) { switch( pe->type() ) @@ -209,6 +221,9 @@ void InquireServersGUI::customEvent( QCustomEvent* pe ) } } +/*! + \return status of thread exit +*/ int InquireServersGUI::getExitStatus() { return myThread->getExitStatus(); @@ -266,6 +281,9 @@ InquireServersQThread::InquireServersQThread( InquireServersGUI* r ) } } +/*! + The main loop of this thread +*/ void InquireServersQThread::run() { while ( IsChecking && receiver ) @@ -313,6 +331,9 @@ void InquireServersQThread::run() qApp->exit( myExitStatus ); } +/*! + Stops this thread +*/ void InquireServersQThread::stop() { IsChecking = false; diff --git a/src/Session/SalomeApp_Engine_i.cxx b/src/Session/SalomeApp_Engine_i.cxx index 4fc9bbac8..d23e815df 100644 --- a/src/Session/SalomeApp_Engine_i.cxx +++ b/src/Session/SalomeApp_Engine_i.cxx @@ -169,6 +169,9 @@ void SalomeApp_Engine_i::SetListOfFiles (const ListOfFiles theListOfFiles, mapOfListOfFiles[componentName] = theListOfFiles; } +/*! + \return shared instance of engine +*/ SalomeApp_Engine_i* SalomeApp_Engine_i::GetInstance() { return myInstance; -- 2.39.2