summaryrefslogtreecommitdiffstats
path: root/usersdialog.h
diff options
context:
space:
mode:
authorAnne Jan Brouwer <brouwer@annejan.com>2016-10-18 15:20:58 +0200
committerAnne Jan Brouwer <brouwer@annejan.com>2016-10-18 15:20:58 +0200
commit29385ceb731ce943699904d1c6a3c419f0a24c47 (patch)
treec17ac7e6c83b83e01fbeed2a5cc5a09cca412071 /usersdialog.h
parentff4b585f3595509aa0e1ad450af7c524747ffc1a (diff)
Missing documentation
Diffstat (limited to 'usersdialog.h')
-rw-r--r--usersdialog.h36
1 files changed, 34 insertions, 2 deletions
diff --git a/usersdialog.h b/usersdialog.h
index b1f042b2..521bc935 100644
--- a/usersdialog.h
+++ b/usersdialog.h
@@ -20,18 +20,50 @@ class QListWidgetItem;
struct UserInfo {
UserInfo() : validity('-'), have_secret(false), enabled(false) {}
- // see
- // http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob_plain;f=doc/DETAILS
+ /**
+ * @brief UserInfo::fullyValid when validity is f or u.
+ * http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob_plain;f=doc/DETAILS
+ */
bool fullyValid() { return validity == 'f' || validity == 'u'; }
+ /**
+ * @brief UserInfo::marginallyValid when validity is m.
+ * http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob_plain;f=doc/DETAILS
+ */
bool marginallyValid() { return validity == 'm'; }
+ /**
+ * @brief UserInfo::isValid when fullyValid or marginallyValid.
+ */
bool isValid() { return fullyValid() || marginallyValid(); }
+ /**
+ * @brief UserInfo::name full name
+ */
QString name;
+ /**
+ * @brief UserInfo::key_id hexadecimal representation
+ */
QString key_id;
+ /**
+ * @brief UserInfo::validity GnuPG representation of validity
+ * http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob_plain;f=doc/DETAILS
+ */
char validity;
+ /**
+ * @brief UserInfo::have_secret secret key is available
+ * (can decrypt with this key)
+ */
bool have_secret;
+ /**
+ * @brief UserInfo::enabled
+ */
bool enabled;
+ /**
+ * @brief UserInfo::expiry date/time key expires
+ */
QDateTime expiry;
+ /**
+ * @brief UserInfo::created date/time key was created
+ */
QDateTime created;
};