doxy: document enums

diff --git a/compose.c b/compose.c
index 020df6658d192ae5ada25bcd9909f3b8fba9fa26..3f5714201dabc061713243c770f686003437a798 100644 (file)
--- a/compose.c
+++ b/compose.c
@@ -99,13 +99,13 @@ static const char *There_are_no_attachments = N_("There are no attachments");
  */
 enum HeaderField
 {
-  HDR_FROM = 0,
-  HDR_TO,
-  HDR_CC,
-  HDR_BCC,
-  HDR_SUBJECT,
-  HDR_REPLYTO,
-  HDR_FCC,
+  HDR_FROM = 0, ///< Position for From: field
+  HDR_TO,       ///< Position for To: field
+  HDR_CC,       ///< Position for Cc: field
+  HDR_BCC,      ///< Position for Bcc: field
+  HDR_SUBJECT,  ///< Position for Subject: field
+  HDR_REPLYTO,  ///< Position for Reply-To: field
+  HDR_FCC,      ///< Position for Fcc: (save folder) field
 
 #ifdef MIXMASTER
   HDR_MIX,
@@ -120,7 +120,7 @@ enum HeaderField
   HDR_XCOMMENTTO,
 #endif
 
-  HDR_ATTACH = (HDR_FCC + 5) /* where to start printing the attachments */
+  HDR_ATTACH = (HDR_FCC + 5), ///< position to start printing the attachments
 };
 
 int HeaderPadding[HDR_XCOMMENTTO + 1] = { 0 };

diff --git a/config/magic.h b/config/magic.h
index 87fcc59a07d162bf65218016b3ab8d15ed626e65..a3166004fbecd1703cc63023d0781c1f9bc3ee9a 100644 (file)
--- a/config/magic.h
+++ b/config/magic.h
@@ -32,17 +32,17 @@ extern const char *magic_values[];
  */
 enum MailboxType
 {
-  MUTT_MAILBOX_ERROR = -1,
-  MUTT_UNKNOWN = 0,
-  MUTT_MBOX,
-  MUTT_MMDF,
-  MUTT_MH,
-  MUTT_MAILDIR,
-  MUTT_NNTP,
-  MUTT_IMAP,
-  MUTT_NOTMUCH,
-  MUTT_POP,
-  MUTT_COMPRESSED,
+  MUTT_MAILBOX_ERROR = -1, ///< Error occurred examining mailbox
+  MUTT_UNKNOWN = 0,        ///< Mailbox wasn't recognised
+  MUTT_MBOX,               ///< 'mbox' Mailbox type
+  MUTT_MMDF,               ///< 'mmdf' Mailbox type
+  MUTT_MH,                 ///< 'MH' Mailbox type
+  MUTT_MAILDIR,            ///< 'Maildir' Mailbox type
+  MUTT_NNTP,               ///< 'NNTP' (Usenet) Mailbox type
+  MUTT_IMAP,               ///< 'IMAP' Mailbox type
+  MUTT_NOTMUCH,            ///< 'Notmuch' (virtual) Mailbox type
+  MUTT_POP,                ///< 'POP3' Mailbox type
+  MUTT_COMPRESSED,         ///< Compressed file Mailbox type
 };
 
 void magic_init(struct ConfigSet *cs);

diff --git a/config/quad.h b/config/quad.h
index 44836af2b28e2e22724d0b9b619a9bd8142d95af..efe04fe9e60b0f44076dd8d3a37e6c15e587d1bc 100644 (file)
--- a/config/quad.h
+++ b/config/quad.h
@@ -34,11 +34,11 @@ extern const char *quad_values[];
  */
 enum QuadOption
 {
-  MUTT_ABORT = -1,
-  MUTT_NO,
-  MUTT_YES,
-  MUTT_ASKNO,
-  MUTT_ASKYES
+  MUTT_ABORT = -1, ///< User aborted the question (with Ctrl-G)
+  MUTT_NO,         ///< User answered 'No', or assume 'No'
+  MUTT_YES,        ///< User answered 'Yes', or assume 'Yes'
+  MUTT_ASKNO,      ///< Ask the user, defaulting to 'No'
+  MUTT_ASKYES,     ///< Ask the user, defaulting to 'Yes'
 };
 
 void quad_init(struct ConfigSet *cs);

diff --git a/config/set.h b/config/set.h
index 766621e4841f51bbdf0be2ade2cfd8611e42f3c3..9e34648210680d7f093403b313874d5acea03f7a 100644 (file)
--- a/config/set.h
+++ b/config/set.h
@@ -36,9 +36,9 @@ struct ConfigDef;
  */
 enum ConfigEvent
 {
-  CE_SET = 1,   /**< Config item has been set */
-  CE_RESET, /**< Config item has been reset to initial, or parent, value */
-  CE_INITIAL_SET, /**< Config item's initial value has been set */
+  CE_SET = 1,     ///< Config item has been set
+  CE_RESET,       ///< Config item has been reset to initial, or parent, value
+  CE_INITIAL_SET, ///< Config item's initial value has been set
 };
 
 /* Config Set Results */
@@ -65,8 +65,8 @@ enum ConfigEvent
  */
 enum CsListenerAction
 {
-  CSLA_CONTINUE = 1, /**< Continue notifying listeners */
-  CSLA_STOP,         /**< Stop notifying listeners */
+  CSLA_CONTINUE = 1, ///< Continue notifying listeners
+  CSLA_STOP,         ///< Stop notifying listeners
 };
 
 /**

diff --git a/conn/socket.h b/conn/socket.h
index 9f10fd2e69760a15b9051a725733ae3d1f93ee61..7060700739acd9e11df9040f1a3916ce54a48bf5 100644 (file)
--- a/conn/socket.h
+++ b/conn/socket.h
@@ -34,9 +34,9 @@
  */
 enum ConnectionType
 {
-  MUTT_CONNECTION_SIMPLE,
-  MUTT_CONNECTION_TUNNEL,
-  MUTT_CONNECTION_SSL,
+  MUTT_CONNECTION_SIMPLE, ///< Simple TCP socket connection
+  MUTT_CONNECTION_TUNNEL, ///< Tunnelled connection
+  MUTT_CONNECTION_SSL,    ///< SSL/TLS-encrypted connection
 };
 
 struct Connection;

diff --git a/email/mime.h b/email/mime.h
index 052a61ff2e49da2491c64ee9994ee7a4303c3287..948a9dfbf2a4327f81020e8bd5b11b64dac940e2 100644 (file)
--- a/email/mime.h
+++ b/email/mime.h
@@ -62,7 +62,7 @@ enum ContentDisposition
   DISP_INLINE,
   DISP_ATTACH,
   DISP_FORM_DATA,
-  DISP_NONE /* no preferred disposition */
+  DISP_NONE, ///< No preferred disposition
 };
 
 /* MIME encoding/decoding global vars */

diff --git a/email/url.h b/email/url.h
index a716d131ae7588ba984b95439c69e95ddf330ad5..40d122ddb28ec51b102df07ee8d2ab7a29012999 100644 (file)
--- a/email/url.h
+++ b/email/url.h
@@ -31,18 +31,18 @@
  */
 enum UrlScheme
 {
-  U_UNKNOWN,
-  U_FILE,
-  U_POP,
-  U_POPS,
-  U_IMAP,
-  U_IMAPS,
-  U_NNTP,
-  U_NNTPS,
-  U_SMTP,
-  U_SMTPS,
-  U_MAILTO,
-  U_NOTMUCH,
+  U_UNKNOWN, ///< Url wasn't recognised
+  U_FILE,    ///< Url is file://
+  U_POP,     ///< Url is pop://
+  U_POPS,    ///< Url is pops://
+  U_IMAP,    ///< Url is imap://
+  U_IMAPS,   ///< Url is imaps://
+  U_NNTP,    ///< Url is nntp://
+  U_NNTPS,   ///< Url is nntps://
+  U_SMTP,    ///< Url is smtp://
+  U_SMTPS,   ///< Url is smtps://
+  U_MAILTO,  ///< Url is mailto://
+  U_NOTMUCH, ///< Url is notmuch://
 };
 
 #define U_PATH          (1 << 1)

diff --git a/enter.c b/enter.c
index 813966f32a4b64f2f2cca14485151f1668a4920a..fad47a1e293cb90eef54f9e437bc5372e1762428 100644 (file)
--- a/enter.c
+++ b/enter.c
@@ -55,8 +55,8 @@
  */
 enum RedrawFlags
 {
-  MUTT_REDRAW_INIT = 1, /**< go to end of line and redraw */
-  MUTT_REDRAW_LINE      /**< redraw entire line */
+  MUTT_REDRAW_INIT = 1, ///< go to end of line and redraw
+  MUTT_REDRAW_LINE,     ///< redraw entire line
 };
 
 /* combining mark / non-spacing character */

diff --git a/format_flags.h b/format_flags.h
index 35213f3b2fc0642c5dcaec1427c332eb12dc817e..a0e398984ab3a7c1de6bc2274982c6f0b872e2e4 100644 (file)
--- a/format_flags.h
+++ b/format_flags.h
@@ -30,15 +30,15 @@
  */
 enum FormatFlag
 {
-  MUTT_FORMAT_FORCESUBJ   = (1 << 0), /**< print the subject even if unchanged */
-  MUTT_FORMAT_TREE        = (1 << 1), /**< draw the thread tree */
-  MUTT_FORMAT_MAKEPRINT   = (1 << 2), /**< make sure that all chars are printable */
-  MUTT_FORMAT_OPTIONAL    = (1 << 3), /**< allow optional field processing */
-  MUTT_FORMAT_STAT_FILE   = (1 << 4), /**< used by attach_format_str */
-  MUTT_FORMAT_ARROWCURSOR = (1 << 5), /**< reserve space for arrow_cursor */
-  MUTT_FORMAT_INDEX       = (1 << 6), /**< this is a main index entry */
-  MUTT_FORMAT_NOFILTER    = (1 << 7), /**< do not allow filtering on this pass */
-  MUTT_FORMAT_PLAIN       = (1 << 8), /**< do not prepend DISP_TO, DISP_CC ... */
+  MUTT_FORMAT_FORCESUBJ   = (1 << 0), ///< print the subject even if unchanged
+  MUTT_FORMAT_TREE        = (1 << 1), ///< draw the thread tree
+  MUTT_FORMAT_MAKEPRINT   = (1 << 2), ///< make sure that all chars are printable
+  MUTT_FORMAT_OPTIONAL    = (1 << 3), ///< allow optional field processing
+  MUTT_FORMAT_STAT_FILE   = (1 << 4), ///< used by attach_format_str
+  MUTT_FORMAT_ARROWCURSOR = (1 << 5), ///< reserve space for arrow_cursor
+  MUTT_FORMAT_INDEX       = (1 << 6), ///< this is a main index entry
+  MUTT_FORMAT_NOFILTER    = (1 << 7), ///< do not allow filtering on this pass
+  MUTT_FORMAT_PLAIN       = (1 << 8), ///< do not prepend DISP_TO, DISP_CC ...
 };
 
 /**

diff --git a/hdrline.c b/hdrline.c
index 123e31de216ae7873575c0d038497d494debfcd9..3456372d6933407ce599afb2b7f713469a936b45 100644 (file)
--- a/hdrline.c
+++ b/hdrline.c
@@ -58,17 +58,17 @@ struct MbTable *ToChars; ///< Config: Indicator characters for the 'To' field in
  */
 enum FlagChars
 {
-  FLAG_CHAR_TAGGED,
-  FLAG_CHAR_IMPORTANT,
-  FLAG_CHAR_DELETED,
-  FLAG_CHAR_DELETED_ATTACH,
-  FLAG_CHAR_REPLIED,
-  FLAG_CHAR_OLD,
-  FLAG_CHAR_NEW,
-  FLAG_CHAR_OLD_THREAD,
-  FLAG_CHAR_NEW_THREAD,
-  FLAG_CHAR_SEMPTY,
-  FLAG_CHAR_ZEMPTY
+  FLAG_CHAR_TAGGED,         ///< Character denoting a tagged email
+  FLAG_CHAR_IMPORTANT,      ///< Character denoting a important (flagged) email
+  FLAG_CHAR_DELETED,        ///< Character denoting a deleted email
+  FLAG_CHAR_DELETED_ATTACH, ///< Character denoting a deleted attachment
+  FLAG_CHAR_REPLIED,        ///< Character denoting an email that has been replied to
+  FLAG_CHAR_OLD,            ///< Character denoting an email that has been read
+  FLAG_CHAR_NEW,            ///< Character denoting an unread email
+  FLAG_CHAR_OLD_THREAD,     ///< Character denoting a thread of emails that has been read
+  FLAG_CHAR_NEW_THREAD,     ///< Character denoting a thread containing at least one new email
+  FLAG_CHAR_SEMPTY,         ///< Character denoting a read email, $index_format %S expando
+  FLAG_CHAR_ZEMPTY,         ///< Character denoting a read email, $index_format %Z expando
 };
 
 /**

diff --git a/imap/imap_private.h b/imap/imap_private.h
index 0666eb3c7d3659b60a9ac3e8615568f8853998ba..bcebcc5e2f690ce93b9eab13ad2d663887743c9d 100644 (file)
--- a/imap/imap_private.h
+++ b/imap/imap_private.h
@@ -82,9 +82,9 @@ struct Progress;
  */
 enum ImapExecResult
 {
-  IMAP_EXEC_SUCCESS = 0, /**< Imap command executed or queued successfully */
-  IMAP_EXEC_ERROR,       /**< Imap command failure */
-  IMAP_EXEC_FATAL        /**< Imap connection failure */
+  IMAP_EXEC_SUCCESS = 0, ///< Imap command executed or queued successfully
+  IMAP_EXEC_ERROR,       ///< Imap command failure
+  IMAP_EXEC_FATAL,       ///< Imap connection failure
 };
 
 /* length of "DD-MMM-YYYY HH:MM:SS +ZZzz" (null-terminated) */
@@ -131,26 +131,25 @@ enum ImapNamespace
  */
 enum ImapCaps
 {
-  IMAP4 = 0,
-  IMAP4REV1,
-  STATUS,
-  ACL,                   /**< RFC2086: IMAP4 ACL extension */
-  NAMESPACE,             /**< RFC2342: IMAP4 Namespace */
-  ACRAM_MD5,             /**< RFC2195: CRAM-MD5 authentication */
-  AGSSAPI,               /**< RFC1731: GSSAPI authentication */
-  AUTH_ANON,             /**< AUTH=ANONYMOUS */
-  AUTH_OAUTHBEARER,      /**< RFC7628: AUTH=OAUTHBEARER */
-  STARTTLS,              /**< RFC2595: STARTTLS */
-  LOGINDISABLED,         /**< RFC2595: LOGINDISABLED */
-  IDLE,                  /**< RFC2177: IDLE */
-  SASL_IR,               /**< SASL initial response draft */
-  ENABLE,                /**< RFC5161 */
-  CONDSTORE,             /**< RFC7162 */
-  QRESYNC,               /**< RFC7162 */
-  X_GM_EXT1,             /**< https://developers.google.com/gmail/imap/imap-extensions */
-  X_GM_ALT1 = X_GM_EXT1, /**< Alternative capability string */
-
-  CAPMAX
+  IMAP4 = 0,             ///< Server supports IMAP4
+  IMAP4REV1,             ///< Server supports IMAP4rev1
+  STATUS,                ///< Server supports STATUS command
+  ACL,                   ///< RFC2086: IMAP4 ACL extension
+  NAMESPACE,             ///< RFC2342: IMAP4 Namespace
+  ACRAM_MD5,             ///< RFC2195: CRAM-MD5 authentication
+  AGSSAPI,               ///< RFC1731: GSSAPI authentication
+  AUTH_ANON,             ///< AUTH=ANONYMOUS
+  AUTH_OAUTHBEARER,      ///< RFC7628: AUTH=OAUTHBEARER
+  STARTTLS,              ///< RFC2595: STARTTLS
+  LOGINDISABLED,         ///< RFC2595: LOGINDISABLED
+  IDLE,                  ///< RFC2177: IDLE
+  SASL_IR,               ///< SASL initial response draft
+  ENABLE,                ///< RFC5161
+  CONDSTORE,             ///< RFC7162
+  QRESYNC,               ///< RFC7162
+  X_GM_EXT1,             ///< https://developers.google.com/gmail/imap/imap-extensions
+  X_GM_ALT1 = X_GM_EXT1, ///< Alternative capability string
+  CAPMAX,
 };
 
 /**

diff --git a/init.h b/init.h
index bdbd51ef91b3155404674360e62bde40e8e8367e..bc28b95be0f6a363fa7e66b8bb2329a9826ae241 100644 (file)
--- a/init.h
+++ b/init.h
@@ -97,10 +97,10 @@
  */
 enum MuttSetCommand
 {
-  MUTT_SET_SET,   /**< default is to set all vars */
-  MUTT_SET_INV,   /**< default is to invert all vars */
-  MUTT_SET_UNSET, /**< default is to unset all vars */
-  MUTT_SET_RESET, /**< default is to reset all vars to default */
+  MUTT_SET_SET,   ///< default is to set all vars
+  MUTT_SET_INV,   ///< default is to invert all vars
+  MUTT_SET_UNSET, ///< default is to unset all vars
+  MUTT_SET_RESET, ///< default is to reset all vars to default
 };
 
 #define UL (unsigned long)

diff --git a/mutt/file.h b/mutt/file.h
index 5f12c5d556e7a18d528fb25575a26f9cbbc65e90..02d09b97679d988483816ee3a9d9fef697716cdb 100644 (file)
--- a/mutt/file.h
+++ b/mutt/file.h
@@ -54,9 +54,9 @@ struct timespec
  */
 enum MuttStatType
 {
-  MUTT_STAT_ATIME,
-  MUTT_STAT_MTIME,
-  MUTT_STAT_CTIME
+  MUTT_STAT_ATIME, ///< File/dir's atime - last accessed time
+  MUTT_STAT_MTIME, ///< File/dir's mtime - last modified time
+  MUTT_STAT_CTIME, ///< File/dir's ctime - creation time
 };
 
 /**

diff --git a/mutt/logging.h b/mutt/logging.h
index 7e310d71333d4e58156357e2122f6cc07da385e7..148ba09123d8ee3d4663987e85437dcadeca2ef7 100644 (file)
--- a/mutt/logging.h
+++ b/mutt/logging.h
@@ -49,15 +49,15 @@ extern log_dispatcher_t MuttLogger;
  */
 enum LogLevel
 {
-  LL_PERROR  = -3,
-  LL_ERROR   = -2,
-  LL_WARNING = -1,
-  LL_MESSAGE =  0,
-  LL_DEBUG1  =  1,
-  LL_DEBUG2  =  2,
-  LL_DEBUG3  =  3,
-  LL_DEBUG4  =  4,
-  LL_DEBUG5  =  5,
+  LL_PERROR  = -3, ///< Log perror (using errno)
+  LL_ERROR   = -2, ///< Log error
+  LL_WARNING = -1, ///< Log warning
+  LL_MESSAGE =  0, ///< Log informational message
+  LL_DEBUG1  =  1, ///< Log at debug level 1
+  LL_DEBUG2  =  2, ///< Log at debug level 2
+  LL_DEBUG3  =  3, ///< Log at debug level 3
+  LL_DEBUG4  =  4, ///< Log at debug level 4
+  LL_DEBUG5  =  5, ///< Log at debug level 5
 };
 
 /**

diff --git a/mutt/string2.h b/mutt/string2.h
index b388ac001a41c528a0d3b2a78dabbdc75e15b6e5..4a9380e2de833440b4d0fe9ba5f556c3a9b56f70 100644 (file)
--- a/mutt/string2.h
+++ b/mutt/string2.h
@@ -61,10 +61,13 @@
 
 #define terminate_buffer(a, b) terminate_string(a, b, sizeof(a) - 1)
 
+/**
+ * CaseSensitivity - Should a string's case matter when matching?
+ */
 enum CaseSensitivity
 {
-  CASE_MATCH,
-  CASE_IGNORE
+  CASE_MATCH,  ///< Match case when comparing strings
+  CASE_IGNORE, ///< Ignore case when comparing strings
 };
 
 void        mutt_str_adjust(char **p);

diff --git a/mutt_account.h b/mutt_account.h
index c54907fa08d3ee6f9fc98049d8a3d5d21005a979..51b680e9853be03dd337af7a7405d23e41834a00 100644 (file)
--- a/mutt_account.h
+++ b/mutt_account.h
@@ -45,11 +45,11 @@ extern char *SmtpPass;
  */
 enum AccountType
 {
-  MUTT_ACCT_TYPE_NONE = 0,
-  MUTT_ACCT_TYPE_IMAP,
-  MUTT_ACCT_TYPE_POP,
-  MUTT_ACCT_TYPE_SMTP,
-  MUTT_ACCT_TYPE_NNTP
+  MUTT_ACCT_TYPE_NONE = 0, ///< Account type is unknown
+  MUTT_ACCT_TYPE_IMAP,     ///< Imap Account
+  MUTT_ACCT_TYPE_POP,      ///< Pop Account
+  MUTT_ACCT_TYPE_SMTP,     ///< Smtp Account
+  MUTT_ACCT_TYPE_NNTP,     ///< Nntp (Usenet) Account
 };
 
 /* account flags */

diff --git a/mx.h b/mx.h
index 1a2361dde4c39a9d2848079354d277aa994c1d95..ecc7258c8d2587b59c615ac43866aeb362e32132 100644 (file)
--- a/mx.h
+++ b/mx.h
@@ -66,10 +66,10 @@ extern char *        Trash;
  */
 enum MxCheckReturns
 {
-  MUTT_NEW_MAIL = 1, /**< new mail received in mailbox */
-  MUTT_LOCKED,       /**< couldn't lock the mailbox */
-  MUTT_REOPENED,     /**< mailbox was reopened */
-  MUTT_FLAGS         /**< nondestructive flags change (IMAP) */
+  MUTT_NEW_MAIL = 1, ///< new mail received in mailbox
+  MUTT_LOCKED,       ///< couldn't lock the mailbox
+  MUTT_REOPENED,     ///< mailbox was reopened
+  MUTT_FLAGS,        ///< nondestructive flags change (IMAP)
 };
 
 /**

diff --git a/ncrypt/crypt_gpgme.c b/ncrypt/crypt_gpgme.c
index 5f91fe1215576c7dce826e5765c2a55ee064d2d4..b4a045b87c3e90e0d6bc3ac5564299d04553ef99 100644 (file)
--- a/ncrypt/crypt_gpgme.c
+++ b/ncrypt/crypt_gpgme.c
@@ -3615,9 +3615,9 @@ static void parse_and_print_user_id(FILE *fp, const char *userid)
  */
 enum KeyCap
 {
-  KEY_CAP_CAN_ENCRYPT,
-  KEY_CAP_CAN_SIGN,
-  KEY_CAP_CAN_CERTIFY
+  KEY_CAP_CAN_ENCRYPT, ///< Key can be used for encryption
+  KEY_CAP_CAN_SIGN,    ///< Key can be used for signing
+  KEY_CAP_CAN_CERTIFY, ///< Key can be used to certify
 };
 
 /**
@@ -3679,17 +3679,17 @@ static unsigned int key_check_cap(gpgme_key_t key, enum KeyCap cap)
  */
 enum KeyInfo
 {
-  KIP_NAME = 0,
-  KIP_AKA,
-  KIP_VALID_FROM,
-  KIP_VALID_TO,
-  KIP_KEY_TYPE,
-  KIP_KEY_USAGE,
-  KIP_FINGERPRINT,
-  KIP_SERIAL_NO,
-  KIP_ISSUED_BY,
-  KIP_SUBKEY,
-  KIP_END
+  KIP_NAME = 0,       ///< PGP Key field: Name
+  KIP_AKA,            ///< PGP Key field: aka (Also Known As)
+  KIP_VALID_FROM,     ///< PGP Key field: Valid From date
+  KIP_VALID_TO,       ///< PGP Key field: Valid To date
+  KIP_KEY_TYPE,       ///< PGP Key field: Key Type
+  KIP_KEY_USAGE,      ///< PGP Key field: Key Usage
+  KIP_FINGERPRINT,    ///< PGP Key field: Fingerprint
+  KIP_SERIAL_NO,      ///< PGP Key field: Serial number
+  KIP_ISSUED_BY,      ///< PGP Key field: Issued By
+  KIP_SUBKEY,         ///< PGP Key field: Subkey
+  KIP_END,
 };
 
 static const char *const KeyInfoPrompts[] = {

diff --git a/ncrypt/pgpkey.h b/ncrypt/pgpkey.h
index bd10bb4e5b286d2496c78fe80fd1a6b48c34683c..774974268d8313f93ca5a419e1ebae823749e41f 100644 (file)
--- a/ncrypt/pgpkey.h
+++ b/ncrypt/pgpkey.h
@@ -32,8 +32,8 @@ struct Address;
  */
 enum PgpRing
 {
-  PGP_PUBRING, /**< Public keys */
-  PGP_SECRING, /**< Secret keys */
+  PGP_PUBRING, ///< Public keys
+  PGP_SECRING, ///< Secret keys
 };
 
 struct Body *pgp_class_make_key_attachment(void);

diff --git a/ncrypt/pgppacket.h b/ncrypt/pgppacket.h
index 223370c21fe4844298681a6bbdaa3f6d72c4ad43..9d30a138f328e42deec6df8ac3396d9912f24145 100644 (file)
--- a/ncrypt/pgppacket.h
+++ b/ncrypt/pgppacket.h
@@ -34,23 +34,23 @@
  */
 enum PacketTags
 {
-  PT_RES0 = 0,   /**< reserved */
-  PT_ESK,        /**< Encrypted Session Key */
-  PT_SIG,        /**< Signature Packet */
-  PT_CESK,       /**< Conventionally Encrypted Session Key Packet */
-  PT_OPS,        /**< One-Pass Signature Packet */
-  PT_SECKEY,     /**< Secret Key Packet */
-  PT_PUBKEY,     /**< Public Key Packet */
-  PT_SUBSECKEY,  /**< Secret Subkey Packet */
-  PT_COMPRESSED, /**< Compressed Data Packet */
-  PT_SKE,        /**< Symmetrically Encrypted Data Packet */
-  PT_MARKER,     /**< Marker Packet */
-  PT_LITERAL,    /**< Literal Data Packet */
-  PT_TRUST,      /**< Trust Packet */
-  PT_NAME,       /**< Name Packet */
-  PT_SUBKEY,     /**< Subkey Packet */
-  PT_RES15,      /**< Reserved */
-  PT_COMMENT     /**< Comment Packet */
+  PT_RES0 = 0,   ///< reserved
+  PT_ESK,        ///< Encrypted Session Key
+  PT_SIG,        ///< Signature Packet
+  PT_CESK,       ///< Conventionally Encrypted Session Key Packet
+  PT_OPS,        ///< One-Pass Signature Packet
+  PT_SECKEY,     ///< Secret Key Packet
+  PT_PUBKEY,     ///< Public Key Packet
+  PT_SUBSECKEY,  ///< Secret Subkey Packet
+  PT_COMPRESSED, ///< Compressed Data Packet
+  PT_SKE,        ///< Symmetrically Encrypted Data Packet
+  PT_MARKER,     ///< Marker Packet
+  PT_LITERAL,    ///< Literal Data Packet
+  PT_TRUST,      ///< Trust Packet
+  PT_NAME,       ///< Name Packet
+  PT_SUBKEY,     ///< Subkey Packet
+  PT_RES15,      ///< Reserved
+  PT_COMMENT,    ///< Comment Packet
 };
 
 unsigned char *pgp_read_packet(FILE *fp, size_t *len);

diff --git a/notmuch/notmuch_private.h b/notmuch/notmuch_private.h
index b3af205d3cdf9a50853af6a134abfb7bbb62c588..565873bc0b1e7c075fe7d8ff71e7a6c0f0decfc0 100644 (file)
--- a/notmuch/notmuch_private.h
+++ b/notmuch/notmuch_private.h
@@ -59,8 +59,8 @@ struct NmAccountData
  */
 enum NmQueryType
 {
-  NM_QUERY_TYPE_MESGS = 1, /**< Default: Messages only */
-  NM_QUERY_TYPE_THREADS    /**< Whole threads */
+  NM_QUERY_TYPE_MESGS = 1, ///< Default: Messages only
+  NM_QUERY_TYPE_THREADS,   ///< Whole threads
 };
 
 /**

diff --git a/pattern.c b/pattern.c
index 16a48a4ebb2898600f27faa7841679fe9ad44ab6..61ee69a8e10d64b543bd88bded69f0bbb9866e34 100644 (file)
--- a/pattern.c
+++ b/pattern.c
@@ -111,9 +111,9 @@ bool ThoroughSearch; ///< Config: Decode headers and messages before searching t
  */
 enum EatRangeError
 {
-  RANGE_E_OK,
-  RANGE_E_SYNTAX,
-  RANGE_E_CTX,
+  RANGE_E_OK,     ///< Range is valid
+  RANGE_E_SYNTAX, ///< Range contains syntax error
+  RANGE_E_CTX,    ///< Range requires Context, but none available
 };
 
 /**

diff --git a/sidebar.c b/sidebar.c
index ccf64b9081f6f198a39a167c1c0c2c4a4f9da295..ba4e3b22f9e4961c5ef82102187d20608c50f85a 100644 (file)
--- a/sidebar.c
+++ b/sidebar.c
@@ -89,9 +89,9 @@ static int BotIndex = -1; /**< Last mailbox visible in sidebar */
  */
 enum DivType
 {
-  SB_DIV_USER,  /**< User configured using $sidebar_divider_char */
-  SB_DIV_ASCII, /**< An ASCII vertical bar (pipe) */
-  SB_DIV_UTF8   /**< A unicode line-drawing character */
+  SB_DIV_USER,  ///< User configured using $sidebar_divider_char
+  SB_DIV_ASCII, ///< An ASCII vertical bar (pipe)
+  SB_DIV_UTF8,  ///< A unicode line-drawing character
 };
 
 /**