From 5589e42badfbde3f9e369b25cb0d544a3bcea921 Mon Sep 17 00:00:00 2001 From: azv Date: Fri, 18 Sep 2015 19:45:02 +0300 Subject: [PATCH] Avoid SketchSolver documentation warnings --- src/SketchSolver/SketchSolver_Constraint.h | 6 ++++++ src/SketchSolver/SketchSolver_ConstraintAngle.h | 1 + src/SketchSolver/SketchSolver_ConstraintCoincidence.h | 1 + src/SketchSolver/SketchSolver_ConstraintDistance.h | 1 + src/SketchSolver/SketchSolver_ConstraintEqual.h | 1 + src/SketchSolver/SketchSolver_ConstraintFillet.h | 1 + src/SketchSolver/SketchSolver_ConstraintLength.h | 1 + src/SketchSolver/SketchSolver_ConstraintMirror.h | 1 + src/SketchSolver/SketchSolver_ConstraintMulti.h | 1 + src/SketchSolver/SketchSolver_ConstraintMultiRotation.h | 1 + src/SketchSolver/SketchSolver_ConstraintMultiTranslation.h | 1 + src/SketchSolver/SketchSolver_ConstraintTangent.h | 1 + src/SketchSolver/SketchSolver_Group.h | 4 +--- 13 files changed, 18 insertions(+), 3 deletions(-) diff --git a/src/SketchSolver/SketchSolver_Constraint.h b/src/SketchSolver/SketchSolver_Constraint.h index 084e17410..f4a15db60 100644 --- a/src/SketchSolver/SketchSolver_Constraint.h +++ b/src/SketchSolver/SketchSolver_Constraint.h @@ -28,6 +28,7 @@ class SketchSolver_Constraint protected: /// Default constructor SketchSolver_Constraint() {} + /// Constructor based on SketchPlugin constraint SketchSolver_Constraint(ConstraintPtr theConstraint); public: @@ -144,6 +145,7 @@ typedef std::shared_ptr SolverConstraintPtr; class SketchSolver_ConstraintParallel : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintParallel(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint) {} @@ -160,6 +162,7 @@ public: class SketchSolver_ConstraintPerpendicular : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintPerpendicular(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint) {} @@ -176,6 +179,7 @@ public: class SketchSolver_ConstraintHorizontal : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintHorizontal(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint) {} @@ -192,6 +196,7 @@ public: class SketchSolver_ConstraintVertical : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintVertical(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint) {} @@ -208,6 +213,7 @@ public: class SketchSolver_ConstraintRadius : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintRadius(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint) {} diff --git a/src/SketchSolver/SketchSolver_ConstraintAngle.h b/src/SketchSolver/SketchSolver_ConstraintAngle.h index a4a65a4a3..4d91aced4 100644 --- a/src/SketchSolver/SketchSolver_ConstraintAngle.h +++ b/src/SketchSolver/SketchSolver_ConstraintAngle.h @@ -16,6 +16,7 @@ class SketchSolver_ConstraintAngle : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintAngle(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint), myAngle(0.0) diff --git a/src/SketchSolver/SketchSolver_ConstraintCoincidence.h b/src/SketchSolver/SketchSolver_ConstraintCoincidence.h index 47d58e0e2..efb01572d 100644 --- a/src/SketchSolver/SketchSolver_ConstraintCoincidence.h +++ b/src/SketchSolver/SketchSolver_ConstraintCoincidence.h @@ -18,6 +18,7 @@ class SketchSolver_ConstraintCoincidence : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintCoincidence(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint), myType(SLVS_C_UNKNOWN) diff --git a/src/SketchSolver/SketchSolver_ConstraintDistance.h b/src/SketchSolver/SketchSolver_ConstraintDistance.h index affcc34ec..5c1569f9a 100644 --- a/src/SketchSolver/SketchSolver_ConstraintDistance.h +++ b/src/SketchSolver/SketchSolver_ConstraintDistance.h @@ -17,6 +17,7 @@ class SketchSolver_ConstraintDistance : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintDistance(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint), myType(SLVS_C_UNKNOWN), diff --git a/src/SketchSolver/SketchSolver_ConstraintEqual.h b/src/SketchSolver/SketchSolver_ConstraintEqual.h index c48477954..2aca9c850 100644 --- a/src/SketchSolver/SketchSolver_ConstraintEqual.h +++ b/src/SketchSolver/SketchSolver_ConstraintEqual.h @@ -17,6 +17,7 @@ class SketchSolver_ConstraintEqual : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintEqual(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint) {} diff --git a/src/SketchSolver/SketchSolver_ConstraintFillet.h b/src/SketchSolver/SketchSolver_ConstraintFillet.h index 126d46d37..44caaf035 100644 --- a/src/SketchSolver/SketchSolver_ConstraintFillet.h +++ b/src/SketchSolver/SketchSolver_ConstraintFillet.h @@ -17,6 +17,7 @@ class SketchSolver_ConstraintFillet : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintFillet(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint) {} diff --git a/src/SketchSolver/SketchSolver_ConstraintLength.h b/src/SketchSolver/SketchSolver_ConstraintLength.h index 7f91d7e3a..f9c0da65c 100644 --- a/src/SketchSolver/SketchSolver_ConstraintLength.h +++ b/src/SketchSolver/SketchSolver_ConstraintLength.h @@ -17,6 +17,7 @@ class SketchSolver_ConstraintLength : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintLength(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint) {} diff --git a/src/SketchSolver/SketchSolver_ConstraintMirror.h b/src/SketchSolver/SketchSolver_ConstraintMirror.h index 2e156cff3..f6aa365eb 100644 --- a/src/SketchSolver/SketchSolver_ConstraintMirror.h +++ b/src/SketchSolver/SketchSolver_ConstraintMirror.h @@ -17,6 +17,7 @@ class SketchSolver_ConstraintMirror : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintMirror(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint), myNumberOfObjects(0), diff --git a/src/SketchSolver/SketchSolver_ConstraintMulti.h b/src/SketchSolver/SketchSolver_ConstraintMulti.h index 2d76cee2b..8d30da0e6 100644 --- a/src/SketchSolver/SketchSolver_ConstraintMulti.h +++ b/src/SketchSolver/SketchSolver_ConstraintMulti.h @@ -19,6 +19,7 @@ class SketchSolver_ConstraintMulti : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintMulti(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint), myNumberOfObjects(0), diff --git a/src/SketchSolver/SketchSolver_ConstraintMultiRotation.h b/src/SketchSolver/SketchSolver_ConstraintMultiRotation.h index 94355ba5b..5206c6b9f 100644 --- a/src/SketchSolver/SketchSolver_ConstraintMultiRotation.h +++ b/src/SketchSolver/SketchSolver_ConstraintMultiRotation.h @@ -17,6 +17,7 @@ class SketchSolver_ConstraintMultiRotation : public SketchSolver_ConstraintMulti { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintMultiRotation(ConstraintPtr theConstraint) : SketchSolver_ConstraintMulti(theConstraint) {} diff --git a/src/SketchSolver/SketchSolver_ConstraintMultiTranslation.h b/src/SketchSolver/SketchSolver_ConstraintMultiTranslation.h index 68c4fbcb8..c3188afa3 100644 --- a/src/SketchSolver/SketchSolver_ConstraintMultiTranslation.h +++ b/src/SketchSolver/SketchSolver_ConstraintMultiTranslation.h @@ -17,6 +17,7 @@ class SketchSolver_ConstraintMultiTranslation : public SketchSolver_ConstraintMulti { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintMultiTranslation(ConstraintPtr theConstraint) : SketchSolver_ConstraintMulti(theConstraint), myTranslationLine(SLVS_E_UNKNOWN) diff --git a/src/SketchSolver/SketchSolver_ConstraintTangent.h b/src/SketchSolver/SketchSolver_ConstraintTangent.h index 7f7e30d0c..a6c744e44 100644 --- a/src/SketchSolver/SketchSolver_ConstraintTangent.h +++ b/src/SketchSolver/SketchSolver_ConstraintTangent.h @@ -17,6 +17,7 @@ class SketchSolver_ConstraintTangent : public SketchSolver_Constraint { public: + /// Constructor based on SketchPlugin constraint SketchSolver_ConstraintTangent(ConstraintPtr theConstraint) : SketchSolver_Constraint(theConstraint) {} diff --git a/src/SketchSolver/SketchSolver_Group.h b/src/SketchSolver/SketchSolver_Group.h index 6a5f02b03..507386d03 100644 --- a/src/SketchSolver/SketchSolver_Group.h +++ b/src/SketchSolver/SketchSolver_Group.h @@ -145,9 +145,7 @@ protected: */ void removeConstraint(ConstraintPtr theConstraint); - /** \brief Remove all temporary constraint after computation finished - * \param[in] theRemoved indexes of constraints to be removed. If empty, all temporary constraints should be deleted - */ + /// \brief Remove all temporary constraint after computation finished void removeTemporaryConstraints(); private: -- 2.30.2