fix comments
authorRichard Russon <rich@flatcap.org>
Wed, 10 Oct 2018 21:57:10 +0000 (22:57 +0100)
committerRichard Russon <rich@flatcap.org>
Wed, 10 Oct 2018 22:12:51 +0000 (23:12 +0100)
LICENSE.md
imap/imap.c
imap/imap_private.h
mutt/charset.c
mx.c
mx.h
postpone.c

index 4f3422f2284159620c5bff7383fa69ede0193b1e..7bbcdc34f3789fadf6fe4b3de7733e4906881377 100644 (file)
@@ -1,7 +1,6 @@
-GNU General Public License
-==========================
+The GNU General Public License, Version 2, June 1991 (GPLv2)
+============================================================
 
-_Version 2, June 1991_
 _Copyright © 1989, 1991 Free Software Foundation, Inc.,_
 _51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA_
 
index f898d86fb598513aacbd81e2082d553760d66adb..b0f5926452cfef07b2ea2f5901ee5c469c8cf406 100644 (file)
@@ -960,7 +960,6 @@ struct ImapAccountData *imap_conn_find(const struct ConnAccount *account, int fl
   /* The current connection is a new connection */
   if (!adata)
   {
-    /* The current connection is a new connection */
     adata = imap_adata_new();
     conn->data = adata;
     adata->conn = conn;
index d4181be7b4fb9582f692c65366d4a3484fa9e841..2f36dbb755035dfb0cf9f105c72c80a6c05e64db 100644 (file)
@@ -187,8 +187,8 @@ struct ImapList
  */
 struct ImapCommand
 {
-  char seq[SEQLEN + 1];
-  int state;
+  char seq[SEQLEN + 1]; ///< Command tag, e.g. 'a0001'
+  int state;            ///< Command state, e.g. #IMAP_CMD_NEW
 };
 
 /**
@@ -222,7 +222,7 @@ struct ImapAccountData
    * it's just no fun to get the same information twice */
   char *capstr;
   unsigned char capabilities[(CAPMAX + 7) / 8];
-  unsigned int seqno;
+  unsigned int seqno; ///< tag sequence number, e.g. 'a0001'
   time_t lastread; /**< last time we read a command for the server */
   char *buf;
   size_t blen;
index a13c5cdddf9e595e586fde7d9e2849851a7ef691..ef29f138504abc3fc6e22b31fc8f03123f868cad 100644 (file)
@@ -703,7 +703,7 @@ int mutt_ch_check(const char *s, size_t slen, const char *from, const char *to)
  * @param[in,out] ps    String to convert
  * @param[in]     from  Current character set
  * @param[in]     to    Target character set
- * @param[in]     flags Flags, e.g.
+ * @param[in]     flags Flags, e.g. #MUTT_ICONV_HOOK_FROM
  * @retval 0      Success
  * @retval -1     Invalid arguments or failure to open an iconv channel
  * @retval errno  Failure in iconv conversion
diff --git a/mx.c b/mx.c
index 6f00125dc15301af3e3d80c317cfbc12a04a1614..9e57b4184b4d3b69ba64d7bf189e692a8daac5bf 100644 (file)
--- a/mx.c
+++ b/mx.c
@@ -1329,7 +1329,7 @@ bool mx_tags_is_supported(struct Context *ctx)
 /**
  * mx_path_probe - Find a mailbox that understands a path
  * @param[in]  path  Path to examine
- * @param[out] st    stat buffer (OPTIONAL, for local filesystems)
+ * @param[out] st    stat buffer (OPTIONAL, for local mailboxes)
  * @retval num Type, e.g. #MUTT_IMAP
  */
 int mx_path_probe(const char *path, struct stat *st)
diff --git a/mx.h b/mx.h
index a2fab1916a0e284ddc7e204cf470ae2d585da98f..513ab028b698ef4b0ce8a51fb937659caa2b650d 100644 (file)
--- a/mx.h
+++ b/mx.h
@@ -98,8 +98,8 @@ struct Message
  */
 struct MxOps
 {
-  const int magic;
-  const char *name;
+  const int magic;  ///< Mailbox type, e.g. #MUTT_IMAP
+  const char *name; ///< Mailbox name, e.g. "imap"
   /**
    * mbox_open - Open a mailbox
    * @param ctx Mailbox to open
index d523be051a56b4d648210d4689b1c2f2fc9d1068..d4f9ef8604b0900ac42dbf88f3c41bd46be8389f 100644 (file)
@@ -545,9 +545,9 @@ int mutt_parse_crypt_hdr(const char *p, int set_empty_signas, int crypt_app)
  * @param ctx     If fp is NULL, the context containing the header with the template
  * @param newhdr  The template is read into this Header
  * @param e     The message to recall/resend
- * @param resend  Set if resending (as opposed to recalling a postponed msg).
+ * @param resend  Set if resending (as opposed to recalling a postponed msg)
  *                Resent messages enable header weeding, and also
- *                discard any existing Message-ID and Mail-Followup-To.
+ *                discard any existing Message-ID and Mail-Followup-To
  * @retval  0 Success
  * @retval -1 Error
  */