From 902ee072b1eb3122ee3a3b8ce8c9722b5a671e0b Mon Sep 17 00:00:00 2001 From: dbv Date: Tue, 3 Nov 2015 17:15:31 +0300 Subject: [PATCH] Doxygen warning fixes --- src/ModuleBase/ModuleBase_DoubleSpinBox.h | 2 ++ src/ModuleBase/ModuleBase_Operation.h | 3 +++ src/ModuleBase/ModuleBase_OperationFeature.h | 2 +- src/ModuleBase/ModuleBase_Preferences.h | 1 + src/ModuleBase/ModuleBase_WidgetExprEditor.h | 4 ++-- src/ModuleBase/ModuleBase_WidgetFileSelector.h | 5 ++++- src/PartSet/PartSet_Module.h | 2 +- src/PartSet/PartSet_SketcherMgr.h | 2 +- src/PartSet/PartSet_WidgetPoint2d.h | 2 +- src/SketcherPrs/SketcherPrs_SymbolPrs.h | 2 ++ src/XGUI/XGUI_Displayer.h | 1 + src/XGUI/XGUI_ObjectsBrowser.h | 7 +++++++ src/XGUI/XGUI_PropertyPanel.h | 1 + 13 files changed, 27 insertions(+), 7 deletions(-) diff --git a/src/ModuleBase/ModuleBase_DoubleSpinBox.h b/src/ModuleBase/ModuleBase_DoubleSpinBox.h index e1fd8bd61..63e6a7bbe 100644 --- a/src/ModuleBase/ModuleBase_DoubleSpinBox.h +++ b/src/ModuleBase/ModuleBase_DoubleSpinBox.h @@ -63,11 +63,13 @@ Q_OBJECT protected slots: /// Called on text changed virtual void onTextChanged(const QString&); + /// Called on value changed void onValueChanged(const QString& theValue); protected: /// Removes extra trailing zero symbols QString removeTrailingZeroes(const QString&) const; + /// Called on key press event virtual void keyPressEvent(QKeyEvent* theEvent); private: diff --git a/src/ModuleBase/ModuleBase_Operation.h b/src/ModuleBase/ModuleBase_Operation.h index 12e5ddb86..a7cf23c5b 100644 --- a/src/ModuleBase/ModuleBase_Operation.h +++ b/src/ModuleBase/ModuleBase_Operation.h @@ -92,14 +92,17 @@ Q_OBJECT signals: /// The operation is started void beforeStarted(); + /// The operation is started void started(); /// The operation is aborted void beforeAborted(); + /// The operation is aborted void aborted(); /// The operation is committed void beforeCommitted(); + /// The operation is committed void committed(); /// The operation is aborted or committed diff --git a/src/ModuleBase/ModuleBase_OperationFeature.h b/src/ModuleBase/ModuleBase_OperationFeature.h index 48c8506e1..11de99701 100755 --- a/src/ModuleBase/ModuleBase_OperationFeature.h +++ b/src/ModuleBase/ModuleBase_OperationFeature.h @@ -108,7 +108,7 @@ Q_OBJECT CompositeFeaturePtr parentFeature() const; /// Stores the previous to the operation current feature - /// \set theFeature a feature + /// \param theFeature a feature void setPreviousCurrentFeature(const FeaturePtr& theFeature); /// Returns the previous to the operation current feature diff --git a/src/ModuleBase/ModuleBase_Preferences.h b/src/ModuleBase/ModuleBase_Preferences.h index 47d47206c..c3f31b76e 100644 --- a/src/ModuleBase/ModuleBase_Preferences.h +++ b/src/ModuleBase/ModuleBase_Preferences.h @@ -60,6 +60,7 @@ class MODULEBASE_EXPORT ModuleBase_Preferences /// Retrieve preferences of resource manage to default state static void resetResourcePreferences(SUIT_PreferenceMgr* thePref); + /// Retrieve preferences of config prop to default state static void resetConfigPropPreferences(SUIT_PreferenceMgr* thePref); private: diff --git a/src/ModuleBase/ModuleBase_WidgetExprEditor.h b/src/ModuleBase/ModuleBase_WidgetExprEditor.h index d51f45805..e05a1ecf4 100644 --- a/src/ModuleBase/ModuleBase_WidgetExprEditor.h +++ b/src/ModuleBase/ModuleBase_WidgetExprEditor.h @@ -45,10 +45,10 @@ class ExpressionEditor: public QPlainTextEdit /// Returns placeholder list QString placeHolderText() const; - // Returns true if the current value is modified by has not been applyed yet + /// Returns true if the current value is modified by has not been applyed yet bool isModified() const; - // Clears modified state + /// Clears modified state void clearModified(); public slots: diff --git a/src/ModuleBase/ModuleBase_WidgetFileSelector.h b/src/ModuleBase/ModuleBase_WidgetFileSelector.h index ba6a4e019..b6f029fb0 100644 --- a/src/ModuleBase/ModuleBase_WidgetFileSelector.h +++ b/src/ModuleBase/ModuleBase_WidgetFileSelector.h @@ -103,7 +103,10 @@ protected: QString mySelectedFilter; /// A title of open file dialog box - enum { WFS_OPEN, WFS_SAVE } myType; + enum { + WFS_OPEN, ///< open file + WFS_SAVE ///< save file + } myType; ///< type of dialog /// Default path QString myDefaultPath; diff --git a/src/PartSet/PartSet_Module.h b/src/PartSet/PartSet_Module.h index f879712a5..5ff0b77df 100755 --- a/src/PartSet/PartSet_Module.h +++ b/src/PartSet/PartSet_Module.h @@ -204,7 +204,7 @@ public: virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const; /// Validates the current operation and send the state change to sketch manager - /// \thePrevState the previous widget value state + /// \param thePreviousState the previous widget value state virtual void widgetStateChanged(int thePreviousState); public slots: diff --git a/src/PartSet/PartSet_SketcherMgr.h b/src/PartSet/PartSet_SketcherMgr.h index 577f9601d..38981450b 100644 --- a/src/PartSet/PartSet_SketcherMgr.h +++ b/src/PartSet/PartSet_SketcherMgr.h @@ -198,7 +198,7 @@ public: void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect); /// Visualize the operation feature if the previous state is modified value in property panel - /// \thePrevState the previous widget value state + /// \param thePreviousState the previous widget value state void widgetStateChanged(int thePreviousState); public slots: diff --git a/src/PartSet/PartSet_WidgetPoint2d.h b/src/PartSet/PartSet_WidgetPoint2d.h index d5f87eca0..a2dd6673c 100755 --- a/src/PartSet/PartSet_WidgetPoint2d.h +++ b/src/PartSet/PartSet_WidgetPoint2d.h @@ -142,7 +142,7 @@ protected: void setConstraintWith(const ObjectPtr& theObject); protected: - ModuleBase_IWorkshop* myWorkshop; + ModuleBase_IWorkshop* myWorkshop; ///< workshop private: diff --git a/src/SketcherPrs/SketcherPrs_SymbolPrs.h b/src/SketcherPrs/SketcherPrs_SymbolPrs.h index baf7a928f..ee88f55bc 100644 --- a/src/SketcherPrs/SketcherPrs_SymbolPrs.h +++ b/src/SketcherPrs/SketcherPrs_SymbolPrs.h @@ -82,6 +82,8 @@ protected: const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0); /// Redefinition of virtual function + /// \param aSelection selection + /// \param aMode compute mode Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode); diff --git a/src/XGUI/XGUI_Displayer.h b/src/XGUI/XGUI_Displayer.h index 91129ece6..a7eec2af0 100644 --- a/src/XGUI/XGUI_Displayer.h +++ b/src/XGUI/XGUI_Displayer.h @@ -141,6 +141,7 @@ class XGUI_EXPORT XGUI_Displayer: public QObject /// \param isEnabled a boolean value bool enableUpdateViewer(const bool isEnabled); + /// Returns myEnableUpdateViewer flag bool isUpdateEnabled() const { return myEnableUpdateViewer; } /// Updates the viewer diff --git a/src/XGUI/XGUI_ObjectsBrowser.h b/src/XGUI/XGUI_ObjectsBrowser.h index 22b45c08a..b80a51c12 100644 --- a/src/XGUI/XGUI_ObjectsBrowser.h +++ b/src/XGUI/XGUI_ObjectsBrowser.h @@ -25,11 +25,15 @@ class XGUI_ActiveDocLbl: public QLineEdit Q_OBJECT public: /// Constructor + /// \param theText a text /// \param theParent a parent widget XGUI_ActiveDocLbl(const QString& theText, QWidget* theParent ); + /// Sets tree view + /// \param theView a view void setTreeView(QTreeView* theView); + /// Returns tree view QTreeView* treePalette() const { return myTreeView;} #if (!defined HAVE_SALOME) && (defined WIN32) @@ -37,11 +41,14 @@ Q_OBJECT #endif public slots: + /// On unselect void unselect(); protected: + /// On mouse release virtual void mouseReleaseEvent( QMouseEvent* e); + /// Filter event bool eventFilter(QObject* theObj, QEvent* theEvent); private: diff --git a/src/XGUI/XGUI_PropertyPanel.h b/src/XGUI/XGUI_PropertyPanel.h index 374ea5efc..2d2b8e29c 100644 --- a/src/XGUI/XGUI_PropertyPanel.h +++ b/src/XGUI/XGUI_PropertyPanel.h @@ -47,6 +47,7 @@ Q_OBJECT /// Constructor /// \param theParent is a parent of the property panel + /// \param theMgr operation manager XGUI_PropertyPanel(QWidget* theParent, XGUI_OperationMgr* theMgr); virtual ~XGUI_PropertyPanel(); -- 2.39.2