From: dbv <dbv@opencascade.com>
Date: Fri, 18 Sep 2015 16:41:13 +0000 (+0300)
Subject: ConstructionPlugin documentation update
X-Git-Tag: V_1.4.0~3
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=49f2c739be56335264a46c215ba8b139fbbf9b58;p=modules%2Fshaper.git

ConstructionPlugin documentation update
---

diff --git a/src/ConstructionPlugin/ConstructionPlugin_Axis.h b/src/ConstructionPlugin/ConstructionPlugin_Axis.h
index 1775300eb..ffaa95d04 100644
--- a/src/ConstructionPlugin/ConstructionPlugin_Axis.h
+++ b/src/ConstructionPlugin/ConstructionPlugin_Axis.h
@@ -58,6 +58,7 @@ class ConstructionPlugin_Axis : public ModelAPI_Feature, public GeomAPI_ICustomP
     return CYLINDRICAL_FACE_ATTR;
   }
 
+  /// Returns a minimal length for axis
   inline static const double MINIMAL_LENGTH() { return 1.e-5; }
 
   /// Creates a new part document if needed
@@ -77,7 +78,9 @@ class ConstructionPlugin_Axis : public ModelAPI_Feature, public GeomAPI_ICustomP
                                      std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs);
 
  protected:
+  /// Creates a new axis by two defined points
   void createAxisByTwoPoints();
+  /// Creates a new axis as copy of cylindrical face axis
   void createAxisByCylindricalFace();
 };
 
diff --git a/src/ConstructionPlugin/ConstructionPlugin_Plane.h b/src/ConstructionPlugin/ConstructionPlugin_Plane.h
index 546577b44..b82f1e8c3 100644
--- a/src/ConstructionPlugin/ConstructionPlugin_Plane.h
+++ b/src/ConstructionPlugin/ConstructionPlugin_Plane.h
@@ -104,7 +104,10 @@ class ConstructionPlugin_Plane : public ModelAPI_Feature, public GeomAPI_ICustom
                                      std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs);
 
  protected:
+  /// Creates a new plane by copy of face plane with translation along the normal
+  /// to the specified distance.
   std::shared_ptr<GeomAPI_Shape> createPlaneByFaceAndDistance();
+  /// Creates a new plane by general equation.
   std::shared_ptr<GeomAPI_Shape> createPlaneByGeneralEquation();
 };
 
diff --git a/src/ConstructionPlugin/ConstructionPlugin_Point.h b/src/ConstructionPlugin/ConstructionPlugin_Point.h
index 8e0f0fcda..d1f15287f 100644
--- a/src/ConstructionPlugin/ConstructionPlugin_Point.h
+++ b/src/ConstructionPlugin/ConstructionPlugin_Point.h
@@ -22,6 +22,7 @@ class ConstructionPlugin_Point : public ModelAPI_Feature, public GeomAPI_ICustom
   /// Returns the kind of a feature
   CONSTRUCTIONPLUGIN_EXPORT virtual const std::string& getKind();
 
+  /// Point kind
   inline static const std::string& ID()
   {
     static const std::string CONSTRUCTION_POINT_KIND("Point");