Doxygen warning fixes

diff --git a/src/ModuleBase/ModuleBase_DoubleSpinBox.h b/src/ModuleBase/ModuleBase_DoubleSpinBox.h
index e1fd8bd61f7341e2cb8419fbdd0b850e576ed73d..63e6a7bbe4610e50691e4c3b6c5bf3c85e6c592d 100644 (file)
--- 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 12e5ddb86a91ef2d4f581da500541337fb292c53..a7cf23c5b9942f074f1965ac722215e7686f667f 100644 (file)
--- 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 48c8506e12e6647a41d08c9ac966778f2fdcb79e..11de99701c7756b512baa1be04422c5418a9e4dd 100755 (executable)
--- 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 47d47206c76978573951536fd2350187bd8475ad..c3f31b76e732213e964ec3c049fcf64ef101b60a 100644 (file)
--- 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 d51f45805992be503d90a6acff9363eefbbb9b2a..e05a1ecf4c9451e54a868055ef081c6464662a64 100644 (file)
--- 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 ba6a4e019f8506ab16a7ad734e30ffb142ae478f..b6f029fb088b9eda8c124d32a8c4617e4283b874 100644 (file)
--- 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 f879712a55d653a2141a60db0a8e6f4e53baf24f..5ff0b77dfe6d1905d4fffc072b23cc3e8854ea71 100755 (executable)
--- 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 577f9601d8a6006557fc23d42003e67a9f324566..38981450ba4c3756ec9bbc9e35373750203e7796 100644 (file)
--- 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 d5f87eca0b97c05b41ddf95c0d0c3b201c314316..a2dd6673c783492ce5e9d9d699ab5a1cbe3d602b 100755 (executable)
--- 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 baf7a928f1219450b08d400e38f17aa3f2bc4a3b..ee88f55bc82818ef0b99e6f3c566274440d7446d 100644 (file)
--- 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 91129ece67f03f84afbd3061cf923fd09e96a8ac..a7eec2af01ce1e5e2e169c6ada9d760e3b746a02 100644 (file)
--- 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 22b45c08aca2c5ce8fb78ff846d83f4fffdac55c..b80a51c12ab388b54adfde507b0fe479417e606f 100644 (file)
--- 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 374ea5efc1e12b50a47af91bddca079ee9d523ba..2d2b8e29ca59a749c29c8bd07fb656bd24c421b0 100644 (file)
--- 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();