From: Richard Russon <rich@flatcap.org>
Date: Fri, 28 Sep 2018 18:49:58 +0000 (+0100)
Subject: add comments
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3b78bc689a7cbcce333b95a3805db51563c48f93;p=neomutt

add comments
---

diff --git a/compress.c b/compress.c
index eb7638cea..899fdeea5 100644
--- a/compress.c
+++ b/compress.c
@@ -25,6 +25,11 @@
  * @page compress Compressed mbox local mailbox type
  *
  * Compressed mbox local mailbox type
+ *
+ * @note
+ * Any references to compressed files also apply to encrypted files.
+ * - mailbox->path     == plaintext file
+ * - mailbox->realpath == compressed file
  */
 
 #include "config.h"
@@ -50,12 +55,6 @@
 
 struct Email;
 
-/* Notes:
- * Any references to compressed files also apply to encrypted files.
- * - mailbox->path     == plaintext file
- * - mailbox->realpath == compressed file
- */
-
 /**
  * struct CompressInfo - Private data for compress
  *
diff --git a/conn/connaccount.h b/conn/connaccount.h
index 5651f4332..22df52d44 100644
--- a/conn/connaccount.h
+++ b/conn/connaccount.h
@@ -33,8 +33,8 @@ struct ConnAccount
   char pass[256];
   char host[128];
   unsigned short port;
-  unsigned char type;
-  unsigned char flags;
+  unsigned char type;  ///< Connection type, e.g. #MUTT_ACCT_TYPE_IMAP
+  unsigned char flags; ///< Which fields are initialised, e.g. #MUTT_ACCT_USER
 };
 
 #endif /* MUTT_CONN_ACCOUNT_H */
diff --git a/conn/connection.h b/conn/connection.h
index 6a392393c..c41232527 100644
--- a/conn/connection.h
+++ b/conn/connection.h
@@ -36,7 +36,7 @@ struct Connection
 {
   struct ConnAccount account;
   unsigned int ssf; /**< security strength factor, in bits */
-  void *data;
+  void *data; /** mostly Mailbox ptr, else NNTP Server */
 
   char inbuf[LONG_STRING];
   int bufpos;
diff --git a/imap/imap_private.h b/imap/imap_private.h
index 487b8c51f..ddcc1736b 100644
--- a/imap/imap_private.h
+++ b/imap/imap_private.h
@@ -210,8 +210,8 @@ struct ImapMboxData
 {
   struct Connection *conn;
   bool recovering;
-  unsigned char state;
-  unsigned char status;
+  unsigned char state;  ///< ImapState, e.g. #IMAP_AUTHENTICATED
+  unsigned char status; ///< ImapFlags, e.g. #IMAP_FATAL
   /* let me explain capstr: SASL needs the capability string (not bits).
    * we have 3 options:
    *   1. rerun CAPABILITY inside SASL function.
@@ -249,8 +249,8 @@ struct ImapMboxData
   char delim;
   struct Context *ctx;
   char *mbox_name;
-  unsigned short check_status;
-  unsigned char reopen;
+  unsigned short check_status; /**< Flags, e.g. #IMAP_NEWMAIL_PENDING */
+  unsigned char reopen;        /**< Flags, e.g. #IMAP_REOPEN_ALLOW */
   unsigned int new_mail_count; /**< Set when EXISTS notifies of new mail */
   struct ImapCache cache[IMAP_CACHE_LEN];
   struct Hash *uid_hash;
diff --git a/mailbox.h b/mailbox.h
index 8b687762f..5311758d0 100644
--- a/mailbox.h
+++ b/mailbox.h
@@ -41,8 +41,8 @@ extern short MailCheckStatsInterval;
 extern bool  MaildirCheckCur;
 
 /* parameter to mutt_parse_mailboxes */
-#define MUTT_NAMED   1
-#define MUTT_VIRTUAL 2
+#define MUTT_NAMED   (1 << 0)
+#define MUTT_VIRTUAL (1 << 1)
 
 #define MB_NORMAL 0
 #define MB_HIDDEN 1