From e57512ae1f15410d469bcaaf5aea8165ccce38a9 Mon Sep 17 00:00:00 2001 From: Richard Russon Date: Sun, 2 Dec 2018 00:16:20 +0000 Subject: [PATCH] doxy: document enums --- compose.c | 16 +++++++------- config/magic.h | 22 +++++++++---------- config/quad.h | 10 ++++----- config/set.h | 10 ++++----- conn/socket.h | 6 +++--- email/mime.h | 2 +- email/url.h | 24 ++++++++++----------- enter.c | 4 ++-- format_flags.h | 18 ++++++++-------- hdrline.c | 22 +++++++++---------- imap/imap_private.h | 45 +++++++++++++++++++-------------------- init.h | 8 +++---- mutt/file.h | 6 +++--- mutt/logging.h | 18 ++++++++-------- mutt/string2.h | 7 ++++-- mutt_account.h | 10 ++++----- mx.h | 8 +++---- ncrypt/crypt_gpgme.c | 28 ++++++++++++------------ ncrypt/pgpkey.h | 4 ++-- ncrypt/pgppacket.h | 34 ++++++++++++++--------------- notmuch/notmuch_private.h | 4 ++-- pattern.c | 6 +++--- sidebar.c | 6 +++--- 23 files changed, 160 insertions(+), 158 deletions(-) diff --git a/compose.c b/compose.c index 020df6658..3f5714201 100644 --- 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 87fcc59a0..a3166004f 100644 --- 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 44836af2b..efe04fe9e 100644 --- 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 766621e48..9e3464821 100644 --- 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 9f10fd2e6..706070073 100644 --- 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 052a61ff2..948a9dfbf 100644 --- 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 a716d131a..40d122ddb 100644 --- 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 813966f32..fad47a1e2 100644 --- 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 35213f3b2..a0e398984 100644 --- 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 123e31de2..3456372d6 100644 --- 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 0666eb3c7..bcebcc5e2 100644 --- 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 bdbd51ef9..bc28b95be 100644 --- 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 5f12c5d55..02d09b976 100644 --- 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 7e310d713..148ba0912 100644 --- 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 b388ac001..4a9380e2d 100644 --- 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 c54907fa0..51b680e98 100644 --- 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 1a2361dde..ecc7258c8 100644 --- 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 5f91fe121..b4a045b87 100644 --- 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 bd10bb4e5..774974268 100644 --- 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 223370c21..9d30a138f 100644 --- 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 b3af205d3..565873bc0 100644 --- 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 16a48a4eb..61ee69a8e 100644 --- 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 ccf64b908..ba4e3b22f 100644 --- 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 }; /** -- 2.40.0