From ea33815131558a38bce555c45948f4327ee2d3a7 Mon Sep 17 00:00:00 2001
From: Stefan Suhren <suhren.stefan@fh-swf.de>
Date: Mon, 5 Oct 2015 18:02:33 +0200
Subject: Verbessere Domumentation

---
 mainwindow.h | 51 ++++++++++++++++++++++++++++++---------------------
 1 file changed, 30 insertions(+), 21 deletions(-)

(limited to 'mainwindow.h')

diff --git a/mainwindow.h b/mainwindow.h
index 990f128..5fd2a63 100644
--- a/mainwindow.h
+++ b/mainwindow.h
@@ -19,9 +19,10 @@ namespace Ui {
 class MainWindow;
 }
 /**
- * @brief Öffnet eine Datei und zeigt sie wen möglich an.
- * Erzeugen, Importieren und Exportiern Schlüssel.
- * Ver- und Entschlüsselt Datein.
+ * @brief Das Hauptfenster der Application.
+ * Es ist für die Interaktion mit HybridCrypt zuständig,
+ * deswegen ist es für das Erzeugen, Im- und Exportieren von Schlüsseln da.
+ * Darüber hinaus ist es der Einstiegspunkt für die Ver- und Entschlüsselungs Dialoge.
  */
 class MainWindow : public QMainWindow
 {
@@ -29,71 +30,79 @@ class MainWindow : public QMainWindow
 
 public:
     /**
-     * @brief Ist der Konstrucktor der eine Objekt der Klasse erzeugt.
-     * @param parent ist der Zeiger auf das Elter Fenster.
+     * @brief Ist der Konstruktor der eine Objekt der Klasse erzeugt.
+     * @param parent ist der Zeiger auf das Elternfenster.
      */
     explicit MainWindow(QWidget *parent = 0);
     ~MainWindow();
 
 private slots:
     /**
-     * @brief Entschlüsselt die Datei.
-     * öfnet PublicKeyImportDialog
-     * und Speichert Entschlüsselt Datei ap.
+     * @brief Öffnet DecryptDataDialog
+     * und entschlüsselt die ausgewählte Datei.
      */
     void on_pushButtonDecrypt_clicked();
+
     /**
-     * @brief Verschlüsselt eine Datei.
-     * öffnet DateiDialog für Verschlüsselte Datei.
-     * Speichert Entschlüsselte Datei ab.
+     * @brief Öffnet PublicKeyImportDialog
+     * und entschlüsselte die ausgewählte Datei.
      */
     void on_pushButtonEncrypt_clicked();
+
     /**
      * @brief Öffnet einen Dateidialog
-     * für eine Klartext Datei.
+     * zur Auswahl einer Klartextdatei.
      * Schreibt Dateipfad in lineEditFilePath(ChangeEvent).
      */
     void on_pushButtonOpenFile_clicked();
+
     /**
      * @brief Beendet die Anwendung.
      */
     void on_actionClose_triggered();
+
     /**
      * @brief Erzeugt ein neus Schlüsselpaar.
      * Schlüssel werden nur im Progamm gespeichert.
      */
     void on_actionCreateKeypair_triggered();
+
     /**
-     * @brief Improtier ein Schlüsselpaar aus einer Datei.
+     * @brief Importiert ein Schlüsselpaar aus einer Datei.
      */
     void on_actionImport_triggered();
+
     /**
-     * @brief Exportirt das im Programm vorhanden Schlüsselpaar.
+     * @brief Exportiert Schlüsselpaar des Nutzers.
      */
     void on_actionExportMyKeypair_triggered();
+
     /**
-     * @brief Exportirt den im Programm vorhandenen Öffentlichenschlüssel.
+     * @brief Exportiert den öffentlichen Schlüssel des Nutzers.
      */
     void on_actionExportMyPublicKey_triggered();
+
     /**
-     * @brief Setzt den text in aus der Datei in textEditPreview.
-     * Datei wir nur angezeigt wen sie auf .txt oder .log ändert.
-     * @param text der Text der in lineEditFilePath enthalten ist.
+     * @brief Setzt den Text aus der Datei in das textEditPreview,
+     * falls die Datei auf .txt oder .log endet.
+     * @param text Der Dateipfad der ausgewählten Datei.
      */
     void on_lineEditFilePath_textChanged(const QString &text);
 
 private:
 
     /**
-     * @brief Zeit in Sekunden die, die Nachrichten in der Statusbar angezeigt werden.
+     * @brief Timeout für die Nachricht in der StatusBar.
      */
     static const int messageTimeout = 5000;
+
     /**
-     * @brief Schnittstelle für Schlüssel haltung und Ver- und Entschlüsselung.
+     * @brief Stellt Funktionalität bereit.
      */
     HybridCrypt hybridcrypt;
+
     /**
-     * @brief Die Grafischen Oberfläche.
+     * @brief Die grafische Oberfläche.
      */
     Ui::MainWindow *ui;
 
-- 
cgit v1.2.3-70-g09d2