The flushCreated/flushUpdated are obsolete and nobody uses them.

[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_MakeShape.h

diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h
index 6848898b6c9615ab7784692dca7e0327696a6a19..186b12c67e794bb7e05eec981099fb9d8579db96 100644 (file)
--- a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h
+++ b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        GeomAlgoAPI_MakeShape.h
 // Created:     17 Oct 2014
 // Author:      Sergey ZARITCHNY
@@ -7,36 +9,37 @@
 #include <GeomAPI_Shape.h>
 #include <memory>
 #include <GeomAlgoAPI.h>
-//#include <BRepBuilderAPI_MakeShape.hxx>
+
 /**\class GeomAlgoAPI_MakeShape
- * \ingroup DataModel
- * \Interface to the root class of all topological shapes constructions
+ * \ingroup DataAlgo
+ * \brief Interface to the root class of all topological shapes constructions
  */
 class GeomAlgoAPI_MakeShape : public GeomAPI_Interface
 {
- public:
-   /// Constructor
+public:
+  /// Constructor
   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape();
-
+  /// Constructor by the already stored builder in the interface
   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(void* theBuilder);
 
   /// Returns a shape built by the shape construction algorithm
   GEOMALGOAPI_EXPORT const std::shared_ptr<GeomAPI_Shape>  shape() const;
 
-  /// Returns the  list   of shapes generated   from the shape <theShape>
+  /// Returns the list of shapes generated from the shape \a theShape
   GEOMALGOAPI_EXPORT virtual void generated(
     const std::shared_ptr<GeomAPI_Shape> theShape, ListOfShape& theHistory);
 
-  /// Returns the  list   of shapes modified   from the shape <theShape>
+  /// Returns the  list of shapes modified from the shape \a theShape
   GEOMALGOAPI_EXPORT virtual void modified(
     const std::shared_ptr<GeomAPI_Shape> theShape, ListOfShape& theHistory);
 
   /// Returns whether the shape is an edge
   GEOMALGOAPI_EXPORT virtual bool isDeleted(const std::shared_ptr<GeomAPI_Shape> theShape);
-
+  /// Initializes the algorithm by the builder stored in the interface
   GEOMALGOAPI_EXPORT void init(void* theMkShape);
 
   protected:
+  /// The resulting shape
        std::shared_ptr<GeomAPI_Shape> myShape;
 };