Mercurial > trustbridge > trustbridge
diff ui/certificatediffdialog.h @ 1255:2a1aa9df8f11
(issue133) Improve API documentation
author | Andre Heinecke <andre.heinecke@intevation.de> |
---|---|
date | Thu, 25 Sep 2014 17:58:12 +0200 |
parents | 8728ae882b6a |
children |
line wrap: on
line diff
--- a/ui/certificatediffdialog.h Thu Sep 25 17:37:03 2014 +0200 +++ b/ui/certificatediffdialog.h Thu Sep 25 17:58:12 2014 +0200 @@ -18,15 +18,27 @@ class AdministratorWindow; +/** @brief Specialized dialog for the differences in two certificate lists + * + * When certificates are added or removed from one list to the next + * this dialog is intended to show the differences between the old and + * the new list. + */ class CertificateDiffDialog : public QDialog { Q_OBJECT public: /** @brief Create a dialog showing the changes made in the certificate list. + * + * This class knows enough about the parent that it uses the parent's + * accessor functions to get at the information it should present. + * + * @param[in] parent A reference to the AdministratorWindow */ CertificateDiffDialog(AdministratorWindow *parent); private: + /** @brief Create the UI elements. */ void setupGUI(); AdministratorWindow *mAdminWindow;