]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Improve documentation
authorspo <sergey.pokhodenko@opencascade.com>
Thu, 26 May 2016 14:04:58 +0000 (17:04 +0300)
committerspo <sergey.pokhodenko@opencascade.com>
Fri, 17 Jun 2016 11:41:02 +0000 (14:41 +0300)
src/ConstructionAPI/ConstructionAPI_Point.h
src/ModelHighAPI/ModelHighAPI_Double.h

index 0612227e753bca80f76e67a154aaac00d7a8f04a..56d3a57169cbed9a88eeeba9935c8cd561496f39 100644 (file)
@@ -18,7 +18,7 @@ class ModelHighAPI_Double;
 //--------------------------------------------------------------------------------------
 /**\class ConstructionAPI_Point
  * \ingroup CPPHighAPI
- * \brief C++ HighAPI interface for Point feature
+ * \brief Interface for Point feature
  */
 class ConstructionAPI_Point : public ModelHighAPI_Interface
 {
@@ -55,7 +55,7 @@ protected:
 typedef std::shared_ptr<ConstructionAPI_Point> PointPtr;
 
 /**\ingroup CPPHighAPI
- * \brief C++ HighAPI function for creating Point feature
+ * \brief Create Point feature
  */
 PointPtr addPoint(std::shared_ptr<ModelAPI_Document> thePart,
                   const ModelHighAPI_Double & theX,
index 316703405cba2c2e1554ffa4c1a4909e6e488f5e..f39e50445a0fa6ac484062e1cfd1839e29a33ec3 100644 (file)
 //--------------------------------------------------------------------------------------
 class ModelAPI_AttributeDouble;
 //--------------------------------------------------------------------------------------
-/*
- *
+/**\class ModelHighAPI_Double
+ * \ingroup CPPHighAPI
+ * \brief Class for filling ModelAPI_AttributeDouble
  */
 class ModelHighAPI_Double
 {
 public:
+  /// Default constructor
   ModelHighAPI_Double();
+  /// Constructor for double
   ModelHighAPI_Double(double theValue);
+  /// Constructor for std::string
   ModelHighAPI_Double(const std::string & theValue);
+  /// Constructor for char *
   ModelHighAPI_Double(const char * theValue);
+  /// Destructor
   virtual ~ModelHighAPI_Double();
 
+  /// Fill attribute values
   virtual void fillAttribute(std::shared_ptr<ModelAPI_AttributeDouble> & theAttribute) const;
 
 private: