summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--mainwindow.h51
-rw-r--r--passworddialog.h5
-rw-r--r--publickeyimportdialog.h7
3 files changed, 35 insertions, 28 deletions
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;
diff --git a/passworddialog.h b/passworddialog.h
index 0b291db..cf8088b 100644
--- a/passworddialog.h
+++ b/passworddialog.h
@@ -36,9 +36,8 @@ public:
private slots:
/**
- * @brief Setz das Passwortfeld zurück, wenn der Zurücksetzen Butten gedrückt wurde.
- * @param button
- * Der Gedrückt Button.
+ * @brief Setzt das Passwortfeld zurück, wenn der Zurücksetzen Butten gedrückt wurde.
+ * @param button Der Gedrückt Button.
*/
void on_buttonBox_clicked(QAbstractButton *button);
diff --git a/publickeyimportdialog.h b/publickeyimportdialog.h
index 7386596..ea0503b 100644
--- a/publickeyimportdialog.h
+++ b/publickeyimportdialog.h
@@ -21,8 +21,7 @@ class PublicKeyImportDialog : public QDialog
public:
/**
- * @brief Erstellt das Objekt für das UserInterface
- * und für den eigenen Schlüssel und füllt ihn mit Daten.
+ * @brief Erstellt das Objekt für das UserInterface.
* @param parent Das Elternfenster dieses Objektes.
*/
explicit PublicKeyImportDialog(QWidget *parent = 0);
@@ -35,8 +34,8 @@ public:
QVector<QString> getPublicKeyFileList() const;
/**
- * @brief Gibt den Filenamen zurück.
- * @return Den Filename in den die Datei geschreiben werden soll.
+ * @brief Gibt den Dateinamen zurück.
+ * @return Der Dateiname in den die Datei geschreiben werden soll.
*/
QString getOutFileName() const;