Updated copyright comment

[modules/shaper.git] / src / ParametersPlugin / ParametersPlugin_Validators.h

diff --git a/src/ParametersPlugin/ParametersPlugin_Validators.h b/src/ParametersPlugin/ParametersPlugin_Validators.h
index a0551de61f8301321dbc62f086ee349eceaea5b4..9dc3e0e94d0aac7234c9628cb77012aa98c43f46 100644 (file)
--- a/src/ParametersPlugin/ParametersPlugin_Validators.h
+++ b/src/ParametersPlugin/ParametersPlugin_Validators.h
@@ -1,9 +1,21 @@
-/*
- * Parameters_VariableValidator.h
- *
- *  Created on: Apr 9, 2015
- *      Author: sbh
- */
+// Copyright (C) 2014-2024  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef PARAMETERSPLUGIN_VARIABLEVALIDATOR_H_
 #define PARAMETERSPLUGIN_VARIABLEVALIDATOR_H_
@@ -26,18 +38,18 @@ 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;
+                                               Events_InfoMessage& theError) const;
 
  protected:
-  /// Returns true if theString is a 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,13 +65,15 @@ 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;
+                                               Events_InfoMessage& theError) const;
 };