X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FParametersPlugin%2FParametersPlugin_Validators.h;h=cc1812abc711f87bad0424fdef8590ea2b8d5ce0;hb=1490e92974d2c0bdcdbecd6fa9388e31dccfa363;hp=a0551de61f8301321dbc62f086ee349eceaea5b4;hpb=7807756f46b9dcd90994ac57a8a514f0570e794e;p=modules%2Fshaper.git

diff --git a/src/ParametersPlugin/ParametersPlugin_Validators.h b/src/ParametersPlugin/ParametersPlugin_Validators.h
index a0551de61..cc1812abc 100644
--- a/src/ParametersPlugin/ParametersPlugin_Validators.h
+++ b/src/ParametersPlugin/ParametersPlugin_Validators.h
@@ -26,18 +26,20 @@ class ParametersPlugin_VariableValidator : public ModelAPI_AttributeValidator
   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
-  //! \param theError the error string message if validation fails
+  /**
+   * \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,
                                                std::string& theError) const;
 
  protected:
-  /// Returns true if theString is a variable name.
+  /// 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 for theAttribute context.
+  /// 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;
 };
@@ -53,10 +55,12 @@ class ParametersPlugin_ExpressionValidator: public ModelAPI_AttributeValidator
   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
-  //! \param theError the error string message if validation fails
+  /**
+   * \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,
                                                std::string& theError) const;