]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
ConstructionPlugin documentation update
authordbv <dbv@opencascade.com>
Fri, 18 Sep 2015 16:41:13 +0000 (19:41 +0300)
committerdbv <dbv@opencascade.com>
Fri, 18 Sep 2015 16:41:29 +0000 (19:41 +0300)
src/ConstructionPlugin/ConstructionPlugin_Axis.h
src/ConstructionPlugin/ConstructionPlugin_Plane.h
src/ConstructionPlugin/ConstructionPlugin_Point.h

index 1775300ebda82e65cbdd043fdc84073e78d6eb35..ffaa95d04ed0614e0a1de31334fdd197250b9544 100644 (file)
@@ -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();
 };
 
index 546577b44ea5d35a31fe8df7881b2ab083b5ea47..b82f1e8c3f8b238b1fd2b804618c5e096ded9923 100644 (file)
@@ -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();
 };
 
index 8e0f0fcda6f74a4b959fdbbe664db39ab332ed0a..d1f15287f64d62d6e50bc67a555eac16a8e23ee9 100644 (file)
@@ -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");