doxy: tidying

diff --git a/browser.c b/browser.c
index ae6bf7c22d2eb1eb1c181325f108719bdf9b0a0d..989b084a06ad57790bc51ad90fa0d8e3312bb00c 100644 (file)
--- a/browser.c
+++ b/browser.c
@@ -342,17 +342,17 @@ static bool link_is_dir(const char *folder, const char *path)
  * |:--------|:--------------------------------------------------------
  * | \%C     | Current file number
  * | \%d     | Date/time folder was last modified
- * | \%D     | Date/time folder was last modified using $$date_format.
+ * | \%D     | Date/time folder was last modified using `$date_format.`
  * | \%F     | File permissions
- * | \%f     | Filename (with suffix '/', '@' or '*')
+ * | \%f     | Filename (with suffix `/`, `@` or `*`)
  * | \%g     | Group name (or numeric gid, if missing)
  * | \%i     | Description of the folder
  * | \%l     | Number of hard links
- * | \%m     | Number of messages in the mailbox *
+ * | \%m     | Number of messages in the mailbox
  * | \%N     | N if mailbox has new mail, blank otherwise
- * | \%n     | Number of unread messages in the mailbox *
+ * | \%n     | Number of unread messages in the mailbox
  * | \%s     | Size in bytes
- * | \%t     | '*' if the file is tagged, blank otherwise
+ * | \%t     | `*` if the file is tagged, blank otherwise
  * | \%u     | Owner name (or numeric uid, if missing)
  */
 static const char *folder_format_str(char *buf, size_t buflen, size_t col, int cols,

diff --git a/email/email.h b/email/email.h
index 4b5249848bb05f46b061b3745bc629626ae0e38b..0d1711c599b7b4a9c3ab51deb5de996799b12217 100644 (file)
--- a/email/email.h
+++ b/email/email.h
@@ -39,7 +39,7 @@ struct Email
   SecurityFlags security;   /**< bit 0-8: flags, bit 9,10: application.
                                  see: ncrypt/ncrypt.h pgplib.h, smime.h */
 
-  bool mime            : 1; /**< has a MIME-Version email? */
+  bool mime            : 1; /**< has a MIME-Version header? */
   bool flagged         : 1; /**< marked important? */
   bool tagged          : 1;
   bool deleted         : 1;

diff --git a/hdrline.c b/hdrline.c
index 8571d192af8b7f62c8f7cd34620ff410b6855953..a3443e4715efa1b11da35962d932be669a58244b 100644 (file)
--- a/hdrline.c
+++ b/hdrline.c
@@ -495,21 +495,22 @@ static bool thread_is_old(struct Context *ctx, struct Email *e)
  *
  * | Expando | Description
  * |:--------|:-----------------------------------------------------------------
+ * | \%(fmt) | Date/time when the message was received
  * | \%a     | Address of the author
  * | \%A     | Reply-to address (if present; otherwise: address of author)
  * | \%b     | Filename of the original message folder (think mailbox)
- * | \%B     | The list to which the letter was sent, or else the folder name (%b).
+ * | \%B     | The list to which the letter was sent, or else the folder name (%b)
  * | \%C     | Current message number
  * | \%c     | Number of characters (bytes) in the message
- * | \%D     | Date and time of message using $date_format and local timezone
- * | \%d     | Date and time of message using $date_format and sender's timezone
+ * | \%D     | Date and time of message using `$date_format` and local timezone
+ * | \%d     | Date and time of message using `$date_format` and sender's timezone
  * | \%e     | Current message number in thread
  * | \%E     | Number of messages in current thread
- * | \%F     | Author name, or recipient name if the message is from you
  * | \%Fp    | Like %F, but plain. No contextual formatting is applied to recipient name
+ * | \%F     | Author name, or recipient name if the message is from you
  * | \%f     | Sender (address + real name), either From: or Return-Path:
- * | \%g     | Message tags (e.g. notmuch tags/imap flags)
  * | \%Gx    | Individual message tag (e.g. notmuch tags/imap flags)
+ * | \%g     | Message tags (e.g. notmuch tags/imap flags)
  * | \%H     | Spam attribute(s) of this message
  * | \%I     | Initials of author
  * | \%i     | Message-id of the current message
@@ -519,8 +520,8 @@ static bool thread_is_old(struct Context *ctx, struct Email *e)
  * | \%l     | Number of lines in the message
  * | \%M     | Number of hidden messages if the thread is collapsed
  * | \%m     | Total number of message in the mailbox
- * | \%N     | Message score
  * | \%n     | Author's real name (or address if missing)
+ * | \%N     | Message score
  * | \%O     | Like %L, except using address instead of name
  * | \%P     | Progress indicator for the built-in pager (how much of the file has been displayed)
  * | \%q     | Newsgroup name (if compiled with NNTP support)
@@ -528,20 +529,19 @@ static bool thread_is_old(struct Context *ctx, struct Email *e)
  * | \%r     | Comma separated list of To: recipients
  * | \%S     | Single character status of the message (N/O/D/d/!/r/-)
  * | \%s     | Subject of the message
- * | \%T     | The appropriate character from the $$to_chars string
  * | \%t     | 'To:' field (recipients)
+ * | \%T     | The appropriate character from the `$to_chars` string
  * | \%u     | User (login) name of the author
  * | \%v     | First name of the author, or the recipient if the message is from you
  * | \%W     | Name of organization of author ('Organization:' field)
  * | \%x     | 'X-Comment-To:' field (if present and compiled with NNTP support)
  * | \%X     | Number of MIME attachments
- * | \%Y     | 'X-Label:' field (if present, tree unfolded, and != parent's x-label)
  * | \%y     | 'X-Label:' field (if present)
- * | \%Z     | Combined message flags
+ * | \%Y     | 'X-Label:' field (if present, tree unfolded, and != parent's x-label)
  * | \%zc    | Message crypto flags
  * | \%zs    | Message status flags
  * | \%zt    | Message tag flags
- * | \%(fmt) | Date/time when the message was received
+ * | \%Z     | Combined message flags
  * | \%[fmt] | Message date/time converted to the local time zone
  * | \%{fmt} | Message date/time converted to sender's time zone
  */

diff --git a/ncrypt/crypt_gpgme.c b/ncrypt/crypt_gpgme.c
index b659eeabbb448f54e25cc49de2e304bb89c94b76..fa41930f6d86da263622bc04253f4eba41997040 100644 (file)
--- a/ncrypt/crypt_gpgme.c
+++ b/ncrypt/crypt_gpgme.c
@@ -3269,23 +3269,23 @@ int smime_gpgme_application_handler(struct Body *a, struct State *s)
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------
- * | \%u     | User id
  * | \%n     | Number
- * | \%t     | Trust/validity of the key-uid association
  * | \%p     | Protocol
+ * | \%t     | Trust/validity of the key-uid association
+ * | \%u     | User id
  * | \%[...] | Date of key using strftime(3)
  * |         |
- * | \%k     | Key id
  * | \%a     | Algorithm
- * | \%l     | Length
- * | \%f     | Flags
  * | \%c     | Capabilities
+ * | \%f     | Flags
+ * | \%k     | Key id
+ * | \%l     | Length
  * |         |
- * | \%K     | Key id of the principal key
  * | \%A     | Algorithm of the principal key
- * | \%L     | Length of the principal key
- * | \%F     | Flags of the principal key
  * | \%C     | Capabilities of the principal key
+ * | \%F     | Flags of the principal key
+ * | \%K     | Key id of the principal key
+ * | \%L     | Length of the principal key
  */
 static const char *crypt_format_str(char *buf, size_t buflen, size_t col, int cols,
                                     char op, const char *src, const char *prec,

diff --git a/ncrypt/pgpinvoke.c b/ncrypt/pgpinvoke.c
index bfeddff0bb990de8892db6f10fbc3c59b5b12f88..95fabc9fada9468fb39873744ca351fa95574475 100644 (file)
--- a/ncrypt/pgpinvoke.c
+++ b/ncrypt/pgpinvoke.c
@@ -84,7 +84,7 @@ struct PgpCommandContext
  *
  * | Expando | Description
  * |:--------|:-----------------------------------------------------------------
- * | \%a     | Value of $pgp_sign_as if set, otherwise $pgp_default_key
+ * | \%a     | Value of `$pgp_sign_as` if set, otherwise `$pgp_default_key`
  * | \%f     | File containing a message
  * | \%p     | Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty string otherwise
  * | \%r     | One or more key IDs (or fingerprints if available)

diff --git a/ncrypt/pgpkey.c b/ncrypt/pgpkey.c
index cfc8392095c77e5191f5022709162d84fbdefd7f..40748d96d43645bfb43c664b97e3e339471758ba 100644 (file)
--- a/ncrypt/pgpkey.c
+++ b/ncrypt/pgpkey.c
@@ -157,20 +157,22 @@ struct PgpEntry
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------
+ * | \%n     | Number
+ * | \%t     | Trust/validity of the key-uid association
+ * | \%u     | User id
+ * | \%[...] | Date of key using strftime(3)
+ * |         |
  * | \%a     | Algorithm
- * | \%A     | Algorithm of the princ. key
  * | \%c     | Capabilities
- * | \%C     | Capabilities of the princ. key
  * | \%f     | Flags
- * | \%F     | Flags of the princ. key
  * | \%k     | Key id
- * | \%K     | Key id of the principal key
  * | \%l     | Length
- * | \%L     | Length of the princ. key
- * | \%n     | Number
- * | \%t     | Trust/validity of the key-uid association
- * | \%u     | User id
- * | \%[...] | Date of key using strftime(3)
+ * |         |
+ * | \%A     | Algorithm of the principal key
+ * | \%C     | Capabilities of the principal key
+ * | \%F     | Flags of the principal key
+ * | \%K     | Key id of the principal key
+ * | \%L     | Length of the principal key
  */
 static const char *pgp_entry_fmt(char *buf, size_t buflen, size_t col, int cols,
                                  char op, const char *src, const char *prec,

diff --git a/ncrypt/smime.c b/ncrypt/smime.c
index e3e1b0313a27001a609b250d3cb9ef5a7946ea17..9e219694ecb11dd390b48850dd8788a7529ec285 100644 (file)
--- a/ncrypt/smime.c
+++ b/ncrypt/smime.c
@@ -201,12 +201,12 @@ int smime_class_valid_passphrase(void)
  * | Expando | Description
  * |:--------|:-----------------------------------------------------------------
  * | \%a     | Algorithm used for encryption
- * | \%C     | CA location: Depending on whether $smime_ca_location points to a directory or file
+ * | \%C     | CA location: Depending on whether `$smime_ca_location` points to a directory or file
  * | \%c     | One or more certificate IDs
- * | \%d     | Message digest algorithm specified with $smime_sign_digest_alg
+ * | \%d     | Message digest algorithm specified with `$smime_sign_digest_alg`
  * | \%f     | File containing a message
  * | \%i     | Intermediate certificates
- * | \%k     | The key-pair specified with $smime_default_key
+ * | \%k     | The key-pair specified with `$smime_default_key`
  * | \%s     | File containing the signature part of a multipart/signed attachment when verifying it
  */
 static const char *fmt_smime_command(char *buf, size_t buflen, size_t col, int cols,

diff --git a/query.c b/query.c
index 04a9c230e5c8986951b11aa85b9fa00b8f8a0871..b05f131437731e6ae8b066febd8d80e5c1c2f214 100644 (file)
--- a/query.c
+++ b/query.c
@@ -242,7 +242,7 @@ static int query_search(struct Menu *menu, regex_t *rx, int line)
  * | \%c     | Current entry number
  * | \%e     | Extra information
  * | \%n     | Destination name
- * | \%t     | '*' if current entry is tagged, a space otherwise
+ * | \%t     | `*` if current entry is tagged, a space otherwise
  */
 static const char *query_format_str(char *buf, size_t buflen, size_t col, int cols,
                                     char op, const char *src, const char *prec,

diff --git a/sidebar.c b/sidebar.c
index f86ca23ef876b0f8364e469937fc0cd79b2ffabf..54207699e676fa34bf3665fdd419812835a5733c 100644 (file)
--- a/sidebar.c
+++ b/sidebar.c
@@ -100,16 +100,16 @@ enum DivType
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------
+ * | \%!     | 'n!' Flagged messages
  * | \%B     | Name of the mailbox
- * | \%d     | Number of deleted messages
  * | \%D     | Description of the mailbox
+ * | \%d     | Number of deleted messages
  * | \%F     | Number of Flagged messages in the mailbox
  * | \%L     | Number of messages after limiting
  * | \%n     | N if mailbox has new mail, blank otherwise
  * | \%N     | Number of unread messages in the mailbox
  * | \%S     | Size of mailbox (total number of messages)
  * | \%t     | Number of tagged messages
- * | \%!     | 'n!' Flagged messages
  */
 static const char *sidebar_format_str(char *buf, size_t buflen, size_t col, int cols,
                                       char op, const char *src, const char *prec,

diff --git a/status.c b/status.c
index 4380c78089e422b8db52639a8014f7c11fcb05d3..0f76f6b0b55a21a29a34d15b1a931e86f7a30354 100644 (file)
--- a/status.c
+++ b/status.c
@@ -65,8 +65,8 @@ static char *get_sort_str(char *buf, size_t buflen, enum SortType method)
  * | Expando | Description
  * |:--------|:--------------------------------------------------------
  * | \%b     | Number of incoming folders with unread messages
- * | \%d     | Number of deleted messages
  * | \%D     | Description of the mailbox
+ * | \%d     | Number of deleted messages
  * | \%f     | Full mailbox path
  * | \%F     | Number of flagged messages
  * | \%h     | Hostname
@@ -80,8 +80,8 @@ static char *get_sort_str(char *buf, size_t buflen, enum SortType method)
  * | \%P     | Percent of way through index
  * | \%R     | Number of read messages
  * | \%r     | Readonly/wontwrite/changed flag
- * | \%S     | Current aux sorting method ($sort_aux)
- * | \%s     | Current sorting method ($sort)
+ * | \%S     | Current aux sorting method (`$sort_aux`)
+ * | \%s     | Current sorting method (`$sort`)
  * | \%t     | # of tagged messages
  * | \%u     | Number of unread messages
  * | \%V     | Currently active limit pattern