Salome HOME
GeomDataAPI documentation update
authordbv <dbv@opencascade.com>
Fri, 18 Sep 2015 16:51:45 +0000 (19:51 +0300)
committerdbv <dbv@opencascade.com>
Fri, 18 Sep 2015 16:52:01 +0000 (19:52 +0300)
src/GeomDataAPI/GeomDataAPI_Point.h
src/GeomDataAPI/GeomDataAPI_Point2D.h

index 0167f479b45c03a40b64febe575c82f79a93db26..ffa07285da1df05d445247c5f30eefba756d4aee 100644 (file)
@@ -44,11 +44,14 @@ class GeomDataAPI_Point : public ModelAPI_Attribute
                                           const std::string& theY,
                                           const std::string& theZ) = 0;
 
-  /// Returns the text values
+  /// Returns the text value for X
   GEOMDATAAPI_EXPORT virtual std::string textX() = 0;
+  /// Returns the text value for Y
   GEOMDATAAPI_EXPORT virtual std::string textY() = 0;
+  /// Returns the text value for Z
   GEOMDATAAPI_EXPORT virtual std::string textZ() = 0;
 
+  /// Point component (x,y,z)
   enum PointComponent { C_X = 0,
                         C_Y = 1,
                         C_Z = 2,
index 021d24b7c5c7ec7cb5dc164836da7fabd931f54e..7f67085e7dadd92981d7b5b9630a67f458101c35 100644 (file)
@@ -41,10 +41,12 @@ class GeomDataAPI_Point2D : public ModelAPI_Attribute
   GEOMDATAAPI_EXPORT virtual void setText(const std::string& theX,
                                           const std::string& theY) = 0;
 
-  /// Returns the text values
+  /// Returns the text value for X
   GEOMDATAAPI_EXPORT virtual std::string textX() = 0;
+  /// Returns the text value for Y
   GEOMDATAAPI_EXPORT virtual std::string textY() = 0;
 
+  /// Point component (x,y)
   enum PointComponent { C_X = 0,
                         C_Y = 1,
   };