Update code documentation

[modules/shaper.git] / src / XGUI / XGUI_ContextMenuMgr.h

diff --git a/src/XGUI/XGUI_ContextMenuMgr.h b/src/XGUI/XGUI_ContextMenuMgr.h
index c7af183f4e104de9ded8fb8a1d6fce0cf1e5a3ae..0fe548e2a1a3b847238b7e5fbeb00a311ed724e8 100644 (file)
--- a/src/XGUI/XGUI_ContextMenuMgr.h
+++ b/src/XGUI/XGUI_ContextMenuMgr.h
@@ -20,6 +20,8 @@ class XGUI_EXPORT XGUI_ContextMenuMgr : public QObject
 {
 Q_OBJECT
  public:
+   /// Constructor
+   /// \param theParent a parent object
   XGUI_ContextMenuMgr(XGUI_Workshop* theParent);
   virtual ~XGUI_ContextMenuMgr();
 
@@ -27,6 +29,7 @@ Q_OBJECT
   void createActions();
 
   /// Returns action according to the given ID
+  /// \param theId an id of an action
   QAction* action(const QString& theId) const;
 
   /// Returns list of registered actions Ids
@@ -42,14 +45,22 @@ Q_OBJECT
   void connectViewer() const;
 
   /// Add menu atems for viewer into the given menu (used in SALOME mode)
+  /// \param theMenu a menu instance
   void addViewerItems(QMenu* theMenu) const;
 
 signals:
+  /// Signal aabout triggered action
+  /// \param theId an id of triggered action
+  /// \param isChecked is checked flag
   void actionTriggered(const QString& theId, bool isChecked);
 
  private slots:
+   /// Process action event
+   /// \param isChecked a checked action flag
   void onAction(bool isChecked);
 
+  /// Process context menu event
+  /// \param theEvent a context menu event
   void onContextMenuRequest(QContextMenuEvent* theEvent);
 
  private:
@@ -60,11 +71,16 @@ signals:
    */
   void addAction(const QString& theId, QAction* theAction);
 
+  /// Creates menu for object browser
   QMenu* objectBrowserMenu() const;
+
+  /// Creates menu for viewer
   QMenu* viewerMenu() const;
 
+  /// Map of created actions [id : Action]
   QMap<QString, QAction*> myActions;
 
+  /// Reference to workshop
   XGUI_Workshop* myWorkshop;
 };