Update the Doxygen documentation for the Model* packages

diff --git a/src/Model/Model_BodyBuilder.h b/src/Model/Model_BodyBuilder.h
index c5135c7736b2b3e3ef49e47d95f45ea7e4da64aa..85032d4f81d5282f3a93f60f6324e6f81d563625 100755 (executable)
--- 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 42fff591b6c08b02eada5fd85f20d06bd3c1bbe9..0a497b271b2d86ac3f50c31b324b9de90ec904f8 100644 (file)
--- 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 3de093e745bf9c79d1c36283942ab8d1484ae90b..2252d455eeadd42782e7b331a35c3dc69a303ae7 100644 (file)
--- 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 9e5fa029caee4cd426ec96e66924cf34a9af5c49..1e200f40e0bc03836bfa608b8b98b891ff529a65 100644 (file)
--- 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 bd69891b7b2f55961df02f5d4451f464c810a710..862a078cee86db631bcff1f09868a8beb4345618 100644 (file)
--- 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 1cf46a54cde7b10ccb2e8feb1586ee165d223138..142c91c233689bb32a729ca6e232263c3b8b2a9f 100644 (file)
--- 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<std::string>& theArguments,
                        std::string& theError) const = 0;

diff --git a/src/ModelAPI/ModelAPI_BodyBuilder.h b/src/ModelAPI/ModelAPI_BodyBuilder.h
index ff43ca7c454dc375fe6e19e128d1642309635e48..3d945b47c4622c9bef6547bba2e98240c421354c 100755 (executable)
--- 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<ModelAPI_Document> 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 0f4ccc3302bdf510196bdb23b93bf1be412fe442..b6419ec8266442d75d3c2caeaababc29b1191a9b 100644 (file)
--- 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<ModelAPI_ResultConstruction> createConstruction(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
-  //! Creates a body results
+  //! Creates a body result
   virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
-  //! Creates a part results
+  //! Creates a part result
   virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
   //! Copies a part result, keeping the reference to the origin
   virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
       const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
-  //! Creates a group results
+  //! Creates a group result
   virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
-
+  //! Creates a parameter result
   virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 

diff --git a/src/ModelAPI/ModelAPI_FeatureValidator.h b/src/ModelAPI/ModelAPI_FeatureValidator.h
index 6b83d30e8edde7909dd53e6a0998855d315b0ecb..f051c1e0d4a27e23bf64baea4e3cf12f755a7b19 100644 (file)
--- 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<ModelAPI_Feature>& theFeature,
                        const std::list<std::string>& theArguments,
                        std::string& theError) const = 0;

diff --git a/src/ModelAPI/ModelAPI_Result.h b/src/ModelAPI/ModelAPI_Result.h
index fb96df98c3b350d62096aeecf31e66843a39a403..14f69a32fb38dbbdd75a660480c62cf0d38c7774 100644 (file)
--- 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 1cce02786096552175a566dcf0adbbd0700be349..54df9a2c65c6cfa974ce5a958a9a3f35f9dc5626 100644 (file)
--- 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 ad47ce9c709e20da56e03dc64e81785bccedbf58..4a8c293c877459decdfc9e386b7e7b7024b06ff3 100644 (file)
--- 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();
 
 };