Mercurial > trustbridge
diff ui/mainwindow.h @ 1255:2a1aa9df8f11
(issue133) Improve API documentation
author | Andre Heinecke <andre.heinecke@intevation.de> |
---|---|
date | Thu, 25 Sep 2014 17:58:12 +0200 |
parents | 9a482182f80f |
children | 64f812a63de6 |
line wrap: on
line diff
--- a/ui/mainwindow.h Thu Sep 25 17:37:03 2014 +0200 +++ b/ui/mainwindow.h Thu Sep 25 17:58:12 2014 +0200 @@ -35,6 +35,13 @@ class QPushButton; +/** @brief Main UI controller + * + * The MainWindow controls the logic of the Application + * it is the central piece that controls the state and starts + * updates / certificate installation. + * It also controls the UI widgets for the various certificate lists. + */ class MainWindow : public QMainWindow { Q_OBJECT @@ -69,11 +76,16 @@ * @brief The internal state of the application */ enum CurrentState { - NewListAvailable, /*! A new certificate list is available. */ - NewSoftwareAvailable, /*! A new Software is avaialable. */ - DownloadingSW, /*! Download in progress. */ - TransferError, /*! An error happened on the last connection. */ - NothingChanged /*! Update was susccessfull but nothing new is available. */ + /*! A new certificate list is available. */ + NewListAvailable, + /*! A new Software is avaialable. */ + NewSoftwareAvailable, + /*! Download in progress. */ + DownloadingSW, + /*! An error happened on the last connection. */ + TransferError, + /*! Update was susccessfull but nothing new is available. */ + NothingChanged }; /** @@ -81,9 +93,13 @@ * @brief Errors that should be stored and only shown after some time has elapsed. */ enum LongTimeErrors { - lteInvalidSoftware, /*! The downloaded Software was invalid. */ - lteInvalidCertificate, /*! The SSL certificate of the download server was wrong. */ - lteInvalidList, /*! The downloaded Certificate List was invalid. */ + /*! The downloaded Software was invalid. */ + lteInvalidSoftware, + /*! The SSL certificate of the download server was wrong. */ + lteInvalidCertificate, + /*! The downloaded Certificate List was invalid. */ + lteInvalidList, + /*! No connection to the server could be established. */ lteNoConnection };