Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0

[modules/shaper.git] / src / Events / Events_Error.h

diff --git a/src/Events/Events_Error.h b/src/Events/Events_Error.h
index 7e2e62e293ac15c691ef55c01aeab06fb4f05f03..561c987ce141be705eb03dc88f7b049babde742b 100644 (file)
--- a/src/Events/Events_Error.h
+++ b/src/Events/Events_Error.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * Events_Error.h
  *
@@ -13,19 +15,32 @@
 
 #include <string>
 
-class EVENTS_EXPORT Events_Error: public Events_Message
+/**\class Events_Error
+ * \ingroup EventsLoop
+ * \brief An error message event.
+ *
+ * Is generated by any algorithm or GUI of the application to inform the user about
+ * the problem. In GUI mode all such errors are collected in the message log window.
+ */
+class EVENTS_EXPORT Events_Error : public Events_Message
 {
-  char* myDescription; ///< pointer to the description of the error
+  char* myDescription;  ///< pointer to the description of the error
 
 public:
+  /// default destructor   
   virtual ~Events_Error();
 
+  /// Identifier of this event (one for all errors)
   static Events_ID errorID();
+  /// Specific error string
   char* description() const;
+  /// Allows to send an error quickly: it creates and sends the error object automatically
   static void send(char* theDescription, const void* theSender = 0);
+  /// Allows to send an error quickly: it creates and sends the error object automatically
   static void send(std::string theDescription, const void* theSender = 0);
 
 protected:
+  /// Default constructor. Use "send" message for generation an error.
   Events_Error(char* theDescription, const void* theSender = 0);
 };