Update the doxygen documentation

[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Plugin.h

diff --git a/src/SketchPlugin/SketchPlugin_Plugin.h b/src/SketchPlugin/SketchPlugin_Plugin.h
index a02ef822c85e1bbdc88de7c458dc031c84aa2ca6..9354ef398a42c2f87bc12152e99b6c5b1eba5bce 100644 (file)
--- a/src/SketchPlugin/SketchPlugin_Plugin.h
+++ b/src/SketchPlugin/SketchPlugin_Plugin.h
@@ -13,9 +13,13 @@
 #include <ModelAPI_Feature.h>
 #include <ModelAPI_Events.h>
 
+/**\class SketchPlugin_Plugin
+ * \ingroup DataModel
+ * \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);
 
@@ -23,7 +27,8 @@ class SKETCHPLUGIN_EXPORT SketchPlugin_Plugin : public ModelAPI_Plugin, public E
   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;
 };