doxy: document enums

diff --git a/email/mime.h b/email/mime.h
index 989842e618acae4d3c58f4eaf4fbc0c530627026..c9eb864f7b0b34b5d7d5aa5eb582e13fb037068e 100644 (file)
--- a/email/mime.h
+++ b/email/mime.h
@@ -45,13 +45,13 @@ enum ContentType
  */
 enum ContentEncoding
 {
-  ENC_OTHER,
-  ENC_7BIT,
-  ENC_8BIT,
-  ENC_QUOTED_PRINTABLE,
-  ENC_BASE64,
-  ENC_BINARY,
-  ENC_UUENCODED
+  ENC_OTHER,            ///< Encoding unknown
+  ENC_7BIT,             ///< 7-bit text
+  ENC_8BIT,             ///< 8-bit text
+  ENC_QUOTED_PRINTABLE, ///< Quoted-printable text
+  ENC_BASE64,           ///< Base-64 encoded text
+  ENC_BINARY,           ///< Binary
+  ENC_UUENCODED,        ///< UUEncoded text
 };
 
 /**
@@ -59,10 +59,10 @@ enum ContentEncoding
  */
 enum ContentDisposition
 {
-  DISP_INLINE,
-  DISP_ATTACH,
-  DISP_FORM_DATA,
-  DISP_NONE, ///< No preferred disposition
+  DISP_INLINE,    ///< Content is inline
+  DISP_ATTACH,    ///< Content is attached
+  DISP_FORM_DATA, ///< Content is form-data
+  DISP_NONE,      ///< No preferred disposition
 };
 
 /* MIME encoding/decoding global vars */

diff --git a/imap/imap_private.h b/imap/imap_private.h
index e291a3b4448c4e06a6ae09bc5ebd623a6c0b5952..bf8512f51acd36326529193db0381a8b39b7af06 100644 (file)
--- a/imap/imap_private.h
+++ b/imap/imap_private.h
@@ -95,8 +95,8 @@ enum ImapExecResult
  */
 enum ImapFlags
 {
-  IMAP_FATAL = 1,
-  IMAP_BYE
+  IMAP_FATAL = 1, ///< Unrecoverable error occurred
+  IMAP_BYE,       ///< Logged out from server
 };
 
 /**
@@ -105,23 +105,13 @@ enum ImapFlags
 enum ImapState
 {
   /* States */
-  IMAP_DISCONNECTED = 0,
-  IMAP_CONNECTED,
-  IMAP_AUTHENTICATED,
-  IMAP_SELECTED,
+  IMAP_DISCONNECTED = 0, ///< Disconnected from server
+  IMAP_CONNECTED,        ///< Connected to server
+  IMAP_AUTHENTICATED,    ///< Connection is authenticated
+  IMAP_SELECTED,         ///< Mailbox is selected
 
   /* and pseudo-states */
-  IMAP_IDLE
-};
-
-/**
- * enum ImapNamespace - IMAP namespace types
- */
-enum ImapNamespace
-{
-  IMAP_NS_PERSONAL = 0,
-  IMAP_NS_OTHER,
-  IMAP_NS_SHARED
+  IMAP_IDLE, ///< Connection is idle
 };
 
 /**

diff --git a/mutt.h b/mutt.h
index 599bd9d1f868b72d1967b2a6348121c80145e89b..b9a6e0099dbdfcfea43b445ac3cf161ea69a2452 100644 (file)
--- a/mutt.h
+++ b/mutt.h
@@ -128,48 +128,48 @@ enum MuttMisc
   MUTT_TRASH,      ///< Trashed messages
 
   /* actions for mutt_pattern_comp/mutt_pattern_exec */
-  MUTT_AND,
-  MUTT_OR,
-  MUTT_THREAD,
-  MUTT_PARENT,
-  MUTT_CHILDREN,
-  MUTT_TO,
-  MUTT_CC,
-  MUTT_COLLAPSED,
-  MUTT_SUBJECT,
-  MUTT_FROM,
-  MUTT_DATE,
-  MUTT_DATE_RECEIVED,
-  MUTT_DUPLICATED,
-  MUTT_UNREFERENCED,
-  MUTT_BROKEN,
-  MUTT_ID,
-  MUTT_BODY,
-  MUTT_HEADER,
-  MUTT_HORMEL,
-  MUTT_WHOLE_MSG,
-  MUTT_SENDER,
-  MUTT_MESSAGE,
-  MUTT_SCORE,
-  MUTT_SIZE,
-  MUTT_REFERENCE,
-  MUTT_RECIPIENT,
-  MUTT_LIST,
-  MUTT_SUBSCRIBED_LIST,
-  MUTT_PERSONAL_RECIP,
-  MUTT_PERSONAL_FROM,
-  MUTT_ADDRESS,
-  MUTT_CRYPT_SIGN,
-  MUTT_CRYPT_VERIFIED,
-  MUTT_CRYPT_ENCRYPT,
-  MUTT_PGP_KEY,
-  MUTT_XLABEL,
-  MUTT_SERVERSEARCH,
-  MUTT_DRIVER_TAGS,
-  MUTT_MIMEATTACH,
-  MUTT_MIMETYPE,
+  MUTT_AND,             ///< Both patterns must match
+  MUTT_OR,              ///< Either pattern can match
+  MUTT_THREAD,          ///< Pattern matches email thread
+  MUTT_PARENT,          ///< Pattern matches parent
+  MUTT_CHILDREN,        ///< Pattern matches a child email
+  MUTT_TO,              ///< Pattern matches 'To:' field
+  MUTT_CC,              ///< Pattern matches 'Cc:' field
+  MUTT_COLLAPSED,       ///< Thread is collapsed
+  MUTT_SUBJECT,         ///< Pattern matches 'Subject:' field
+  MUTT_FROM,            ///< Pattern matches 'From:' field
+  MUTT_DATE,            ///< Pattern matches 'Date:' field
+  MUTT_DATE_RECEIVED,   ///< Pattern matches date received
+  MUTT_DUPLICATED,      ///< Duplicate message
+  MUTT_UNREFERENCED,    ///< Message is unreferenced in the thread
+  MUTT_BROKEN,          ///< Message is part of a broken thread
+  MUTT_ID,              ///< Pattern matches email's Message-Id
+  MUTT_BODY,            ///< Pattern matches email's body
+  MUTT_HEADER,          ///< Pattern matches email's header
+  MUTT_HORMEL,          ///< Pattern matches email's spam score
+  MUTT_WHOLE_MSG,       ///< Pattern matches raw email text
+  MUTT_SENDER,          ///< Pattern matches sender
+  MUTT_MESSAGE,         ///< Pattern matches message number
+  MUTT_SCORE,           ///< Pattern matches email's score
+  MUTT_SIZE,            ///< Pattern matches email's size
+  MUTT_REFERENCE,       ///< Pattern matches 'References:' or 'In-Reply-To:' field
+  MUTT_RECIPIENT,       ///< User is a recipient of the email
+  MUTT_LIST,            ///< Email is on mailing list
+  MUTT_SUBSCRIBED_LIST, ///< Email is on subscribed mailing list
+  MUTT_PERSONAL_RECIP,  ///< Email is addressed to the user
+  MUTT_PERSONAL_FROM,   ///< Email is from the user
+  MUTT_ADDRESS,         ///< Pattern matches any address field
+  MUTT_CRYPT_SIGN,      ///< Message is signed
+  MUTT_CRYPT_VERIFIED,  ///< Message is crypographically verified
+  MUTT_CRYPT_ENCRYPT,   ///< Message is encrypted
+  MUTT_PGP_KEY,         ///< Message has PGP key
+  MUTT_XLABEL,          ///< Pattern matches keyword/label
+  MUTT_SERVERSEARCH,    ///< Server-side pattern matches
+  MUTT_DRIVER_TAGS,     ///< Pattern matches message tags
+  MUTT_MIMEATTACH,      ///< Pattern matches number of attachments
+  MUTT_MIMETYPE,        ///< Pattern matches MIME type
 #ifdef USE_NNTP
-  MUTT_NEWSGROUPS,
+  MUTT_NEWSGROUPS,      ///< Pattern matches newsgroup
 #endif
 
   /* Options for Mailcap lookup */

diff --git a/pattern.c b/pattern.c
index 8e27a05ad3c82448065d4ebbdde8d2b6747f940f..1ae9ba16add6ef5c1aaae3bd04b832714399140e 100644 (file)
--- a/pattern.c
+++ b/pattern.c
@@ -147,8 +147,8 @@ enum RangeType
  */
 enum RangeSide
 {
-  RANGE_S_LEFT,
-  RANGE_S_RIGHT
+  RANGE_S_LEFT,  ///< Left side of range
+  RANGE_S_RIGHT, ///< Right side of range
 };
 
 /**

diff --git a/pop/pop_lib.c b/pop/pop_lib.c
index e07fce2f6ee533a456610bcf2e30a3314cca426d..dc90eda9d9dd724151fcaa513927ee34719e30fe 100644 (file)
--- a/pop/pop_lib.c
+++ b/pop/pop_lib.c
@@ -597,8 +597,6 @@ int pop_reconnect(struct Mailbox *m)
 
   if (adata->status == POP_CONNECTED)
     return 0;
-  if (adata->status == POP_BYE)
-    return -1;
 
   while (true)
   {

diff --git a/pop/pop_private.h b/pop/pop_private.h
index abd2f7ded367db849817d5c16f0e520614fd6ab4..1bd5b4b399ac31bea0ef073078f7764fd55ebba0 100644 (file)
--- a/pop/pop_private.h
+++ b/pop/pop_private.h
@@ -47,10 +47,9 @@ struct Progress;
  */
 enum PopStatus
 {
-  POP_NONE = 0,
-  POP_CONNECTED,
-  POP_DISCONNECTED,
-  POP_BYE
+  POP_NONE = 0,     ///< No connected to server
+  POP_CONNECTED,    ///< Connected to server
+  POP_DISCONNECTED, ///< Disconnected from server
 };
 
 /**