diff ui/aboutdialog.h @ 1255:2a1aa9df8f11

(issue133) Improve API documentation
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 25 Sep 2014 17:58:12 +0200
parents 1642a79cc02d
children
line wrap: on
line diff
--- a/ui/aboutdialog.h	Thu Sep 25 17:37:03 2014 +0200
+++ b/ui/aboutdialog.h	Thu Sep 25 17:58:12 2014 +0200
@@ -15,14 +15,20 @@
  * @brief The dialog for information about the application.
  */
 
+/** @brief AboutDialog of the admin application
+  *
+  * This is a specialized QDialog for the About information
+  * of the administrator application.
+  */
 class AboutDialog : public QDialog
 {
     Q_OBJECT
 public:
-    /** @brief Create a help dialog */
+    /** @brief Create the about dialog */
     AboutDialog(QMainWindow *parent);
 
 private:
+    /** @brief Create UI elements */
     void setupGUI();
 
 };

http://wald.intevation.org/projects/trustbridge/