From 04969ec755978eceaa32ef47d6621905d072bf73 Mon Sep 17 00:00:00 2001 From: mpv Date: Thu, 17 Sep 2015 19:41:42 +0300 Subject: [PATCH] Update of documentation in the Model package --- src/Model/Model_AttributeSelection.h | 2 +- src/Model/Model_AttributeValidator.h | 1 + src/Model/Model_BodyBuilder.h | 1 + src/Model/Model_Document.h | 5 +++-- src/Model/Model_FeatureValidator.h | 1 + src/Model/Model_Objects.h | 15 ++++++++------- src/Model/Model_ResultParameter.h | 2 +- 7 files changed, 16 insertions(+), 11 deletions(-) diff --git a/src/Model/Model_AttributeSelection.h b/src/Model/Model_AttributeSelection.h index fba911b92..665758341 100644 --- 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& theSubShape, const bool theUpdate = false); diff --git a/src/Model/Model_AttributeValidator.h b/src/Model/Model_AttributeValidator.h index eea6cda4b..3e8240cdf 100644 --- 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& theArguments, diff --git a/src/Model/Model_BodyBuilder.h b/src/Model/Model_BodyBuilder.h index fbbcce9f6..c5135c773 100755 --- 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 a3f28a20f..a728c2158 100644 --- 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 theCurrent, const bool theVisible, const bool theFlushUpdates = true); @@ -164,10 +165,10 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual std::shared_ptr copyPart( const std::shared_ptr& theOrigin, const std::shared_ptr& theFeatureData, const int theIndex = 0); - /// Creates a group results + /// Creates a group result MODEL_EXPORT virtual std::shared_ptr createGroup( const std::shared_ptr& theFeatureData, const int theIndex = 0); - + /// Creates a parameter result MODEL_EXPORT virtual std::shared_ptr createParameter( const std::shared_ptr& theFeatureData, const int theIndex = 0); diff --git a/src/Model/Model_FeatureValidator.h b/src/Model/Model_FeatureValidator.h index c35acc8e1..010ad505c 100644 --- 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& theFeature, const std::list& theArguments, diff --git a/src/Model/Model_Objects.h b/src/Model/Model_Objects.h index 0b11f4436..dc1fe7855 100644 --- 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 internalFeature(const int theIndex); - /// Creates a construction results + /// Creates a construction result std::shared_ptr createConstruction( const std::shared_ptr& theFeatureData, const int theIndex = 0); - /// Creates a body results + /// Creates a body result std::shared_ptr createBody( const std::shared_ptr& theFeatureData, const int theIndex = 0); - /// Creates a part results + /// Creates a part result std::shared_ptr createPart( const std::shared_ptr& 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 copyPart( const std::shared_ptr& theOrigin, const std::shared_ptr& theFeatureData, const int theIndex = 0); - /// Creates a group results + /// Creates a group result std::shared_ptr createGroup( const std::shared_ptr& theFeatureData, const int theIndex = 0); - + /// Creates a parameter result std::shared_ptr createParameter( const std::shared_ptr& 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 7d3ca5985..1b88609d9 100644 --- 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 { -- 2.39.2