From af836ad58808a1f6437a8b9a76b670c07c9a1212 Mon Sep 17 00:00:00 2001
From: "Wladimir J. van der Laan" <laanwj@gmail.com>
Date: Sun, 13 Nov 2011 13:19:52 +0100
Subject: Improve documentation for UI classes

---
 src/qt/askpassphrasedialog.h | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

(limited to 'src/qt/askpassphrasedialog.h')

diff --git a/src/qt/askpassphrasedialog.h b/src/qt/askpassphrasedialog.h
index 761612cbfd..32a3f6a5f3 100644
--- a/src/qt/askpassphrasedialog.h
+++ b/src/qt/askpassphrasedialog.h
@@ -9,16 +9,18 @@ namespace Ui {
 
 class WalletModel;
 
+/** Multifunctional dialog to ask for passphrases. Used for encryption, unlocking, and changing the passphrase.
+ */
 class AskPassphraseDialog : public QDialog
 {
     Q_OBJECT
 
 public:
     enum Mode {
-        Encrypt,    // Ask passphrase x2
-        Unlock,     // Ask passphrase
-        ChangePass, // Ask old passphrase + new passphrase x2
-        Decrypt   // Ask passphrase
+        Encrypt,    /**< Ask passphrase twice and encrypt */
+        Unlock,     /**< Ask passphrase and unlock */
+        ChangePass, /**< Ask old passphrase + new passphrase twice */
+        Decrypt     /**< Ask passphrase and decrypt wallet */
     };
 
     explicit AskPassphraseDialog(Mode mode, QWidget *parent = 0);
-- 
cgit v1.2.3