From: Richard Russon Date: Sun, 29 Jul 2018 14:19:08 +0000 (+0100) Subject: doxy: tidy pages X-Git-Tag: 2019-10-25~724 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c2f29aee91dc10008e53a3073b8903ec1543dc6a;p=neomutt doxy: tidy pages --- diff --git a/config/lib.h b/config/lib.h index 56052fd91..e30b8deb5 100644 --- a/config/lib.h +++ b/config/lib.h @@ -21,22 +21,26 @@ */ /** - * @page config Flexible handling of config items + * @page config CONFIG: Flexible handling of config items * * User configurable variables. * - * -# @subpage config-set - * -# @subpage config-dump - * -# @subpage config-address - * -# @subpage config-bool - * -# @subpage config-magic - * -# @subpage config-mbtable - * -# @subpage config-number - * -# @subpage config-path - * -# @subpage config-quad - * -# @subpage config-regex - * -# @subpage config-sort - * -# @subpage config-string + * | File | Description | + * | :--------------- | :---------------------- | + * | config/address.c | @subpage config-address | + * | config/bool.c | @subpage config-bool | + * | config/command.c | @subpage config-command | + * | config/dump.c | @subpage config-dump | + * | config/long.c | @subpage config-long | + * | config/magic.c | @subpage config-magic | + * | config/mbtable.c | @subpage config-mbtable | + * | config/number.c | @subpage config-number | + * | config/path.c | @subpage config-path | + * | config/quad.c | @subpage config-quad | + * | config/regex.c | @subpage config-regex | + * | config/set.c | @subpage config-set | + * | config/sort.c | @subpage config-sort | + * | config/string.c | @subpage config-string | */ #ifndef _CONFIG_CONFIG_H diff --git a/conn/conn.h b/conn/conn.h index a4d0163b9..1e4a02257 100644 --- a/conn/conn.h +++ b/conn/conn.h @@ -21,7 +21,7 @@ */ /** - * @page conn Network connections and their encryption + * @page conn CONN: Network connections and their encryption * * Manage external connections. * diff --git a/email/email.h b/email/email.h index 4f26f8e76..0c71e6a70 100644 --- a/email/email.h +++ b/email/email.h @@ -21,27 +21,30 @@ */ /** - * @page email Structs that make up an email + * @page email EMAIL: Structs that make up an email * * Structs that make up an email * - * | File | Description | - * | :---------------- | :----------------------- | - * | email/address.c | @subpage email_address | - * | email/attach.c | @subpage email_attach | - * | email/body.c | @subpage email_body | - * | email/envelope.c | @subpage email_envelope | - * | email/from.c | @subpage email_from | - * | email/header.c | @subpage email_header | - * | email/idna.c | @subpage email_idna | - * | email/parameter.c | @subpage email_parameter | - * | email/mime.c | @subpage email_mime | - * | email/parse.c | @subpage email_parse | - * | email/rfc2047.c | @subpage email_rfc2047 | - * | email/rfc2231.c | @subpage email_rfc2231 | - * | email/tags.c | @subpage email_tags | - * | email/thread.c | @subpage email_thread | - * | email/url.c | @subpage email_url | + * | File | Description | + * | :--------------------- | :----------------------- | + * | email/address.c | @subpage email_address | + * | email/attach.c | @subpage email_attach | + * | email/body.c | @subpage email_body | + * | email/email_globals.c | @subpage email_globals | + * | email/envelope.c | @subpage email_envelope | + * | email/from.c | @subpage email_from | + * | email/header.c | @subpage email_header | + * | email/idna.c | @subpage email_idna | + * | email/mime.c | @subpage email_mime | + * | email/parameter.c | @subpage email_parameter | + * | email/parse.c | @subpage email_parse | + * | email/rfc2047.c | @subpage email_rfc2047 | + * | email/rfc2231.c | @subpage email_rfc2231 | + * | email/tags.c | @subpage email_tags | + * | email/thread.c | @subpage email_thread | + * | email/url.c | @subpage email_url | + * + * @image html libemail.svg */ #ifndef _EMAIL_EMAIL_H diff --git a/email/email_globals.c b/email/email_globals.c index 1f3a18ba5..a407abebc 100644 --- a/email/email_globals.c +++ b/email/email_globals.c @@ -31,11 +31,11 @@ #include "mutt/mutt.h" /* Config items */ -bool MarkOld = false; -struct Regex *ReplyRegex = NULL; -char *SendCharset = NULL; -char *SpamSeparator = NULL; -bool Weed = false; +bool MarkOld = false; /**< Config: If set, mark mail old when leaving mailbox */ +struct Regex *ReplyRegex = NULL; /**< Config: Regex to match reply marker "Re:" */ +char *SendCharset = NULL; /**< Config: Character sets for outgoing mail */ +char *SpamSeparator = NULL; /**< Config: Separator for multiple spam headers */ +bool Weed = false; /**< Config: If set, filter the displayed email headers */ /* Global variables */ struct RegexList *NoSpamList = NULL; diff --git a/email/url.c b/email/url.c index 39958c0bb..92350b610 100644 --- a/email/url.c +++ b/email/url.c @@ -35,7 +35,7 @@ #include "mime.h" /** - * UrlMap - Constants for URL protocols, e.g. 'imap://' + * UrlMap - Constants for URL protocols */ static const struct Mapping UrlMap[] = { { "file", U_FILE }, { "imap", U_IMAP }, { "imaps", U_IMAPS }, diff --git a/hcache/hcache.h b/hcache/hcache.h index 55258d2ef..8aac251ab 100644 --- a/hcache/hcache.h +++ b/hcache/hcache.h @@ -24,7 +24,7 @@ */ /** - * @page hcache Header cache API + * @page hcache HCACHE: Header cache API * * This module defines the user-visible header cache API, which is used within * neomutt to cache and restore mail header data. diff --git a/imap/imap.h b/imap/imap.h index 504c22fc5..b4e04ec59 100644 --- a/imap/imap.h +++ b/imap/imap.h @@ -22,7 +22,7 @@ */ /** - * @page imap IMAP Network Mailbox + * @page imap IMAP: Network Mailbox * * IMAP network mailbox * diff --git a/maildir/maildir.h b/maildir/maildir.h index 48e7865d9..25bd5adac 100644 --- a/maildir/maildir.h +++ b/maildir/maildir.h @@ -21,7 +21,7 @@ */ /** - * @page maildir Maildir local mailbox type + * @page maildir MAILDIR: Local mailbox type * * Maildir local mailbox type * diff --git a/mbox/mbox.h b/mbox/mbox.h index 49f48474c..a02570dbb 100644 --- a/mbox/mbox.h +++ b/mbox/mbox.h @@ -21,7 +21,7 @@ */ /** - * @page mbox Mbox local mailbox type + * @page mbox MBOX: Local mailbox type * * Mbox local mailbox type * diff --git a/mutt/mutt.h b/mutt/mutt.h index cdc31d4b3..bd4425f00 100644 --- a/mutt/mutt.h +++ b/mutt/mutt.h @@ -21,7 +21,7 @@ */ /** - * @page mutt Shared code for handling strings, files, dates, etc + * @page mutt MUTT: Shared code for handling strings, files, dates, etc * * Each source file in the library provides a group of related functions. * @@ -49,6 +49,8 @@ * * @note The library is self-contained -- some files may depend on others in * the library, but none depends on source from outside. + * + * @image html libmutt.svg */ #ifndef _MUTT_MUTT_H diff --git a/ncrypt/ncrypt.h b/ncrypt/ncrypt.h index 700450f43..58dc7368f 100644 --- a/ncrypt/ncrypt.h +++ b/ncrypt/ncrypt.h @@ -22,7 +22,7 @@ */ /** - * @page ncrypt Encrypt/decrypt/sign/verify emails + * @page ncrypt NCRYPT: Encrypt/decrypt/sign/verify emails * * Encrypt/decrypt/sign/verify emails * diff --git a/nntp/nntp.h b/nntp/nntp.h index e06152f32..7354e2429 100644 --- a/nntp/nntp.h +++ b/nntp/nntp.h @@ -23,7 +23,7 @@ */ /** - * @page nntp Usenet network mailbox type; talk to an NNTP server + * @page nntp NNTP: Usenet network mailbox type; talk to an NNTP server * * Usenet network mailbox type; talk to an NNTP server * diff --git a/notmuch/mutt_notmuch.h b/notmuch/mutt_notmuch.h index ac41d28f3..f43faa70c 100644 --- a/notmuch/mutt_notmuch.h +++ b/notmuch/mutt_notmuch.h @@ -21,7 +21,7 @@ */ /** - * @page notmuch Notmuch virtual mailbox type + * @page notmuch NOTMUCH: Virtual mailbox type * * Notmuch virtual mailbox type * diff --git a/pop/pop.h b/pop/pop.h index 2cb6ac654..aeee4e5ba 100644 --- a/pop/pop.h +++ b/pop/pop.h @@ -27,7 +27,7 @@ #include "mx.h" /** - * @page pop POP network mailbox + * @page pop POP: Network mailbox * * POP network mailbox *