Verbessere die Dokumentation der Crypt/ Klassen

1 files changed, 9 insertions, 8 deletions

diff --git a/crypt/cryptexception.h b/crypt/cryptexception.h
index 513fb8d..0a4edae 100644
--- a/crypt/cryptexception.h
+++ b/crypt/cryptexception.h
@@ -5,11 +5,15 @@
 
 #include <QString>
 
+/**
+ * @brief Eine Klasse für Fehler in Verschlüsselungsklassen.
+ */
 class CryptException : public std::exception
 {
 public:
     /**
-     * @brief The ReturnCode enum
+     * @brief Die Fehler und ihre Codes,
+     * die diese Klasse wirft.
      */
     enum ReturnCode
     {
@@ -25,28 +29,25 @@ public:
     };
 
     /**
-     * @brief CryptException
-     * Erzeugt eine Exception mit den angegebenen Werten.
+     * @brief Erzeugt eine Exception mit den angegebenen Werten.
      * @param what Die Fehlermeldung, die dem Nutzer gezeigt wird.
      * @param returnCode Der Rückgabewert für die Konsole.
      */
     CryptException(std::string what, ReturnCode returnCode);
 
     /**
-     * @brief ~CryptException
+     * @brief Räumt die Exception ab.
      */
     virtual ~CryptException() throw();
 
     /**
-     * @brief what
-     * Gibt die Fehlermelung für den Nutzer zurück.
+     * @brief Gibt die Fehlermelung für den Nutzer zurück.
      * @return Die Fehlermeldung für den Nutzer.
      */
     virtual const char *what() const throw();
 
     /**
-     * @brief returnCode
-     * Gibt den Konsolenrückgabewert zurück.
+     * @brief Gibt den Konsolenrückgabewert zurück.
      * @return Der Rückgabewert für die Konsole.
      */
     ReturnCode returnCode() const;