Issue #1535 crash when mirror: debug information

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

diff --git a/src/XGUI/XGUI_ErrorDialog.h b/src/XGUI/XGUI_ErrorDialog.h
index 59de5059a20250adf750a256b7e99166d89a5467..b6f53e6bca1358b067159c52e2a73fbce521a022 100644 (file)
--- a/src/XGUI/XGUI_ErrorDialog.h
+++ b/src/XGUI/XGUI_ErrorDialog.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 /*
  * XGUI_ErrorDialog.h
  *
@@ -13,21 +15,37 @@
 
 class QTextEdit;
 
-class XGUI_ErrorDialog: public QDialog
+/**
+* \ingroup GUI
+* A class of dialog to show error message
+*/
+class XGUI_ErrorDialog : public QDialog
 {
-  Q_OBJECT
-public:
+Q_OBJECT
+ public:
+   /// Constructor
+   /// \param parent a parent widget
   XGUI_EXPORT XGUI_ErrorDialog(QWidget* parent);
   XGUI_EXPORT virtual ~XGUI_ErrorDialog();
 
-public slots:
+ public slots:
+   /// Update dialog box
   XGUI_EXPORT void refresh();
+
+  /// Clear messages
   XGUI_EXPORT void clear();
+
+  /// Add error message
   XGUI_EXPORT void addError(const QString&);
+
+  /// Remove error message
   XGUI_EXPORT void removeError(const QString&);
 
-private:
+ private:
+   /// Widget for error log
   QTextEdit* myErrorLog;
+
+  /// List of errors
   QStringList myErrors;
 };