Update code documentation

[modules/shaper.git] / src / PartSet / PartSet_SketcherMgr.h

diff --git a/src/PartSet/PartSet_SketcherMgr.h b/src/PartSet/PartSet_SketcherMgr.h
index 0b79b084e0b18dd31deab0e8e67835c622e0b9a4..97dbea056017349e63fc3672564fafb58233ef27 100644 (file)
--- a/src/PartSet/PartSet_SketcherMgr.h
+++ b/src/PartSet/PartSet_SketcherMgr.h
@@ -31,6 +31,7 @@ class ModuleBase_Operation;
 class QMouseEvent;
 
 /**
+* \ingroup Module
 * A class for management of sketch operations
 */
 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
@@ -67,25 +68,29 @@ class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
     double myCurX, myCurY; /// the point coordinates
   };
 public:
+  /// Constructor
+  /// \param theModule a pointer to PartSet module
   PartSet_SketcherMgr(PartSet_Module* theModule);
 
   virtual ~PartSet_SketcherMgr();
 
+  /// Returns list of strings which contains id's of sketch operations
   static QStringList sketchOperationIdList();
 
   /// Launches the operation from current highlighting
   void launchEditing();
 
-  // Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
+  /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
   CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
 
   /// Starts sketch operation
-  void startSketch(ModuleBase_Operation* theOperation);
+  void startSketch(ModuleBase_Operation* );
 
   /// Stops sketch operation
-  void stopSketch(ModuleBase_Operation* theOperation);
+  void stopSketch(ModuleBase_Operation* );
 
 public slots:
+  /// Process sketch plane selected event
   void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);