From: mpv Date: Thu, 17 Sep 2015 17:12:58 +0000 (+0300) Subject: Update the Doxygen documentation for the Model* packages X-Git-Tag: V_1.4.0~24 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=4748bf45f55c8185533d460302d3dbefc948b56e;p=modules%2Fshaper.git Update the Doxygen documentation for the Model* packages --- diff --git a/src/Model/Model_BodyBuilder.h b/src/Model/Model_BodyBuilder.h index c5135c773..85032d4f8 100755 --- a/src/Model/Model_BodyBuilder.h +++ b/src/Model/Model_BodyBuilder.h @@ -18,7 +18,7 @@ class TNaming_Builder; /**\class Model_BodyBuilder * \ingroup DataModel - * \brief The body (shape) result of a feature. + * \brief Extra API for the ResultBody that allows to work with naming. */ class Model_BodyBuilder : public ModelAPI_BodyBuilder { diff --git a/src/Model/Model_ResultConstruction.h b/src/Model/Model_ResultConstruction.h index 42fff591b..0a497b271 100644 --- a/src/Model/Model_ResultConstruction.h +++ b/src/Model/Model_ResultConstruction.h @@ -30,7 +30,7 @@ class Model_ResultConstruction : public ModelAPI_ResultConstruction /// Request for initialization of data model of the result: adding all attributes virtual void initAttributes(); - // Retuns the parameters of color definition in the resources config manager + /// Retuns the parameters of color definition in the resources config manager MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName, std::string& theDefault); diff --git a/src/Model/Model_ResultGroup.h b/src/Model/Model_ResultGroup.h index 3de093e74..2252d455e 100644 --- a/src/Model/Model_ResultGroup.h +++ b/src/Model/Model_ResultGroup.h @@ -23,7 +23,7 @@ public: /// Request for initialization of data model of the result: adding all attributes virtual void initAttributes(); - // Retuns the parameters of color definition in the resources config manager + /// Retuns the parameters of color definition in the resources config manager MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName, std::string& theDefault); diff --git a/src/Model/Model_Session.h b/src/Model/Model_Session.h index 9e5fa029c..1e200f40e 100644 --- a/src/Model/Model_Session.h +++ b/src/Model/Model_Session.h @@ -49,6 +49,7 @@ class Model_Session : public ModelAPI_Session, public Events_Listener MODEL_EXPORT virtual void closeAll(); //! Starts a new operation (opens a transaction) + //! \param theId string-identifier of the started transaction //! \param theAttachedToNested if it is true, it means that this transaction is attached to the nested //! where it is located and will be committed on the next commit with the nested MODEL_EXPORT virtual void startOperation( diff --git a/src/Model/Model_Update.h b/src/Model/Model_Update.h index bd69891b7..862a078ce 100644 --- a/src/Model/Model_Update.h +++ b/src/Model/Model_Update.h @@ -107,6 +107,7 @@ protected: /// On operation start/end/abort the "Just" fileds must be cleared and processed in the right way /// \param theTotalUpdate force to updates everything that has been changed in this operation + /// \param theFinish is true for start, close or abort transaction: all objects must be processed void processOperation(const bool theTotalUpdate, const bool theFinish = false); /// Performs the feature execution diff --git a/src/ModelAPI/ModelAPI_AttributeValidator.h b/src/ModelAPI/ModelAPI_AttributeValidator.h index 1cf46a54c..142c91c23 100644 --- a/src/ModelAPI/ModelAPI_AttributeValidator.h +++ b/src/ModelAPI/ModelAPI_AttributeValidator.h @@ -17,9 +17,10 @@ class ModelAPI_AttributeValidator : public ModelAPI_Validator { public: - //! returns true if attribute is valid + //! \returns true if attribute is valid //! \param theAttribute the checked attribute //! \param theArguments arguments of the attribute + //! \param theError the error string message if validation fails virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, std::string& theError) const = 0; diff --git a/src/ModelAPI/ModelAPI_BodyBuilder.h b/src/ModelAPI/ModelAPI_BodyBuilder.h index ff43ca7c4..3d945b47c 100755 --- a/src/ModelAPI/ModelAPI_BodyBuilder.h +++ b/src/ModelAPI/ModelAPI_BodyBuilder.h @@ -20,6 +20,7 @@ class ModelAPI_Object; /**\class ModelAPI_BodyBuilder * \ingroup DataModel + * \brief Extra API for the ResultBody that allows to work with naming. */ class ModelAPI_BodyBuilder { @@ -108,9 +109,10 @@ protected: MODELAPI_EXPORT virtual std::shared_ptr document() const; protected: + /// Deafult constructor accessible only from Model_Object MODELAPI_EXPORT ModelAPI_BodyBuilder(ModelAPI_Object* theOwner); - ModelAPI_Object* myOwner; + ModelAPI_Object* myOwner; ///< the owner object this builder belongs to }; //! Pointer on feature object diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index 0f4ccc330..b6419ec82 100644 --- a/src/ModelAPI/ModelAPI_Document.h +++ b/src/ModelAPI/ModelAPI_Document.h @@ -123,23 +123,23 @@ public: //! To virtually destroy the fields of successors MODELAPI_EXPORT virtual ~ModelAPI_Document(); - //! Creates a construction cresults + //! Creates a construction cresult virtual std::shared_ptr createConstruction( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - //! Creates a body results + //! Creates a body result virtual std::shared_ptr createBody( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - //! Creates a part results + //! Creates a part result virtual std::shared_ptr createPart( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; //! Copies a part result, keeping the reference to the origin virtual std::shared_ptr copyPart( const std::shared_ptr& theOrigin, const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - //! Creates a group results + //! Creates a group result virtual std::shared_ptr createGroup( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - + //! Creates a parameter result virtual std::shared_ptr createParameter( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; diff --git a/src/ModelAPI/ModelAPI_FeatureValidator.h b/src/ModelAPI/ModelAPI_FeatureValidator.h index 6b83d30e8..f051c1e0d 100644 --- a/src/ModelAPI/ModelAPI_FeatureValidator.h +++ b/src/ModelAPI/ModelAPI_FeatureValidator.h @@ -29,6 +29,7 @@ class MODELAPI_EXPORT ModelAPI_FeatureValidator : public ModelAPI_Validator /// Returns true if feature and/or attributes are valid /// \param theFeature the validated feature /// \param theArguments list of string, feature attribute names: dependent attributes + /// \param theError the error string message if validation fails virtual bool isValid(const std::shared_ptr& theFeature, const std::list& theArguments, std::string& theError) const = 0; diff --git a/src/ModelAPI/ModelAPI_Result.h b/src/ModelAPI/ModelAPI_Result.h index fb96df98c..14f69a32f 100644 --- a/src/ModelAPI/ModelAPI_Result.h +++ b/src/ModelAPI/ModelAPI_Result.h @@ -52,7 +52,7 @@ class ModelAPI_Result : public ModelAPI_Object /// Returns the result is disabled or not. MODELAPI_EXPORT virtual bool isDisabled(); - // Returns the parameters of color definition in the resources config manager + /// Returns the parameters of color definition in the resources config manager virtual void colorConfigInfo(std::string& theSection, std::string& theName, std::string& theDefault) {} diff --git a/src/ModelAPI/ModelAPI_ResultBody.h b/src/ModelAPI/ModelAPI_ResultBody.h index 1cce02786..54df9a2c6 100644 --- a/src/ModelAPI/ModelAPI_ResultBody.h +++ b/src/ModelAPI/ModelAPI_ResultBody.h @@ -112,9 +112,10 @@ public: const std::string& theName,int& theTag); protected: + /// Default constructor accessible only from Model_Objects MODELAPI_EXPORT ModelAPI_ResultBody(); - ModelAPI_BodyBuilder* myBuilder; /// provide the body processing in naming shape + ModelAPI_BodyBuilder* myBuilder; ///< provides the body processing in naming shape }; //! Pointer on feature object diff --git a/src/ModelAPI/ModelAPI_ResultParameter.h b/src/ModelAPI/ModelAPI_ResultParameter.h index ad47ce9c7..4a8c293c8 100644 --- a/src/ModelAPI/ModelAPI_ResultParameter.h +++ b/src/ModelAPI/ModelAPI_ResultParameter.h @@ -32,21 +32,24 @@ class ModelAPI_ResultParameter : public ModelAPI_Result static std::string MY_GROUP = "Parameters"; return MY_GROUP; } - + /// The computed value attribute Id inline static const std::string& VALUE() { static const std::string MY_VALUE_ID("Value"); return MY_VALUE_ID; } + /// The computational error attribute Id inline static const std::string& STATE() { static const std::string MY_VALUE_ID("State"); return MY_VALUE_ID; } + /// The generic initialization of attributes virtual void initAttributes() = 0; + /// Destructor MODELAPI_EXPORT ~ModelAPI_ResultParameter(); };