diff ui/administratorwindow.h @ 1255:2a1aa9df8f11

(issue133) Improve API documentation
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 25 Sep 2014 17:58:12 +0200
parents 78798d3af8f0
children ff9cd05e861e
line wrap: on
line diff
--- a/ui/administratorwindow.h	Thu Sep 25 17:37:03 2014 +0200
+++ b/ui/administratorwindow.h	Thu Sep 25 17:58:12 2014 +0200
@@ -25,6 +25,11 @@
 class QMenu;
 class QAction;
 
+/** @brief Main Window of the Administrator application
+  *
+  * The controlling class of the Admin application. Holds
+  * the certificate data and the settings of the application.
+  */
 class AdministratorWindow : public QMainWindow
 {
     Q_OBJECT
@@ -58,21 +63,50 @@
     QList<Certificate> currentChanges();
 
 private slots:
+    /** @brief Create the SW Packages for the target platforms. */
     void createInstaller();
+    /** @brief Shows the About dialog. */
     void showAbout();
+    /** @brief Opens the Help in a browser window. */
     void showHelp();
+    /** @brief Presents a Dialog to load a certificate list and handles the loading. */
     void loadCertificateFile();
+    /** @brief Save the current selection of certificates as a certificate list. */
     void saveCertificateFile();
+    /** @brief Add certificates to the certificate table. */
     void addCertificates();
+    /** @brief Remove certificates from the current certificate table. */
     void removeCertificates();
+    /** @brief Changes the state of a certificate when it was clicked. */
     void clickedCertificate(const QModelIndex&);
 
 private:
+    /** @brief Setup UI Actions */
     void createActions();
+    /** @brief Setup UI Menu Bar */
     void createMenuBar();
+    /** @brief Create the UI elements of the Window */
     void createContent();
+    /** @brief Load a certificate list into the table view */
     void loadCertificateTable();
+    /** @brief Add a list of certificates to the table view
+     *
+     * @param[in] certs The certificates to add.
+     */
     void addToCertificateTable(const QList<Certificate> &certs);
+    /** @brief write a log file for the list creation.
+     *
+     * This creates a log entry containing all pertinent information of a
+     * certificate list creation. It records changes
+     * made to the certificate list and notes down the current time and
+     * the key used to sign the certificate list.
+     *
+     * @param [in] list the certificate list that is about to be created and should
+     * be logged.
+     * @param [in] keyFingerprint the encoded fingerprint of the signing key used.
+     *
+     * @returns A byte array containing the log information in latin1 encoding.
+     */
     QByteArray createLogEntries(const CertificateList &list, const QString &keyFingerprint);
 
     QSettings mSettings;

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