]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Avoid SketchSolver documentation warnings
authorazv <azv@opencascade.com>
Fri, 18 Sep 2015 16:45:02 +0000 (19:45 +0300)
committerazv <azv@opencascade.com>
Fri, 18 Sep 2015 16:45:26 +0000 (19:45 +0300)
13 files changed:
src/SketchSolver/SketchSolver_Constraint.h
src/SketchSolver/SketchSolver_ConstraintAngle.h
src/SketchSolver/SketchSolver_ConstraintCoincidence.h
src/SketchSolver/SketchSolver_ConstraintDistance.h
src/SketchSolver/SketchSolver_ConstraintEqual.h
src/SketchSolver/SketchSolver_ConstraintFillet.h
src/SketchSolver/SketchSolver_ConstraintLength.h
src/SketchSolver/SketchSolver_ConstraintMirror.h
src/SketchSolver/SketchSolver_ConstraintMulti.h
src/SketchSolver/SketchSolver_ConstraintMultiRotation.h
src/SketchSolver/SketchSolver_ConstraintMultiTranslation.h
src/SketchSolver/SketchSolver_ConstraintTangent.h
src/SketchSolver/SketchSolver_Group.h

index 084e174103b7d69deb788e52b8c2742df9eda1e7..f4a15db60ff19e3445a04d1c3c420ffa7134cae6 100644 (file)
@@ -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<SketchSolver_Constraint> 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)
   {}
index a4a65a4a3c3a4ba690bd9fd86b34e47ba5db858a..4d91aced435e949b13f2f0a1c76ccd82c70e6eeb 100644 (file)
@@ -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)
index 47d58e0e23299282a208d848f156ce28faf4b603..efb01572d063fa923a1fff61237a4728eb014a65 100644 (file)
@@ -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)
index affcc34ec768f1d1d9da115223eea70e5cd78821..5c1569f9a4f160f78b06f7ec81571f359dd36d47 100644 (file)
@@ -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),
index c48477954880b2af6dc748b526eb0d00d3daf4e6..2aca9c850a265fca96d897296e4fcbdce4a86162 100644 (file)
@@ -17,6 +17,7 @@
 class SketchSolver_ConstraintEqual : public SketchSolver_Constraint
 {
 public:
+  /// Constructor based on SketchPlugin constraint
   SketchSolver_ConstraintEqual(ConstraintPtr theConstraint) :
       SketchSolver_Constraint(theConstraint)
   {}
index 126d46d3798e3f75664a7cbf70458c863df2920e..44caaf03567ea800f67d7da9fe47c808e9b50e99 100644 (file)
@@ -17,6 +17,7 @@
 class SketchSolver_ConstraintFillet : public SketchSolver_Constraint
 {
 public:
+  /// Constructor based on SketchPlugin constraint
   SketchSolver_ConstraintFillet(ConstraintPtr theConstraint) :
       SketchSolver_Constraint(theConstraint)
   {}
index 7f91d7e3a33c74ccd37939b715a4dc8877788311..f9c0da65ce54dd706629d07028d7447e50cf4c88 100644 (file)
@@ -17,6 +17,7 @@
 class SketchSolver_ConstraintLength : public SketchSolver_Constraint
 {
 public:
+  /// Constructor based on SketchPlugin constraint
   SketchSolver_ConstraintLength(ConstraintPtr theConstraint) :
       SketchSolver_Constraint(theConstraint)
   {}
index 2e156cff3522ebaec03cad5bd200041bb3802548..f6aa365eb616810b736c30d501cd36644449a985 100644 (file)
@@ -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),
index 2d76cee2b21f1d97d44e6c048c8eb69bac1fa8ec..8d30da0e630a580b67fae2a6dcb5e736a9c69693 100644 (file)
@@ -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),
index 94355ba5bf2777876ad5cf7918de579091b19f8e..5206c6b9f0fc74e40d579a39484dd05b1e003fa2 100644 (file)
@@ -17,6 +17,7 @@
 class SketchSolver_ConstraintMultiRotation : public SketchSolver_ConstraintMulti
 {
 public:
+  /// Constructor based on SketchPlugin constraint
   SketchSolver_ConstraintMultiRotation(ConstraintPtr theConstraint) :
       SketchSolver_ConstraintMulti(theConstraint)
   {}
index 68c4fbcb8c69eab3791fa5db113c4875b83fce74..c3188afa30ee70f781da06ce862b3ec148fca708 100644 (file)
@@ -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)
index 7f7e30d0c031b0a2a7997235042b287ffb5c3ca8..a6c744e44e7ff7718981433fa52674a6fbc17bb2 100644 (file)
@@ -17,6 +17,7 @@
 class SketchSolver_ConstraintTangent : public SketchSolver_Constraint
 {
 public:
+  /// Constructor based on SketchPlugin constraint
   SketchSolver_ConstraintTangent(ConstraintPtr theConstraint) :
       SketchSolver_Constraint(theConstraint)
   {}
index 6a5f02b03b7a2b314a4961e5286085ad304a67b8..507386d03e9928b83b0c578333422b25ec10b097 100644 (file)
@@ -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: