From 3c017ac8d69c8aa200126968fb870613220131c3 Mon Sep 17 00:00:00 2001 From: spo Date: Thu, 26 May 2016 17:04:58 +0300 Subject: [PATCH] Improve documentation --- src/ConstructionAPI/ConstructionAPI_Point.h | 4 ++-- src/ModelHighAPI/ModelHighAPI_Double.h | 11 +++++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/src/ConstructionAPI/ConstructionAPI_Point.h b/src/ConstructionAPI/ConstructionAPI_Point.h index 0612227e7..56d3a5716 100644 --- a/src/ConstructionAPI/ConstructionAPI_Point.h +++ b/src/ConstructionAPI/ConstructionAPI_Point.h @@ -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 PointPtr; /**\ingroup CPPHighAPI - * \brief C++ HighAPI function for creating Point feature + * \brief Create Point feature */ PointPtr addPoint(std::shared_ptr thePart, const ModelHighAPI_Double & theX, diff --git a/src/ModelHighAPI/ModelHighAPI_Double.h b/src/ModelHighAPI/ModelHighAPI_Double.h index 316703405..f39e50445 100644 --- a/src/ModelHighAPI/ModelHighAPI_Double.h +++ b/src/ModelHighAPI/ModelHighAPI_Double.h @@ -15,18 +15,25 @@ //-------------------------------------------------------------------------------------- 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 & theAttribute) const; private: -- 2.39.2