Update code documentation

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

diff --git a/src/XGUI/XGUI_ErrorDialog.h b/src/XGUI/XGUI_ErrorDialog.h
index 9a5ca5803d07987aef505fba7933dc10178eb8eb..b442effba67fe4925700daca9b750bafd3aa4e69 100644 (file)
--- a/src/XGUI/XGUI_ErrorDialog.h
+++ b/src/XGUI/XGUI_ErrorDialog.h
@@ -15,18 +15,35 @@
 
 class QTextEdit;
 
+/**
+* A class of dialog to show error message
+*/
 class XGUI_ErrorDialog : public QDialog
 {
 Q_OBJECT
  public:
+   /// Constructor
+   /// \param parent a parent widget
   XGUI_EXPORT XGUI_ErrorDialog(QWidget* parent);XGUI_EXPORT virtual ~XGUI_ErrorDialog();
 
  public slots:
-  XGUI_EXPORT void refresh();XGUI_EXPORT void clear();XGUI_EXPORT void addError(const QString&);XGUI_EXPORT void removeError(
-      const QString&);
+   /// 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:
+   /// Widget for error log
   QTextEdit* myErrorLog;
+
+  /// List of errors
   QStringList myErrors;
 };