X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FParametersPlugin%2FParametersPlugin_EvalListener.h;h=76639caef039b10245949a594ea85a53ffc14166;hb=09dabb6acd9664f589a0bd9415d804d7a37ab801;hp=c24831780ebf1b2cf53dfa7eb8b101867681a94e;hpb=711560136859ac1fdc980aaacb38d039c0ccee3d;p=modules%2Fshaper.git

diff --git a/src/ParametersPlugin/ParametersPlugin_EvalListener.h b/src/ParametersPlugin/ParametersPlugin_EvalListener.h
index c24831780..76639caef 100644
--- a/src/ParametersPlugin/ParametersPlugin_EvalListener.h
+++ b/src/ParametersPlugin/ParametersPlugin_EvalListener.h
@@ -13,36 +13,51 @@
 
 class ModelAPI_Attribute;
 class ModelAPI_Document;
+class ModelAPI_Feature;
 class ModelAPI_ResultParameter;
 class ParametersPlugin_Parameter;
 class ParametersPlugin_PyInterp;
 
+/**
+ * \class ParametersPlugin_EvalListener
+ * \ingroup Plugins
+ * \brief Class which process the events from the event loop.
+ */
 class ParametersPlugin_EvalListener : public Events_Listener
 {
  public:
   PARAMETERSPLUGIN_EXPORT ParametersPlugin_EvalListener();
   PARAMETERSPLUGIN_EXPORT virtual ~ParametersPlugin_EvalListener();
 
+  /// Reimplemented from Events_Listener::processEvent().
   PARAMETERSPLUGIN_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 
  protected:
-  double evaluate(const std::string& theExpression, std::string& theError, 
-                  const std::shared_ptr<ModelAPI_Document>& theDocument);
+  /// Evaluates theExpression and returns its value.
+   double evaluate(std::shared_ptr<ModelAPI_Feature> theParameter,
+                  const std::string& theExpression, std::string& theError);
 
+  /// Processes Evaluation event.
   void processEvaluationEvent(const std::shared_ptr<Events_Message>& theMessage);
+  /// Processes ObjectRenamed event.
   void processObjectRenamedEvent(const std::shared_ptr<Events_Message>& theMessage);
+  /// Processes ReplaceParameter event.
   void processReplaceParameterEvent(const std::shared_ptr<Events_Message>& theMessage);
 
+  /// Renames theOldName in theExpression by theNewName.
   std::string renameInPythonExpression(const std::string& theExpression,
                                        const std::string& theOldName,
                                        const std::string& theNewName);
+  /// Renames theOldName in the expression attribute of theParameter by theNewName.
   void renameInParameter(std::shared_ptr<ParametersPlugin_Parameter> theParameter,
                          const std::string& theOldName,
                          const std::string& theNewName);
+  /// Renames theOldName in the text fields of theAttribute by theNewName.
   void renameInAttribute(std::shared_ptr<ModelAPI_Attribute> theAttribute,
                          const std::string& theOldName,
                          const std::string& theNewName);
-  void renameInDependants(std::shared_ptr<ModelAPI_ResultParameter> theResultParameter,
+  /// Renames theOldName in all dependents of theResultParameter by theNewName.
+  void renameInDependents(std::shared_ptr<ModelAPI_ResultParameter> theResultParameter,
                           const std::string& theOldName,
                           const std::string& theNewName);