X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FParametersPlugin%2FParametersPlugin_Validators.h;h=cc1812abc711f87bad0424fdef8590ea2b8d5ce0;hb=5a4405dc843479d921b53b83c181cbe9359414fe;hp=be8f285b5c1684edfd38cc0bccafa3e344cadbce;hpb=6bb3ec6c114b55c02bad00ec953cd5b867eb7083;p=modules%2Fshaper.git

diff --git a/src/ParametersPlugin/ParametersPlugin_Validators.h b/src/ParametersPlugin/ParametersPlugin_Validators.h
index be8f285b5..cc1812abc 100644
--- a/src/ParametersPlugin/ParametersPlugin_Validators.h
+++ b/src/ParametersPlugin/ParametersPlugin_Validators.h
@@ -15,34 +15,55 @@
 
 #include <memory>
 
+/**
+ * \class ParametersPlugin_VariableValidator
+ * \ingroup Validators
+ * \brief Validator for the variable name of parameter.
+ */
 class ParametersPlugin_VariableValidator : public ModelAPI_AttributeValidator
 {
  public:
   PARAMETERSPLUGIN_EXPORT ParametersPlugin_VariableValidator();
   PARAMETERSPLUGIN_EXPORT virtual ~ParametersPlugin_VariableValidator();
 
-  //! returns true if attribute is valid
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
+  /**
+   * \brief Returns true if attribute has a valid parameter name.
+   * \param theAttribute the checked attribute
+   * \param theArguments arguments of the attribute
+   * \param theError the error string message if validation fails
+   */
   PARAMETERSPLUGIN_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
-                                               const std::list<std::string>& theArguments) const;
+                                               const std::list<std::string>& theArguments,
+                                               std::string& theError) const;
 
  protected:
+  /// Returns true if theString is a valid variable name.
   PARAMETERSPLUGIN_EXPORT bool isVariable(const std::string& theString) const;
-
+  /// Returns true if theString is unique parameter name in the document of theAttribute.
+  PARAMETERSPLUGIN_EXPORT bool isUnique(const AttributePtr& theAttribute,
+                                        const std::string& theString) const;
 };
 
+/**
+ * \class ParametersPlugin_ExpressionValidator
+ * \ingroup Validators
+ * \brief Validator for the expression of parameter.
+ */
 class ParametersPlugin_ExpressionValidator: public ModelAPI_AttributeValidator
 {
  public:
   PARAMETERSPLUGIN_EXPORT ParametersPlugin_ExpressionValidator();
   PARAMETERSPLUGIN_EXPORT virtual ~ParametersPlugin_ExpressionValidator();
 
-  //! returns true if attribute is valid
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
+  /**
+   * \brief Returns true if attribute has a valid parameter expression.
+   * \param theAttribute the checked attribute
+   * \param theArguments arguments of the attribute
+   * \param theError the error string message if validation fails
+   */
   PARAMETERSPLUGIN_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
-                                               const std::list<std::string>& theArguments) const;
+                                               const std::list<std::string>& theArguments,
+                                               std::string& theError) const;
 };