Documentation update

[modules/shaper.git] / src / XGUI / XGUI_QtEvents.h

diff --git a/src/XGUI/XGUI_QtEvents.h b/src/XGUI/XGUI_QtEvents.h
index 5c389fade4036fe81a0926b68b98a6fc50900027..0a3528bd70a16324dbda57380b49215680ac197c 100644 (file)
--- a/src/XGUI/XGUI_QtEvents.h
+++ b/src/XGUI/XGUI_QtEvents.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 /*
  * XGUI_QEvents.h
  *
@@ -16,24 +18,35 @@
 #include <QEvent>
 #include <QString>
 
+/**
+* \ingroup GUI
+* Class of event to send application events in multi thread environment
+*/
 class XGUI_EXPORT PostponeMessageQtEvent : public QEvent
 {
  public:
+   /// An event type
   static QEvent::Type PostponeMessageQtEventType;
 
+  /// Constructor
+  /// \param theMessage an event message to send
   PostponeMessageQtEvent(const std::shared_ptr<Events_Message>& theMessage)
       : QEvent(PostponeMessageQtEventType),
       myMessage(theMessage)
   {
   }
+
+  /// Returns type of the event
   static QEvent::Type type()
   {
     return PostponeMessageQtEventType;
   }
 
+  /// Returns current messasge
   std::shared_ptr<Events_Message> postponedMessage();
 
  private:
+   /// Message
   std::shared_ptr<Events_Message> myMessage;
 };