From: vsv <vitaly.smetannikov@opencascade.com>
Date: Thu, 5 May 2016 14:39:42 +0000 (+0300)
Subject: Update classes documentation
X-Git-Tag: V_2.3.0~12
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=cb0e2ac8865f08af9d9c5e10e88baf1ee6315be3;p=modules%2Fshaper.git

Update classes documentation
---

diff --git a/src/SketcherPrs/SketcherPrs_DimensionStyleListener.h b/src/SketcherPrs/SketcherPrs_DimensionStyleListener.h
index 3ff9696b7..cc00b23ac 100755
--- a/src/SketcherPrs/SketcherPrs_DimensionStyleListener.h
+++ b/src/SketcherPrs/SketcherPrs_DimensionStyleListener.h
@@ -26,8 +26,6 @@ class SketcherPrs_DimensionStyleListener : public Events_Listener
 {
 public:
   /// Constructor
-  /// \param theConstraint a constraint feature
-  /// \param thePlane a coordinate plane of current sketch
   Standard_EXPORT SketcherPrs_DimensionStyleListener();
 
   /// Destructor
diff --git a/src/SketcherPrs/SketcherPrs_Factory.h b/src/SketcherPrs/SketcherPrs_Factory.h
index 2f43622b0..0c463e59e 100644
--- a/src/SketcherPrs/SketcherPrs_Factory.h
+++ b/src/SketcherPrs/SketcherPrs_Factory.h
@@ -28,81 +28,97 @@ public:
   /// Creates coincedent constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(coincidentConstraint)
 
   /// Creates collinear constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(collinearConstraint)
 
   /// Creates parallel constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(parallelConstraint)
 
   /// Creates coincedent perpendicular presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(perpendicularConstraint)
 
   /// Creates rigid constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(rigidConstraint)
 
   /// Creates horizontal constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(horisontalConstraint)
 
   /// Creates vertical constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(verticalConstraint)
 
   /// Creates equal constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(equalConstraint)
 
   /// Creates tangent constraiont presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(tangentConstraint)
 
   /// Creates radius dimension presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(radiusConstraint)
 
   /// Creates length dimension presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(lengthDimensionConstraint)
 
   /// Creates middle constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(middleConstraint)
 
   /// Creates mirror constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(mirrorConstraint)
 
   /// Creates translate constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(translateConstraint)
 
   /// Creates rotate constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(rotateConstraint)
 
   /// Creates angle constraint presentation
   /// \param theConstraint the constraint
   /// \param thePlane the current sketch plane
+  /// \param thePrevious the previous presentation
   GET_CONSTRAINT_PRS(angleConstraint)
 };
 
diff --git a/src/SketcherPrs/SketcherPrs_Tools.h b/src/SketcherPrs/SketcherPrs_Tools.h
index d2b22d386..a17dc4937 100644
--- a/src/SketcherPrs/SketcherPrs_Tools.h
+++ b/src/SketcherPrs/SketcherPrs_Tools.h
@@ -29,9 +29,10 @@ class Handle_Prs3d_DimensionAspect;
 class SketcherPrs_ParameterStyleMessage : public Events_Message
 {
 public:
+  /// \enum ParameterStyle lists styles of parameter
   enum ParameterStyle {
-    ParameterValue, /// using symbol with the parameter value
-    ParameterText /// using parameter text
+    ParameterValue, ///< using symbol with the parameter value
+    ParameterText ///< using parameter text
   };
 
 public: