From: dbv <dbv@opencascade.com>
Date: Fri, 18 Sep 2015 16:07:38 +0000 (+0300)
Subject: GeomValidators documentation update
X-Git-Tag: V_1.4.0~7
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=5c8f1741844e01e400d18a91d6a377877d1629d9;p=modules%2Fshaper.git

GeomValidators documentation update
---

diff --git a/src/GeomValidators/GeomValidators_BooleanArguments.h b/src/GeomValidators/GeomValidators_BooleanArguments.h
index d5c903111..1686c8ee4 100644
--- a/src/GeomValidators/GeomValidators_BooleanArguments.h
+++ b/src/GeomValidators/GeomValidators_BooleanArguments.h
@@ -21,6 +21,7 @@ public:
   /** \brief Returns true if feature and/or attributes are valid.
    *  \param[in] theFeature the validated feature.
    *  \param[in] theArguments the arguments in the configuration file for this validator.
+   *  \param[out] theError error message.
    *  \returns true if feature is valid.
    */
   GEOMVALIDATORS_EXPORT virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
diff --git a/src/GeomValidators/GeomValidators_ConstructionComposite.h b/src/GeomValidators/GeomValidators_ConstructionComposite.h
index c9f316321..fb37f95bc 100644
--- a/src/GeomValidators/GeomValidators_ConstructionComposite.h
+++ b/src/GeomValidators/GeomValidators_ConstructionComposite.h
@@ -19,8 +19,9 @@ class GeomValidators_ConstructionComposite : public ModelAPI_AttributeValidator
  public:
    GEOMVALIDATORS_EXPORT GeomValidators_ConstructionComposite() {}
   //! returns true if attribute is valid
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
+  //! \param[in] theAttribute the checked attribute
+  //! \param[in] theArguments arguments of the attribute
+  //! \param[out] theError error message.
   GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                              const std::list<std::string>& theArguments,
                                              std::string& theError) const;
diff --git a/src/GeomValidators/GeomValidators_Different.cpp b/src/GeomValidators/GeomValidators_Different.cpp
index 353df10b8..94c369c5a 100644
--- a/src/GeomValidators/GeomValidators_Different.cpp
+++ b/src/GeomValidators/GeomValidators_Different.cpp
@@ -37,10 +37,16 @@ bool isEqualAttributes(const AttributePtr& theLeft, const AttributePtr& theRight
   return false;
 }
 
+/** \class IsEqual
+ *  \ingroup Validators
+ *  \brief Auxiliary class used in std::find_if
+ */
 class IsEqual {
   AttributePtr myAttribute;
 public:
+  /// Constructor
   IsEqual(const AttributePtr& theAttribute) : myAttribute(theAttribute) {}
+  /// \return true in case if AttributePtr is equal with myAttribute
   bool operator()(const AttributePtr& theAttribute) {
     return isEqualAttributes(myAttribute, theAttribute);
   }
diff --git a/src/GeomValidators/GeomValidators_Different.h b/src/GeomValidators/GeomValidators_Different.h
index 28cc2c58f..a5be84f7b 100644
--- a/src/GeomValidators/GeomValidators_Different.h
+++ b/src/GeomValidators/GeomValidators_Different.h
@@ -21,6 +21,7 @@ public:
   /** \brief Returns true if feature and/or attributes are valid.
    *  \param[in] theFeature the validated feature.
    *  \param[in] theArguments the arguments in the configuration file for this validator.
+   *  \param[out] theError error message.
    *  \returns true if feature is valid.
    */
   GEOMVALIDATORS_EXPORT virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
diff --git a/src/GeomValidators/GeomValidators_DifferentShapes.h b/src/GeomValidators/GeomValidators_DifferentShapes.h
index 1fbb004e0..033ef1b3c 100644
--- a/src/GeomValidators/GeomValidators_DifferentShapes.h
+++ b/src/GeomValidators/GeomValidators_DifferentShapes.h
@@ -20,8 +20,9 @@ class GeomValidators_DifferentShapes : public ModelAPI_AttributeValidator
 public:
   /// returns True if the attribute is valid. It checks whether the feature of the attribute
   /// does not contain a selection attribute filled with the same shape
-  /// \param theAttribute an attribute to check
-  /// \param theArguments a filter parameters
+  /// \param[in] theAttribute an attribute to check
+  /// \param[in] theArguments a filter parameters
+  /// \param[out] theError error message.
   MODELAPI_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                        const std::list<std::string>& theArguments,
                                        std::string& theError) const;
diff --git a/src/GeomValidators/GeomValidators_Face.h b/src/GeomValidators/GeomValidators_Face.h
index c66d4b315..b10cecff7 100644
--- a/src/GeomValidators/GeomValidators_Face.h
+++ b/src/GeomValidators/GeomValidators_Face.h
@@ -21,8 +21,9 @@ class GeomValidators_Face : public ModelAPI_AttributeValidator
  public:
    GEOMVALIDATORS_EXPORT GeomValidators_Face() {}
   //! returns true if attribute is valid
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
+  //! \param[in] theAttribute the checked attribute
+  //! \param[in] theArguments arguments of the attribute
+  //! \param[out] theError error message.
   GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                              const std::list<std::string>& theArguments,
                                              std::string& theError) const;
diff --git a/src/GeomValidators/GeomValidators_Finite.h b/src/GeomValidators/GeomValidators_Finite.h
index 927142dd6..85b5b9803 100755
--- a/src/GeomValidators/GeomValidators_Finite.h
+++ b/src/GeomValidators/GeomValidators_Finite.h
@@ -18,8 +18,9 @@ class GeomValidators_Finite : public ModelAPI_AttributeValidator
 {
 public:
   //! returns true if attribute is valid
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
+  //! \param[in] theAttribute the checked attribute
+  //! \param[in] theArguments arguments of the attribute
+  //! \param[out] theError error message.
   GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                              const std::list<std::string>& theArguments,
                                              std::string& theError) const;
diff --git a/src/GeomValidators/GeomValidators_PartitionArguments.h b/src/GeomValidators/GeomValidators_PartitionArguments.h
index 8233cbfbc..1b3207001 100644
--- a/src/GeomValidators/GeomValidators_PartitionArguments.h
+++ b/src/GeomValidators/GeomValidators_PartitionArguments.h
@@ -21,6 +21,7 @@ public:
   /** \brief Returns true if feature and/or attributes are valid.
    *  \param[in] theFeature the validated feature.
    *  \param[in] theArguments the arguments in the configuration file for this validator.
+   *  \param[out] theError error message.
    *  \returns true if feature is valid.
    */
   GEOMVALIDATORS_EXPORT virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
diff --git a/src/GeomValidators/GeomValidators_Positive.h b/src/GeomValidators/GeomValidators_Positive.h
index 8c88ab08d..0e15c77d2 100644
--- a/src/GeomValidators/GeomValidators_Positive.h
+++ b/src/GeomValidators/GeomValidators_Positive.h
@@ -19,8 +19,9 @@ public:
   //! Constructor for only one instance per application: will register the validator
   GeomValidators_Positive();
   //! returns true if attribute is valid
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
+  //! \param[in] theAttribute the checked attribute
+  //! \param[in] theArguments arguments of the attribute
+  //! \param[out] theError error message.
   GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                              const std::list<std::string>& theArguments,
                                              std::string& theError) const;
diff --git a/src/GeomValidators/GeomValidators_ShapeType.h b/src/GeomValidators/GeomValidators_ShapeType.h
index fd6e24e18..57de14708 100644
--- a/src/GeomValidators/GeomValidators_ShapeType.h
+++ b/src/GeomValidators/GeomValidators_ShapeType.h
@@ -23,7 +23,7 @@
 class GeomValidators_ShapeType : public ModelAPI_AttributeValidator
 {
  public:
-  //  the edge type
+  /// Type of shape
   enum TypeOfShape
   {
     Empty,
@@ -41,8 +41,9 @@ class GeomValidators_ShapeType : public ModelAPI_AttributeValidator
  public:
    GEOMVALIDATORS_EXPORT GeomValidators_ShapeType() {}
   //! Returns true if attribute has shape type listed in the parameter arguments
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
+  //! \param[in] theAttribute the checked attribute
+  //! \param[in] theArguments arguments of the attribute
+  //! \param[out] theError error message.
   GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                              const std::list<std::string>& theArguments,
                                              std::string& theError) const;
@@ -52,22 +53,25 @@ protected:
   static TypeOfShape shapeType(const std::string& theType);
 
   /// Returns true if the attibute's object type satisfies the argument value
-  /// \param theAttribute a checked attribute
-  /// \param theArgument a parameter
+  /// \param[in] theAttribute a checked attribute
+  /// \param[in] theShapeType a type of shape
+  /// \param[out] theError error message.
   bool isValidAttribute(const AttributePtr& theAttribute,
                         const TypeOfShape theShapeType,
                         std::string& theError) const;
 
   /// Returns true if the attibute's object type satisfies the argument value
-  /// \param theAttribute a checked object
-  /// \param theShapeType a shape type
+  /// \param[in] theObject a checked object
+  /// \param[in] theShapeType a shape type
+  /// \param[out] theError error message.
   bool isValidObject(const ObjectPtr& theObject,
                      const TypeOfShape theShapeType,
                      std::string& theError) const;
 
   /// Returns true if the attibute's object type satisfies the argument value
-  /// \param theShape a checked shape
-  /// \param theShapeType a shape type
+  /// \param[in] theShape a checked shape
+  /// \param[in] theShapeType a shape type
+  /// \param[out] theError error message.
   bool isValidShape(const GeomShapePtr theShape,
                     const TypeOfShape theShapeType,
                     std::string& theError) const;
diff --git a/src/GeomValidators/GeomValidators_ZeroOffset.h b/src/GeomValidators/GeomValidators_ZeroOffset.h
index 91c7dcad9..64fd4ab63 100644
--- a/src/GeomValidators/GeomValidators_ZeroOffset.h
+++ b/src/GeomValidators/GeomValidators_ZeroOffset.h
@@ -21,6 +21,7 @@ public:
   /** \brief Returns true if feature and/or attributes are valid.
    *  \param[in] theFeature the validated feature.
    *  \param[in] theArguments the arguments in the configuration file for this validator.
+   *  \param[out] theError error message.
    *  \return true if feature is valid.
    */
   GEOMVALIDATORS_EXPORT virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,