Salome HOME
Update Split feature and corresponding unit test
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Plugin.h
index fad6fa739df89b3b55d9a66ede701a2dd67bc863..3b9de25ef6941f1ec63831c3a2aec82e8c0b0c03 100644 (file)
 #include <ModelAPI_Feature.h>
 #include <ModelAPI_Events.h>
 
+/**\class SketchPlugin_Plugin
+ * \ingroup Plugins
+ * \brief Interface common for any plugin: allows to use plugin by the plugins manager.
+ */
 class SKETCHPLUGIN_EXPORT SketchPlugin_Plugin : public ModelAPI_Plugin, public Events_Listener
 {
- public:
+public:
   /// Creates the feature object of this plugin by the feature string ID
   virtual FeaturePtr createFeature(std::string theFeatureID);
 
  public:
-  /// Is needed for python wrapping by swig
   SketchPlugin_Plugin();
   //! Redefinition of Events_Listener method
   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
- protected:
+protected:
+  //! Returns the state of the feature in the WorkBench: enabled or disabled for the moment.
   std::shared_ptr<ModelAPI_FeatureStateMessage> getFeaturesState(
       const std::shared_ptr<ModelAPI_Feature>& theFeature) const;
 };