Updated docs

9 files changed, 48 insertions, 0 deletions

diff --git a/configdialog.h b/configdialog.h
index b48386ca..4c3a126a 100644
--- a/configdialog.h
+++ b/configdialog.h
@@ -13,6 +13,12 @@ struct UserInfo;
 class ConfigDialog;
 }
 
+/*!
+    \class ConfigDialog
+    \brief The ConfigDialog handles the configuration interface.
+
+    This class should also take the handling from the MainWindow class.
+*/
 class ConfigDialog : public QDialog {
   Q_OBJECT
 
diff --git a/keygendialog.h b/keygendialog.h
index 406cd6d2..64af8307 100644
--- a/keygendialog.h
+++ b/keygendialog.h
@@ -9,6 +9,10 @@ namespace Ui {
 class KeygenDialog;
 }
 
+/*!
+    \class KeygenDialog
+    \brief Handles GPG keypair generation.
+ */
 class KeygenDialog : public QDialog {
   Q_OBJECT
 
diff --git a/mainwindow.h b/mainwindow.h
index 88679008..9f730e34 100644
--- a/mainwindow.h
+++ b/mainwindow.h
@@ -28,6 +28,13 @@ struct execQueueItem {
 
 struct UserInfo;
 
+/*!
+    \class MainWindow
+    \brief The MainWindow class does way too much, not only is it a switchboard,
+    configuration handler and more, it's also the process-manager.
+
+    This class could really do with an overhaul.
+ */
 class MainWindow : public QMainWindow {
   Q_OBJECT
 
diff --git a/passworddialog.h b/passworddialog.h
index 3aedf1e2..292f4ddb 100644
--- a/passworddialog.h
+++ b/passworddialog.h
@@ -8,6 +8,12 @@ namespace Ui {
 class PasswordDialog;
 }
 
+/*!
+    \class PasswordDialog
+    \brief PasswordDialog Handles the inserting and editing of passwords.
+
+    Includes templated views.
+ */
 class PasswordDialog : public QDialog {
   Q_OBJECT
 
diff --git a/singleapplication.h b/singleapplication.h
index bfe212ce..ea7b4cf6 100644
--- a/singleapplication.h
+++ b/singleapplication.h
@@ -5,6 +5,12 @@
 #include <QLocalServer>
 #include <QSharedMemory>
 
+/*!
+    \class SingleApplication
+    \brief The SingleApplication class is used for commandline intergration.
+
+    This class needs a bit of work or possibly replacement.
+ */
 class SingleApplication : public QApplication {
   Q_OBJECT
 public:
diff --git a/storemodel.h b/storemodel.h
index 11304db2..7407a216 100644
--- a/storemodel.h
+++ b/storemodel.h
@@ -5,6 +5,10 @@
 #include <QRegExp>
 #include <QSortFilterProxyModel>
 
+/*!
+    \class StoreModel
+    \brief The QSortFilterProxyModel for handling filesystem searches.
+ */
 class StoreModel : public QSortFilterProxyModel {
   Q_OBJECT
 private:
diff --git a/trayicon.h b/trayicon.h
index ae2286d8..29923661 100644
--- a/trayicon.h
+++ b/trayicon.h
@@ -8,6 +8,10 @@
 #include <QSystemTrayIcon>
 #include <QWidget>
 
+/*!
+    \class TrayIcon
+    \brief Handles the systemtray icon and menu.
+ */
 class TrayIcon : public QWidget {
   Q_OBJECT
 
diff --git a/usersdialog.h b/usersdialog.h
index adb23854..37b5af08 100644
--- a/usersdialog.h
+++ b/usersdialog.h
@@ -25,6 +25,13 @@ struct UserInfo {
   QDateTime created;
 };
 
+
+/*!
+    \class UsersDialog
+    \brief Handles listing and editing of GPG users.
+
+    Selection of whom to encrypt to.
+ */
 class UsersDialog : public QDialog {
   Q_OBJECT
 
diff --git a/util.h b/util.h
index 60d03852..3ec0f2a9 100644
--- a/util.h
+++ b/util.h
@@ -4,6 +4,10 @@
 #include <QProcessEnvironment>
 #include <QString>
 
+/*!
+    \class Util
+    \brief Some static utilities to be used elsewhere.
+ */
 class Util {
 public:
   static QString findBinaryInPath(QString binary);