From 83b022b15cfd77512967f4328484371e46c525ae Mon Sep 17 00:00:00 2001 From: vsv Date: Thu, 29 Jan 2015 12:30:38 +0300 Subject: [PATCH] Fix for selection with 'N' key and update documentation --- src/ModuleBase/ModuleBase_DoubleSpinBox.h | 1 + src/ModuleBase/ModuleBase_Filter.h | 1 + src/ModuleBase/ModuleBase_FilterCustom.h | 1 + src/ModuleBase/ModuleBase_FilterFace.h | 1 + src/ModuleBase/ModuleBase_FilterFactory.h | 1 + src/ModuleBase/ModuleBase_FilterLinearEdge.h | 1 + src/ModuleBase/ModuleBase_FilterMulti.h | 1 + src/ModuleBase/ModuleBase_FilterNoConsructionSubShapes.h | 1 + src/ModuleBase/ModuleBase_FilterShapeType.h | 1 + src/ModuleBase/ModuleBase_IModule.h | 1 + src/ModuleBase/ModuleBase_IPrefMgr.h | 1 + src/ModuleBase/ModuleBase_IPropertyPanel.h | 1 + src/ModuleBase/ModuleBase_ISelection.h | 1 + src/ModuleBase/ModuleBase_IViewWindow.h | 1 + src/ModuleBase/ModuleBase_IViewer.h | 1 + src/ModuleBase/ModuleBase_IWorkshop.h | 1 + src/ModuleBase/ModuleBase_ModelWidget.h | 1 + src/ModuleBase/ModuleBase_Operation.h | 3 ++- src/ModuleBase/ModuleBase_OperationDescription.h | 1 + src/ModuleBase/ModuleBase_Preferences.h | 3 +++ src/ModuleBase/ModuleBase_ResultPrs.h | 1 + src/ModuleBase/ModuleBase_SelectionValidator.h | 1 + src/ModuleBase/ModuleBase_Tools.h | 2 ++ src/ModuleBase/ModuleBase_ViewerFilters.h | 3 +++ src/ModuleBase/ModuleBase_ViewerPrs.h | 2 +- src/ModuleBase/ModuleBase_WidgetBoolValue.h | 1 + src/ModuleBase/ModuleBase_WidgetChoice.h | 1 + src/ModuleBase/ModuleBase_WidgetDoubleValue.h | 1 + src/ModuleBase/ModuleBase_WidgetFactory.h | 1 + src/ModuleBase/ModuleBase_WidgetFileSelector.h | 1 + src/ModuleBase/ModuleBase_WidgetLabel.h | 1 + src/ModuleBase/ModuleBase_WidgetLineEdit.h | 1 + src/ModuleBase/ModuleBase_WidgetMultiSelector.h | 1 + src/ModuleBase/ModuleBase_WidgetShapeSelector.h | 1 + src/NewGeom/NewGeom_Module.h | 1 + src/NewGeom/NewGeom_OCCSelector.h | 1 + src/NewGeom/NewGeom_SalomeViewer.h | 2 ++ src/PartSet/PartSet_Validators.h | 6 ++++++ src/XGUI/XGUI_ContextMenuMgr.h | 1 + src/XGUI/XGUI_ErrorDialog.h | 1 + src/XGUI/XGUI_PropertyPanel.h | 1 + src/XGUI/XGUI_QtEvents.h | 1 + src/XGUI/XGUI_SalomeConnector.h | 1 + src/XGUI/XGUI_Selection.h | 1 + src/XGUI/XGUI_Tools.h | 1 + src/XGUI/XGUI_ViewerProxy.h | 1 + 46 files changed, 58 insertions(+), 2 deletions(-) diff --git a/src/ModuleBase/ModuleBase_DoubleSpinBox.h b/src/ModuleBase/ModuleBase_DoubleSpinBox.h index 5eb2d976e..11de54784 100644 --- a/src/ModuleBase/ModuleBase_DoubleSpinBox.h +++ b/src/ModuleBase/ModuleBase_DoubleSpinBox.h @@ -13,6 +13,7 @@ /** +* \ingroup GUI * An extension and customozation of QDoubleSpinBox class */ class MODULEBASE_EXPORT ModuleBase_DoubleSpinBox : public QDoubleSpinBox diff --git a/src/ModuleBase/ModuleBase_Filter.h b/src/ModuleBase/ModuleBase_Filter.h index 4b684e272..e7a1a639b 100644 --- a/src/ModuleBase/ModuleBase_Filter.h +++ b/src/ModuleBase/ModuleBase_Filter.h @@ -14,6 +14,7 @@ #include /** + * \ingroup GUI * This object is assigned by the name * in the XML file to the specific attribute or to the whole feature. * If isOK method of the filter returns "false", it is signalized in user interface diff --git a/src/ModuleBase/ModuleBase_FilterCustom.h b/src/ModuleBase/ModuleBase_FilterCustom.h index 6683207cc..6de1620cc 100644 --- a/src/ModuleBase/ModuleBase_FilterCustom.h +++ b/src/ModuleBase/ModuleBase_FilterCustom.h @@ -12,6 +12,7 @@ #include "ModuleBase_Filter.h" /** +* \ingroup GUI * This is a child of ModuleBase_Filter to be used in the factory of filters. Despite of other * child it does not create the internal filter itself, it get it from the constructor argument. * This is useful for custom filters, which are not the standard OCC filters. It is not necessary diff --git a/src/ModuleBase/ModuleBase_FilterFace.h b/src/ModuleBase/ModuleBase_FilterFace.h index c73f602f1..f3a6ef427 100644 --- a/src/ModuleBase/ModuleBase_FilterFace.h +++ b/src/ModuleBase/ModuleBase_FilterFace.h @@ -14,6 +14,7 @@ #include /** +* \ingroup GUI * A class of a viewer filter by faces */ class ModuleBase_FilterFace: public ModuleBase_Filter diff --git a/src/ModuleBase/ModuleBase_FilterFactory.h b/src/ModuleBase/ModuleBase_FilterFactory.h index 043bd64ad..c1a7e3601 100644 --- a/src/ModuleBase/ModuleBase_FilterFactory.h +++ b/src/ModuleBase/ModuleBase_FilterFactory.h @@ -17,6 +17,7 @@ #include /** + * \ingroup GUI * Allows to get a selection filter by the feature identifier and * the attribute identifier (if attribute is validated). * All accessible filters must be registered by the ID string first. diff --git a/src/ModuleBase/ModuleBase_FilterLinearEdge.h b/src/ModuleBase/ModuleBase_FilterLinearEdge.h index 10bc1d32e..0efb1a545 100644 --- a/src/ModuleBase/ModuleBase_FilterLinearEdge.h +++ b/src/ModuleBase/ModuleBase_FilterLinearEdge.h @@ -14,6 +14,7 @@ #include /** +* \ingroup GUI * A class of a viewer filter by linear edges */ class ModuleBase_FilterLinearEdge: public ModuleBase_Filter diff --git a/src/ModuleBase/ModuleBase_FilterMulti.h b/src/ModuleBase/ModuleBase_FilterMulti.h index 9a69d59ba..5b9e7dd01 100644 --- a/src/ModuleBase/ModuleBase_FilterMulti.h +++ b/src/ModuleBase/ModuleBase_FilterMulti.h @@ -14,6 +14,7 @@ #include /** +* \ingroup GUI * An implementation of filter which support using of several filters according to OR statement */ class ModuleBase_FilterMulti: public ModuleBase_Filter diff --git a/src/ModuleBase/ModuleBase_FilterNoConsructionSubShapes.h b/src/ModuleBase/ModuleBase_FilterNoConsructionSubShapes.h index 4d5d3af91..e2d4cbf1d 100644 --- a/src/ModuleBase/ModuleBase_FilterNoConsructionSubShapes.h +++ b/src/ModuleBase/ModuleBase_FilterNoConsructionSubShapes.h @@ -16,6 +16,7 @@ class ModuleBase_IWorkshop; /** +* \ingroup GUI * \class ModuleBase_FilterNoConsructionSubShapes * A filter which provides filtering of selection in 3d viewer. * Installing of this filter lets to select objects which belong to diff --git a/src/ModuleBase/ModuleBase_FilterShapeType.h b/src/ModuleBase/ModuleBase_FilterShapeType.h index 9cf3208eb..771217cd7 100644 --- a/src/ModuleBase/ModuleBase_FilterShapeType.h +++ b/src/ModuleBase/ModuleBase_FilterShapeType.h @@ -14,6 +14,7 @@ #include /** +* \ingroup GUI * A class of a viewer filter by shape type */ class ModuleBase_FilterShapeType: public ModuleBase_Filter diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h index 29cdc430d..191b02e5f 100644 --- a/src/ModuleBase/ModuleBase_IModule.h +++ b/src/ModuleBase/ModuleBase_IModule.h @@ -23,6 +23,7 @@ class ModuleBase_Operation; class ModuleBase_IWorkshop; /** + * \ingroup GUI * Interface to a module */ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject diff --git a/src/ModuleBase/ModuleBase_IPrefMgr.h b/src/ModuleBase/ModuleBase_IPrefMgr.h index c2c23ba90..147defa4b 100644 --- a/src/ModuleBase/ModuleBase_IPrefMgr.h +++ b/src/ModuleBase/ModuleBase_IPrefMgr.h @@ -12,6 +12,7 @@ #include /** +* \ingroup GUI * An interface class which provides incapsulation of SUIT_PreferenceMgr class instance * It is used in order to make common interface to Preference manager in Salome * and this application diff --git a/src/ModuleBase/ModuleBase_IPropertyPanel.h b/src/ModuleBase/ModuleBase_IPropertyPanel.h index 22648e998..fe8a110e0 100644 --- a/src/ModuleBase/ModuleBase_IPropertyPanel.h +++ b/src/ModuleBase/ModuleBase_IPropertyPanel.h @@ -18,6 +18,7 @@ class ModuleBase_ModelWidget; /** +* \ingroup GUI * A class for Property panel object definition */ class MODULEBASE_EXPORT ModuleBase_IPropertyPanel : public QDockWidget diff --git a/src/ModuleBase/ModuleBase_ISelection.h b/src/ModuleBase/ModuleBase_ISelection.h index 5551999f4..e3190488a 100644 --- a/src/ModuleBase/ModuleBase_ISelection.h +++ b/src/ModuleBase/ModuleBase_ISelection.h @@ -19,6 +19,7 @@ #include /** +* \ingroup GUI * A class which provides access to selection. * A selection can be obtained as from a viewer as from Object browser in various forms */ diff --git a/src/ModuleBase/ModuleBase_IViewWindow.h b/src/ModuleBase/ModuleBase_IViewWindow.h index abf938d3b..89929982e 100644 --- a/src/ModuleBase/ModuleBase_IViewWindow.h +++ b/src/ModuleBase/ModuleBase_IViewWindow.h @@ -9,6 +9,7 @@ /** +* \ingroup GUI * Interface to ViewWindow object which contains 3d scene */ class ModuleBase_IViewWindow diff --git a/src/ModuleBase/ModuleBase_IViewer.h b/src/ModuleBase/ModuleBase_IViewer.h index c84a7d058..ba7ee1b28 100644 --- a/src/ModuleBase/ModuleBase_IViewer.h +++ b/src/ModuleBase/ModuleBase_IViewer.h @@ -14,6 +14,7 @@ class QContextMenuEvent; class ModuleBase_IViewWindow; /** + * \ingroup GUI * A Base object for definition of connector object to * Salome Viewer. Reimplemented in NewGeom_SalomeViewer class */ diff --git a/src/ModuleBase/ModuleBase_IWorkshop.h b/src/ModuleBase/ModuleBase_IWorkshop.h index e755062f6..b7f02f4a1 100644 --- a/src/ModuleBase/ModuleBase_IWorkshop.h +++ b/src/ModuleBase/ModuleBase_IWorkshop.h @@ -22,6 +22,7 @@ class ModuleBase_Operation; class ModuleBase_FilterFactory; /** + * \ingroup GUI * Class which provides access to Workshop object serveces */ class MODULEBASE_EXPORT ModuleBase_IWorkshop : public QObject diff --git a/src/ModuleBase/ModuleBase_ModelWidget.h b/src/ModuleBase/ModuleBase_ModelWidget.h index c4b2ec614..bb11733d9 100644 --- a/src/ModuleBase/ModuleBase_ModelWidget.h +++ b/src/ModuleBase/ModuleBase_ModelWidget.h @@ -20,6 +20,7 @@ class Config_WidgetAPI; class QKeyEvent; /**\class ModuleBase_ModelWidget + * \ingroup GUI * \brief An abstract custom widget class. This class realization is assumed to create some controls. * The controls values modification should send signal about values change. * diff --git a/src/ModuleBase/ModuleBase_Operation.h b/src/ModuleBase/ModuleBase_Operation.h index 77c8d3fe3..8842230b2 100644 --- a/src/ModuleBase/ModuleBase_Operation.h +++ b/src/ModuleBase/ModuleBase_Operation.h @@ -29,7 +29,8 @@ class ModuleBase_IViewer; class QKeyEvent; /*! - \class ModuleBase_Operation + * \class ModuleBase_Operation + * \ingroup GUI * \brief Base class for all operations * * Base class for all operations. If you perform an action it is reasonable to create diff --git a/src/ModuleBase/ModuleBase_OperationDescription.h b/src/ModuleBase/ModuleBase_OperationDescription.h index 65c87285d..7de7c3288 100644 --- a/src/ModuleBase/ModuleBase_OperationDescription.h +++ b/src/ModuleBase/ModuleBase_OperationDescription.h @@ -23,6 +23,7 @@ /*! * \class ModuleBase_OperationDescription + * \ingroup GUI * Description of operation from XML */ class MODULEBASE_EXPORT ModuleBase_OperationDescription diff --git a/src/ModuleBase/ModuleBase_Preferences.h b/src/ModuleBase/ModuleBase_Preferences.h index d156f5f70..d2f6cb9bd 100644 --- a/src/ModuleBase/ModuleBase_Preferences.h +++ b/src/ModuleBase/ModuleBase_Preferences.h @@ -23,6 +23,7 @@ typedef QPair ModuleBase_Pref; typedef QList ModuleBase_Prefs; //*********************************************************************** +/// \ingroup GUI /// Class for manipulation with preferences in the application class MODULEBASE_EXPORT ModuleBase_Preferences { @@ -70,6 +71,7 @@ private: }; //*********************************************************************** +/// \ingroup GUI /// Manager of preferences class MODULEBASE_EXPORT ModuleBase_PreferencesMgr : public SUIT_PreferenceMgr { @@ -102,6 +104,7 @@ Q_OBJECT }; //*********************************************************************** +/// \ingroup GUI /// Dialog box for preferences editing class MODULEBASE_EXPORT ModuleBase_PreferencesDlg : public QDialog { diff --git a/src/ModuleBase/ModuleBase_ResultPrs.h b/src/ModuleBase/ModuleBase_ResultPrs.h index f37bef1b4..2cc200c31 100644 --- a/src/ModuleBase/ModuleBase_ResultPrs.h +++ b/src/ModuleBase/ModuleBase_ResultPrs.h @@ -17,6 +17,7 @@ DEFINE_STANDARD_HANDLE(ModuleBase_ResultPrs, AIS_Shape) /** +* \ingroup GUI * A redefinition of standard AIS Interactive Object in order to provide specific behaviour * for wire presentations based in a one plane */ diff --git a/src/ModuleBase/ModuleBase_SelectionValidator.h b/src/ModuleBase/ModuleBase_SelectionValidator.h index 045e730e2..d1075c16c 100644 --- a/src/ModuleBase/ModuleBase_SelectionValidator.h +++ b/src/ModuleBase/ModuleBase_SelectionValidator.h @@ -16,6 +16,7 @@ #include /** +* \ingroup GUI * A validator of selection */ class ModuleBase_SelectionValidator : public ModelAPI_Validator diff --git a/src/ModuleBase/ModuleBase_Tools.h b/src/ModuleBase/ModuleBase_Tools.h index a0e250914..c6ad57e8c 100644 --- a/src/ModuleBase/ModuleBase_Tools.h +++ b/src/ModuleBase/ModuleBase_Tools.h @@ -27,8 +27,10 @@ MODULEBASE_EXPORT void zeroMargins(QLayout* theLayout); /** + * \ingroup GUI * Methods to modify a resource pixmap */ + //! Create composite pixmap. //! Pixmap \a theAdditionalIcon is drawn over pixmap \a dest with coordinates //! specified relatively to the upper left corner of \a theIcon. diff --git a/src/ModuleBase/ModuleBase_ViewerFilters.h b/src/ModuleBase/ModuleBase_ViewerFilters.h index da1ba9f04..1a215a4fc 100644 --- a/src/ModuleBase/ModuleBase_ViewerFilters.h +++ b/src/ModuleBase/ModuleBase_ViewerFilters.h @@ -20,6 +20,7 @@ class ModuleBase_IWorkshop; /** * \class ModuleBase_ShapeDocumentFilter +* \ingroup GUI * A filter which provides filtering of selection in 3d viewer. * Installing of this filter lets to select objects which belong to * currently active document or to global document @@ -46,6 +47,7 @@ protected: /** * \class ModuleBase_ShapeInPlaneFilter +* \ingroup GUI * A filter which provides filtering of selection in 3d viewer. * Installing of this filter lets to select of Vertexes and Edges which belongs to the given plane */ @@ -76,6 +78,7 @@ private: /** * \class ModuleBase_ObjectTypesFilter +* \ingroup GUI * A filter which provides filtering of selection in 3d viewer. * Installing of this filter lets to select only object of requested type * Accepts following objects types: diff --git a/src/ModuleBase/ModuleBase_ViewerPrs.h b/src/ModuleBase/ModuleBase_ViewerPrs.h index 3a189d37b..cd8751fe7 100644 --- a/src/ModuleBase/ModuleBase_ViewerPrs.h +++ b/src/ModuleBase/ModuleBase_ViewerPrs.h @@ -17,7 +17,7 @@ #include /**\class ModuleBase_ViewerPrs - * \ingroup Module base + * \ingroup GUI * \brief Presentation. Provides container to have feature, shape and/or selection owner. */ class ModuleBase_ViewerPrs diff --git a/src/ModuleBase/ModuleBase_WidgetBoolValue.h b/src/ModuleBase/ModuleBase_WidgetBoolValue.h index 5325b4d99..37b15780d 100644 --- a/src/ModuleBase/ModuleBase_WidgetBoolValue.h +++ b/src/ModuleBase/ModuleBase_WidgetBoolValue.h @@ -15,6 +15,7 @@ class QWidget; class QCheckBox; /** +* \ingroup GUI * Implementation of widget for boolean input (check box) */ class MODULEBASE_EXPORT ModuleBase_WidgetBoolValue : public ModuleBase_ModelWidget diff --git a/src/ModuleBase/ModuleBase_WidgetChoice.h b/src/ModuleBase/ModuleBase_WidgetChoice.h index 9b5206b08..3f13cc4af 100644 --- a/src/ModuleBase/ModuleBase_WidgetChoice.h +++ b/src/ModuleBase/ModuleBase_WidgetChoice.h @@ -15,6 +15,7 @@ class QLabel; class QComboBox; /** +* \ingroup GUI * Implementation of model widget for choice widget definition (combo box) * It can be defined as following: * \code diff --git a/src/ModuleBase/ModuleBase_WidgetDoubleValue.h b/src/ModuleBase/ModuleBase_WidgetDoubleValue.h index d956662a5..c9032e66a 100644 --- a/src/ModuleBase/ModuleBase_WidgetDoubleValue.h +++ b/src/ModuleBase/ModuleBase_WidgetDoubleValue.h @@ -17,6 +17,7 @@ class QLabel; class QTimer; /** +* \ingroup GUI * A class of property panel widget for double value input * It can be defined with "doublevalue" keyword. For example: * \code diff --git a/src/ModuleBase/ModuleBase_WidgetFactory.h b/src/ModuleBase/ModuleBase_WidgetFactory.h index 3fa399e98..1292cec57 100644 --- a/src/ModuleBase/ModuleBase_WidgetFactory.h +++ b/src/ModuleBase/ModuleBase_WidgetFactory.h @@ -22,6 +22,7 @@ class Config_WidgetAPI; class ModuleBase_IWorkshop; /** +* \ingroup GUI * A class for creation of widgets instances in for property panel using XML deskription of * a feature */ diff --git a/src/ModuleBase/ModuleBase_WidgetFileSelector.h b/src/ModuleBase/ModuleBase_WidgetFileSelector.h index 06ca8bf5c..3b183d703 100644 --- a/src/ModuleBase/ModuleBase_WidgetFileSelector.h +++ b/src/ModuleBase/ModuleBase_WidgetFileSelector.h @@ -21,6 +21,7 @@ class QWidget; class QLineEdit; /** +* \ingroup GUI * Implementation of model widget for open file widget. * It can be defined as following: * \code diff --git a/src/ModuleBase/ModuleBase_WidgetLabel.h b/src/ModuleBase/ModuleBase_WidgetLabel.h index c3489952e..8d7d4281f 100644 --- a/src/ModuleBase/ModuleBase_WidgetLabel.h +++ b/src/ModuleBase/ModuleBase_WidgetLabel.h @@ -13,6 +13,7 @@ class QLabel; /** +* \ingroup GUI * Implementation of model widget for a label control */ class MODULEBASE_EXPORT ModuleBase_WidgetLabel : public ModuleBase_ModelWidget diff --git a/src/ModuleBase/ModuleBase_WidgetLineEdit.h b/src/ModuleBase/ModuleBase_WidgetLineEdit.h index 0e47acbb8..a5955f84c 100644 --- a/src/ModuleBase/ModuleBase_WidgetLineEdit.h +++ b/src/ModuleBase/ModuleBase_WidgetLineEdit.h @@ -21,6 +21,7 @@ class QWidget; class QLineEdit; /** +* \ingroup GUI * Implementation of model widget for line edit widget. * It can be defined with "stringvalue" keyword. */ diff --git a/src/ModuleBase/ModuleBase_WidgetMultiSelector.h b/src/ModuleBase/ModuleBase_WidgetMultiSelector.h index b65b4812b..fa73d3759 100644 --- a/src/ModuleBase/ModuleBase_WidgetMultiSelector.h +++ b/src/ModuleBase/ModuleBase_WidgetMultiSelector.h @@ -33,6 +33,7 @@ class QAction; /** +* \ingroup GUI * Implementation of widget for shapes selection. This widget provides selection of several shapes. * It can be defined in XML file as following: * \code diff --git a/src/ModuleBase/ModuleBase_WidgetShapeSelector.h b/src/ModuleBase/ModuleBase_WidgetShapeSelector.h index f2dbb05c7..c6b5431d0 100644 --- a/src/ModuleBase/ModuleBase_WidgetShapeSelector.h +++ b/src/ModuleBase/ModuleBase_WidgetShapeSelector.h @@ -26,6 +26,7 @@ class QToolButton; class ModuleBase_IWorkshop; /** +* \ingroup GUI * Implementation of widget for shapes selection. * This type of widget can be defined in XML file with 'shape_selector' keyword. * For example: diff --git a/src/NewGeom/NewGeom_Module.h b/src/NewGeom/NewGeom_Module.h index 09cc7181b..3482c12e8 100644 --- a/src/NewGeom/NewGeom_Module.h +++ b/src/NewGeom/NewGeom_Module.h @@ -18,6 +18,7 @@ class NewGeom_OCCSelector; class OCCViewer_Viewer; /** + * \ingroup Salome * An implementation of SALOME connector class for implementation of * XGUI functionality as a module of SALOME */ diff --git a/src/NewGeom/NewGeom_OCCSelector.h b/src/NewGeom/NewGeom_OCCSelector.h index 59a3ee0a6..d27a62c79 100644 --- a/src/NewGeom/NewGeom_OCCSelector.h +++ b/src/NewGeom/NewGeom_OCCSelector.h @@ -8,6 +8,7 @@ #include /** +* \ingroup Salome * Redefinition of standard OCC selector in order to adapt it to NewGeom needs */ class NewGeom_EXPORT NewGeom_OCCSelector : public LightApp_OCCSelector diff --git a/src/NewGeom/NewGeom_SalomeViewer.h b/src/NewGeom/NewGeom_SalomeViewer.h index ca3675b9b..1809dd243 100644 --- a/src/NewGeom/NewGeom_SalomeViewer.h +++ b/src/NewGeom/NewGeom_SalomeViewer.h @@ -20,6 +20,7 @@ class OCCViewer_Viewer; class SUIT_ViewManager; /** +* \ingroup Salome * A class for providing access of NewGeom functionality to * SALOME view window functionality */ @@ -46,6 +47,7 @@ private: /** +* \ingroup Salome * A class for providing access of NewGeom functionality to * SALOME viewer functionality */ diff --git a/src/PartSet/PartSet_Validators.h b/src/PartSet/PartSet_Validators.h index 6334a87c7..1cb0f18f5 100644 --- a/src/PartSet/PartSet_Validators.h +++ b/src/PartSet/PartSet_Validators.h @@ -18,6 +18,7 @@ * Selector validators */ +//! \ingroup Module //! A class to validate a selection for Distance constraint operation class PartSet_DistanceValidator : public ModuleBase_SelectionValidator { @@ -25,6 +26,7 @@ class PartSet_DistanceValidator : public ModuleBase_SelectionValidator PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const; }; +//! \ingroup Module //! A class to validate a selection for Length constraint operation class PartSet_LengthValidator : public ModuleBase_SelectionValidator { @@ -32,6 +34,7 @@ class PartSet_LengthValidator : public ModuleBase_SelectionValidator PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const; }; +//! \ingroup Module //! A class to validate a selection for Perpendicular constraint operation class PartSet_PerpendicularValidator : public ModuleBase_SelectionValidator { @@ -39,6 +42,7 @@ class PartSet_PerpendicularValidator : public ModuleBase_SelectionValidator PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const; }; +//! \ingroup Module //! A class to validate a selection for Perpendicular constraint operation class PartSet_ParallelValidator : public ModuleBase_SelectionValidator { @@ -46,6 +50,7 @@ class PartSet_ParallelValidator : public ModuleBase_SelectionValidator PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const; }; +//! \ingroup Module //! A class to validate a selection for Perpendicular constraint operation class PartSet_RadiusValidator : public ModuleBase_SelectionValidator { @@ -53,6 +58,7 @@ class PartSet_RadiusValidator : public ModuleBase_SelectionValidator PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const; }; +//! \ingroup Module //! A class to validate a selection for Perpendicular constraint operation class PartSet_RigidValidator : public ModuleBase_SelectionValidator { diff --git a/src/XGUI/XGUI_ContextMenuMgr.h b/src/XGUI/XGUI_ContextMenuMgr.h index 0fe548e2a..bb620cd73 100644 --- a/src/XGUI/XGUI_ContextMenuMgr.h +++ b/src/XGUI/XGUI_ContextMenuMgr.h @@ -14,6 +14,7 @@ class QContextMenuEvent; class QMenu; /** + * \ingroup GUI * A claas wihich provides manement of context menu */ class XGUI_EXPORT XGUI_ContextMenuMgr : public QObject diff --git a/src/XGUI/XGUI_ErrorDialog.h b/src/XGUI/XGUI_ErrorDialog.h index b442effba..628495e2c 100644 --- a/src/XGUI/XGUI_ErrorDialog.h +++ b/src/XGUI/XGUI_ErrorDialog.h @@ -16,6 +16,7 @@ class QTextEdit; /** +* \ingroup GUI * A class of dialog to show error message */ class XGUI_ErrorDialog : public QDialog diff --git a/src/XGUI/XGUI_PropertyPanel.h b/src/XGUI/XGUI_PropertyPanel.h index e632fe28d..c202af395 100644 --- a/src/XGUI/XGUI_PropertyPanel.h +++ b/src/XGUI/XGUI_PropertyPanel.h @@ -30,6 +30,7 @@ const static char* PROP_PANEL_OK = "property_panel_ok"; const static char* PROP_PANEL_CANCEL = "property_panel_cancel"; /** +* \ingroup GUI * Realization of Property panel object. */ class XGUI_EXPORT XGUI_PropertyPanel : public ModuleBase_IPropertyPanel diff --git a/src/XGUI/XGUI_QtEvents.h b/src/XGUI/XGUI_QtEvents.h index 6cd29e870..0a3528bd7 100644 --- a/src/XGUI/XGUI_QtEvents.h +++ b/src/XGUI/XGUI_QtEvents.h @@ -19,6 +19,7 @@ #include /** +* \ingroup GUI * Class of event to send application events in multi thread environment */ class XGUI_EXPORT PostponeMessageQtEvent : public QEvent diff --git a/src/XGUI/XGUI_SalomeConnector.h b/src/XGUI/XGUI_SalomeConnector.h index e67078e90..10d663b4f 100644 --- a/src/XGUI/XGUI_SalomeConnector.h +++ b/src/XGUI/XGUI_SalomeConnector.h @@ -12,6 +12,7 @@ class QMainWindow; class ModuleBase_IViewer; /** + * \ingroup GUI * An interface which provides a connection of XGUI functionality * with functionality of SALOME module interface. */ diff --git a/src/XGUI/XGUI_Selection.h b/src/XGUI/XGUI_Selection.h index 5c3eb4a41..f766841d6 100644 --- a/src/XGUI/XGUI_Selection.h +++ b/src/XGUI/XGUI_Selection.h @@ -23,6 +23,7 @@ class XGUI_Workshop; /** +* \ingroup GUI * Implementation of \ref ModuleBase_ISelection interface. */ class XGUI_EXPORT XGUI_Selection : public ModuleBase_ISelection diff --git a/src/XGUI/XGUI_Tools.h b/src/XGUI/XGUI_Tools.h index 9ea32e03e..7db64558a 100644 --- a/src/XGUI/XGUI_Tools.h +++ b/src/XGUI/XGUI_Tools.h @@ -12,6 +12,7 @@ #include /*! + \ingroup GUI \brief Return directory part of the file path. If the file path does not include directory part (the file is in the diff --git a/src/XGUI/XGUI_ViewerProxy.h b/src/XGUI/XGUI_ViewerProxy.h index d882b4791..e0894ff0f 100644 --- a/src/XGUI/XGUI_ViewerProxy.h +++ b/src/XGUI/XGUI_ViewerProxy.h @@ -10,6 +10,7 @@ class XGUI_Workshop; class AppElements_ViewWindow; /** + * \ingroup GUI * Proxy class which repersents or AppElements_Viewer or Salome Viewer * dependently on current launching environment. * It is reccomennded to use this class in operation for accessing to viewer -- 2.39.2