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

[modules/shaper.git] / src / SketchSolver / SketchSolver_ConstraintGroup.h

diff --git a/src/SketchSolver/SketchSolver_ConstraintGroup.h b/src/SketchSolver/SketchSolver_ConstraintGroup.h
index 4d9a2d7698bb0d28b52aabbd6ec4adefd0a9b2bd..36583e3381362b75fa054cc3983a0e39c33d3678 100644 (file)
--- a/src/SketchSolver/SketchSolver_ConstraintGroup.h
+++ b/src/SketchSolver/SketchSolver_ConstraintGroup.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:    SketchSolver_ConstraintGroup.h
 // Created: 27 May 2014
 // Author:  Artem ZHIDKOV
@@ -23,7 +25,7 @@ typedef std::map< std::shared_ptr<SketchPlugin_Constraint>, std::vector<Slvs_hCo
   ConstraintMap;
 
 /** \class   SketchSolver_ConstraintGroup
- *  \ingroup DataModel
+ *  \ingroup Plugins
  *  \brief   Keeps the group of constraints which based on the same entities
  */
 class SketchSolver_ConstraintGroup
@@ -60,6 +62,10 @@ class SketchSolver_ConstraintGroup
    *  \return \c true if the constraint added or updated successfully
    */
   bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  /** \brief Adds or updates a rigid constraint in the group
+   *  \param[in] theConstraint constraint to be changed
+   *  \return \c true if the constraint added or updated successfully
+   */
   bool changeRigidConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 
   /** \brief Verifies the feature attributes are used in this group
@@ -74,6 +80,7 @@ class SketchSolver_ConstraintGroup
    */
   bool isBaseWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane) const;
 
+  /// Returns the current workplane
   std::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
   {
     return mySketch;
@@ -113,6 +120,9 @@ class SketchSolver_ConstraintGroup
    *  \param[in] theEntity attribute of the constraint
    */
   void updateRelatedConstraints(std::shared_ptr<ModelAPI_Attribute> theEntity) const;
+  /** \brief Searches the constraints built on the entity and emit the signal to update them
+   *  \param[in] theFeature feature of the constraint
+   */
   void updateRelatedConstraintsFeature(std::shared_ptr<ModelAPI_Feature> theFeature) const;
 
   /** \brief Adds or updates an entity in the group