Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0

[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Boolean.h

diff --git a/src/FeaturesPlugin/FeaturesPlugin_Boolean.h b/src/FeaturesPlugin/FeaturesPlugin_Boolean.h
index 021b99da602c34a0904831825132345db713e93f..65ad15d2e99f2ba424a3ebb50e75681d613d8713 100644 (file)
--- a/src/FeaturesPlugin/FeaturesPlugin_Boolean.h
+++ b/src/FeaturesPlugin/FeaturesPlugin_Boolean.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        FeaturesPlugin_Boolean.h
 // Created:     02 Sept 2014
 // Author:      Vitaly SMETANNIKOV
@@ -10,14 +12,21 @@
 #include <GeomAPI_Shape.h>
 #include <GeomAlgoAPI_Boolean.h>
 
+/**\class FeaturesPlugin_Boolean
+ * \ingroup Plugins
+ * \brief Feature for applying of Boolean operations on Solids.
+ *
+ * Supports three kinds of Boolean operations: Cut, Fuse and Common.
+ * For all of them requires two Solids: object and tool.
+ */
 class FeaturesPlugin_Boolean : public ModelAPI_Feature
 {
- public:
+public:
   /// Extrusion kind
   inline static const std::string& ID()
   {
-    static const std::string MY_CUT_ID("Boolean");
-    return MY_CUT_ID;
+    static const std::string MY_ID("Boolean");
+    return MY_ID;
   }
   /// attribute name of referenced object
   inline static const std::string& OBJECT_ID()
@@ -34,8 +43,8 @@ class FeaturesPlugin_Boolean : public ModelAPI_Feature
   /// attribute name of operation type
   inline static const std::string& TYPE_ID()
   {
-    static const std::string MY_TOOL_ID("bool_type");
-    return MY_TOOL_ID;
+    static const std::string MY_TYPE_ID("bool_type");
+    return MY_TYPE_ID;
   }
 
   enum {
@@ -44,7 +53,6 @@ class FeaturesPlugin_Boolean : public ModelAPI_Feature
     BOOL_COMMON
   };
 
-
   /// Returns the kind of a feature
   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
   {