Update the doxygen documentation for plugins

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

diff --git a/src/SketchSolver/SketchSolver_ConstraintGroup.h b/src/SketchSolver/SketchSolver_ConstraintGroup.h
index 2a5fe600cea6e55df2b82c7ff9f43e16ea85be1c..94734f20c0f0edec67accf815efd79046fe9f99d 100644 (file)
--- a/src/SketchSolver/SketchSolver_ConstraintGroup.h
+++ b/src/SketchSolver/SketchSolver_ConstraintGroup.h
@@ -62,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
@@ -76,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;