Update of documentation in the Model package

diff --git a/src/Model/Model_AttributeSelection.h b/src/Model/Model_AttributeSelection.h
index fba911b921e872892cd15c6dc209f646dab239b1..665758341c1c8aa1ac158eabd1369b78d660314d 100644 (file)
--- a/src/Model/Model_AttributeSelection.h
+++ b/src/Model/Model_AttributeSelection.h
@@ -85,7 +85,7 @@ protected:
   /// \param theContext the result - owner of the selection
   /// \param theSubShape selected shape
   /// \param theUpdate flag that shows that it must be just update, theShape is null
-  /// \param returns true if eveything is selected correctly
+  /// \returns true if eveything is selected correctly
   virtual bool selectPart(
     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
     const bool theUpdate = false);

diff --git a/src/Model/Model_AttributeValidator.h b/src/Model/Model_AttributeValidator.h
index eea6cda4b33f65478fd85a7087b1e576c883778f..3e8240cdf1c3549c26d46b53a482972e7f2c6875 100644 (file)
--- a/src/Model/Model_AttributeValidator.h
+++ b/src/Model/Model_AttributeValidator.h
@@ -22,6 +22,7 @@ class Model_AttributeValidator : public ModelAPI_AttributeValidator
 public:
   /// \param theAttribute the checked attribute
   /// \param theArguments arguments of the attribute
+  /// \param theError erros message produced by validator to the user if it fails
   /// \returns true if attribute is valid
   MODEL_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                     const std::list<std::string>& theArguments,

diff --git a/src/Model/Model_BodyBuilder.h b/src/Model/Model_BodyBuilder.h
index fbbcce9f631615aef1ad11d91fbbc318a3aa5d11..c5135c7736b2b3e3ef49e47d95f45ea7e4da64aa 100755 (executable)
--- a/src/Model/Model_BodyBuilder.h
+++ b/src/Model/Model_BodyBuilder.h
@@ -110,6 +110,7 @@ public:
   MODEL_EXPORT virtual void evolutionToSelection(const bool theFlag);
 
 protected:
+  /// Default constructor accessible only by Model_Objects
   Model_BodyBuilder(ModelAPI_Object* theOwner);
 
   /// Removes the stored builders

diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h
index a3f28a20f0262a1de52b9f82549c5fcaf260b65a..a728c215870e6cc6e544b3cac53e20ea47d24035 100644 (file)
--- a/src/Model/Model_Document.h
+++ b/src/Model/Model_Document.h
@@ -134,6 +134,7 @@ class Model_Document : public ModelAPI_Document
   //! will be appended after this one.
   //! \param theCurrent the selected feature as current: blow it everythin become disabled
   //! \param theVisible use visible features only: flag is true for Object Browser functionality
+  //! \param theFlushUpdates if it is true method calls flushes for creation/redisplay/delete messages
   MODEL_EXPORT virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
     const bool theVisible, const bool theFlushUpdates = true);
 
@@ -164,10 +165,10 @@ class Model_Document : public ModelAPI_Document
   MODEL_EXPORT 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);
-  /// Creates a group results
+  /// Creates a group result
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
-
+  /// Creates a parameter result
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
 

diff --git a/src/Model/Model_FeatureValidator.h b/src/Model/Model_FeatureValidator.h
index c35acc8e10fdd5fb5d6cad160be8ca494b578307..010ad505c6cf9667df9088be8b8d77042856b527 100644 (file)
--- a/src/Model/Model_FeatureValidator.h
+++ b/src/Model/Model_FeatureValidator.h
@@ -31,6 +31,7 @@ public:
   /// Returns true if feature and/or attributes are valid
   /// \param theFeature the validated feature
   /// \param theArguments the arguments in the configuration file for this validator
+  /// \param theError erros message produced by validator to the user if it fails
   /// \returns true if feature is valid
   MODEL_EXPORT virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                                     const std::list<std::string>& theArguments,

diff --git a/src/Model/Model_Objects.h b/src/Model/Model_Objects.h
index 0b11f4436c05ddf72e05ab68487086bc7e5177e6..dc1fe7855a74cd19abd0879fcaa072365af8ca1d 100644 (file)
--- a/src/Model/Model_Objects.h
+++ b/src/Model/Model_Objects.h
@@ -95,23 +95,23 @@ class Model_Objects
   //! Returns the feature by zero-based index: features in the history or not
   std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
 
-  /// Creates a construction results
+  /// Creates a construction result
   std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
-  /// Creates a body results
+  /// Creates a body result
   std::shared_ptr<ModelAPI_ResultBody> createBody(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
-  /// Creates a part results
+  /// Creates a part result
   std::shared_ptr<ModelAPI_ResultPart> createPart(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
-  /// Copies a part results, keeping the reference to origin
+  /// Copies a part result, keeping the reference to origin
   std::shared_ptr<ModelAPI_ResultPart> copyPart(
       const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
-  /// Creates a group results
+  /// Creates a group result
   std::shared_ptr<ModelAPI_ResultGroup> createGroup(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
-
+  /// Creates a parameter result
   std::shared_ptr<ModelAPI_ResultParameter> createParameter(
       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
 
@@ -175,7 +175,8 @@ class Model_Objects
   /// Creates the history: up to date with the current state
   void createHistory(const std::string& theGroupID);
 
-  /// Returns to the next (from the history point of view) feature, any: invisible or disabled
+  /// Returns the next (from the history point of view) feature, any: invisible or disabled
+  /// \param theCurrent previous to the resulting feature
   /// \param theReverse if it is true, iterates in reverced order (next becomes previous)
   FeaturePtr nextFeature(FeaturePtr theCurrent, const bool theReverse = false);
   /// Returns to the first (from the history point of view) feature, any: invisible or disabled

diff --git a/src/Model/Model_ResultParameter.h b/src/Model/Model_ResultParameter.h
index 7d3ca59859cd7eb2336ac985033660857ca23fa4..1b88609d99cce48b060531492786df9c29a676c5 100644 (file)
--- a/src/Model/Model_ResultParameter.h
+++ b/src/Model/Model_ResultParameter.h
@@ -15,7 +15,7 @@
 
 /**\class Model_ResultParameter
  * \ingroup DataModel
- * \brief
+ * \brief Result of parameter expression. Contains only double value computed result attribute.
  */
 class Model_ResultParameter : public ModelAPI_ResultParameter
 {