doxy: doc config items

diff --git a/addrbook.c b/addrbook.c
index a88771c065e7388695b87f763ed09d4c276272a4..b77423a8d26de9f26713653012e3ce4bdd2cda1f 100644 (file)
--- a/addrbook.c
+++ b/addrbook.c
@@ -46,7 +46,7 @@
 #include "sort.h"
 
 /* These Config Variables are only used in addrbook.c */
-char *AliasFormat;
+char *AliasFormat; ///< Config: printf-like format string for the alias menu
 short SortAlias;
 
 #define RSORT(x) ((SortAlias & SORT_REVERSE) ? -x : x)

diff --git a/browser.c b/browser.c
index f239c3b888f9e7c4e0d0e476cc9144d05ba4bd63..4141320d95532644707cc39c81d72a7e698abefa 100644 (file)
--- a/browser.c
+++ b/browser.c
@@ -70,12 +70,12 @@
 
 /* These Config Variables are only used in browser.c */
 bool BrowserAbbreviateMailboxes;
-char *FolderFormat;
-char *GroupIndexFormat;
-char *NewsgroupsCharset;
+char *FolderFormat; ///< Config: printf-like format string for the browser's display of folders
+char *GroupIndexFormat; ///< Config: (nntp) printf-like format string for the browser's display of newsgroups
+char *NewsgroupsCharset; ///< Config: (nntp) Character set of newsgroups' descriptions
 bool ShowOnlyUnread;
 short SortBrowser;
-char *VfolderFormat;
+char *VfolderFormat; ///< Config: (notmuch) printf-like format string for the browser's display of virtual folders
 
 static const struct Mapping FolderHelp[] = {
   { N_("Exit"), OP_EXIT },

diff --git a/buffy.c b/buffy.c
index 50294b746355ed34bb11c77b6048dc844112a3a5..dc8c23905a3901457742987840eed2830f66db3e 100644 (file)
--- a/buffy.c
+++ b/buffy.c
@@ -55,7 +55,7 @@
 #endif
 
 /* These Config Variables are only used in buffy.c */
-short MailCheck;
+short MailCheck; ///< Config: Number of seconds before NeoMutt checks for new mail
 bool MailCheckStats;
 short MailCheckStatsInterval;
 bool MaildirCheckCur;

diff --git a/commands.c b/commands.c
index 17fe2edcdd04555023cd415571183fbed1202b3f..363b6c0b6f87ea50c549752e5554e53a7284d6b5 100644 (file)
--- a/commands.c
+++ b/commands.c
@@ -71,10 +71,10 @@
 
 /* These Config Variables are only used in commands.c */
 unsigned char CryptVerifySig; /* verify PGP signatures */
-char *DisplayFilter;
-bool PipeDecode;
-char *PipeSep;
-bool PipeSplit;
+char *DisplayFilter; ///< Config: External command to pre-process an email before display
+bool PipeDecode; ///< Config: Decode the message when piping it
+char *PipeSep;   ///< Config: Separator to add between multiple piped messages
+bool PipeSplit;  ///< Config: Run the pipe command on each message separately
 bool PrintDecode;
 bool PrintSplit;
 bool PromptAfter;

diff --git a/compose.c b/compose.c
index 0b3e9b236b6c5a83e0cb493ac8b294283bcf56f2..66b9245b9c69cc0fba2170cc74a4730f3e0501cf 100644 (file)
--- a/compose.c
+++ b/compose.c
@@ -73,8 +73,8 @@
 #endif
 
 /* These Config Variables are only used in compose.c */
-char *ComposeFormat;
-char *Ispell;
+char *ComposeFormat; ///< Config: printf-like format string for the Compose panel's status bar
+char *Ispell; ///< Config: External command to perform spell-checking
 unsigned char Postpone;
 
 static const char *There_are_no_attachments = N_("There are no attachments.");

diff --git a/conn/conn_globals.c b/conn/conn_globals.c
index 712d7cc09474e180e25f604699df9ac28d8c0d8a..2e9c44cc5c5ba680bec9978d22458bf1c6064caa 100644 (file)
--- a/conn/conn_globals.c
+++ b/conn/conn_globals.c
@@ -30,22 +30,22 @@
 #include <stdbool.h>
 #include <stdio.h>
 
-short ConnectTimeout = 0; /**< Config: Timeout for a network connection (for IMAP, POP or SMTP) */
+short ConnectTimeout = 0; ///< Config: Timeout for making network connections (-1 to wait indefinitely)
 
 #ifdef USE_SSL
-const char *CertificateFile = NULL; /**< Config: File containing trusted certificates */
-const char *EntropyFile = NULL; /**< Config: File containing random data to initialise SSL */
-const char *SslCiphers = NULL; /**< Config: Ciphers to use when using SSL */
-const char *SslClientCert = NULL; /**< Config: File containing client certificates */
+const char *CertificateFile = NULL; ///< Config: File containing trusted certificates
+const char *EntropyFile = NULL; ///< Config: (ssl) File/device containing random data to initialise SSL
+const char *SslCiphers = NULL;  ///< Config: Ciphers to use when using SSL
+const char *SslClientCert = NULL; ///< Config: File containing client certificates
 #ifdef USE_SSL_GNUTLS
-const char *SslCaCertificatesFile = NULL; /**< Config: File containing trusted CA certificates */
-short SslMinDhPrimeBits = 0; /**< Config: Minimum keysize for Diffie-Hellman key exchange */
+const char *SslCaCertificatesFile = NULL; ///< Config: File containing trusted CA certificates
+short SslMinDhPrimeBits = 0; ///< Config: Minimum keysize for Diffie-Hellman key exchange
 #endif
 #endif
 
 #ifdef USE_SOCKET
-const char *Preconnect = NULL; /**< Config: Shell command to run before making a connection */
-const char *Tunnel = NULL; /**< Config: Shell command to establish a tunnel */
+const char *Preconnect = NULL; ///< Config: Shell command to run before making a connection
+const char *Tunnel = NULL; ///< Config: Shell command to establish a tunnel
 #endif
 
 #ifdef USE_SSL

diff --git a/curs_main.c b/curs_main.c
index 991a2dd917c32063e905ac03f83109d9979285fc..4f61e3ef1897a29323331513274a28bcd38cfe3c 100644 (file)
--- a/curs_main.c
+++ b/curs_main.c
@@ -89,9 +89,9 @@
 
 /* These Config Variables are only used in curs_main.c */
 bool ChangeFolderNext;
-bool CollapseAll;
-bool CollapseFlagged;
-bool CollapseUnread;
+bool CollapseAll; ///< Config: Collapse all threads when entering a folder
+bool CollapseFlagged; ///< Config: Prevent the collapse of threads with flagged emails
+bool CollapseUnread; ///< Config: Prevent the collapse of threads with unread emails
 char *MarkMacroPrefix;
 bool PgpAutoDecode;
 bool UncollapseJump;

diff --git a/edit.c b/edit.c
index 113bb82e04472178bafe538142bbfdcca6d2e1cf..5a9b64aaa6cf9b183efa899db6d6d329be097b5e 100644 (file)
--- a/edit.c
+++ b/edit.c
@@ -44,7 +44,7 @@
 #include "protos.h"
 
 /* These Config Variables are only used in edit.c */
-char *Escape;
+char *Escape; ///< Config: Escape character to use for functions in the built-in editor.
 
 /* SLcurses_waddnstr() can't take a "const char *", so this is only
  * declared "static" (sigh)

diff --git a/email/email_globals.c b/email/email_globals.c
index a407abebcc2f968acd45ef74f29f1a293508e3b8..52224772e711b597e478fc50205ba6d76e7af2a6 100644 (file)
--- a/email/email_globals.c
+++ b/email/email_globals.c
@@ -31,11 +31,11 @@
 #include "mutt/mutt.h"
 
 /* Config items */
-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 */
+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/header.h b/email/header.h
index 948ca859a1992a8936b52766f9d3090e6e8bec54..b1a90a8beb63f0da3e8f4312ed2a9d531d5af5d1 100644 (file)
--- a/email/header.h
+++ b/email/header.h
@@ -32,7 +32,7 @@
 /**
  * struct Header - The header/envelope of an email
  */
-struct Header
+struct Header ///< Config: Include the message headers in the reply email (Weed applies)
 {
   unsigned int security : 12; /**< bit 0-8: flags, bit 9,10: application.
                                  see: mutt_crypt.h pgplib.h, smime.h */

diff --git a/email/idna.c b/email/idna.c
index 08886a277121350ebf3ed6b95fb9eed77bae1dcb..491dbf20d2fa8060de55c0c6d731f53819d92765 100644 (file)
--- a/email/idna.c
+++ b/email/idna.c
@@ -49,8 +49,8 @@
 
 /* These Config Variables are only used in mutt/idna.c */
 #ifdef HAVE_LIBIDN
-bool IdnDecode;
-bool IdnEncode;
+bool IdnDecode; ///< Config: (idn) Decode internation domain names
+bool IdnEncode; ///< Config: (idn) Encode international domain names
 #endif
 
 #ifdef HAVE_LIBIDN

diff --git a/email/mime.h b/email/mime.h
index 5253f7fc4b2ce26c03f488e1f2700cc0ce97c761..6be9f42742cc4ecd3bb61c7cd3c9f6ad1ef1906f 100644 (file)
--- a/email/mime.h
+++ b/email/mime.h
@@ -26,7 +26,7 @@
 /**
  * enum ContentType - Content-Type
  */
-enum ContentType
+enum ContentType ///< Config: Default "Content-Type" for newly composed messages
 {
   TYPE_OTHER,
   TYPE_AUDIO,

diff --git a/globals.h b/globals.h
index c263cce875c0ace4f4a29a5e39c7c98544207355..cbbf2e87c4540ae5d7667fae2ab56a81cefde6c9 100644 (file)
--- a/globals.h
+++ b/globals.h
@@ -101,24 +101,24 @@ WHERE struct AliasList Aliases INITVAL(TAILQ_HEAD_INITIALIZER(Aliases));
 WHERE struct Address *EnvelopeFromAddress;
 WHERE struct Address *From;
 
-WHERE char *AliasFile;
+WHERE char *AliasFile; ///< Config: Save new aliases to this file
 WHERE char *Attribution;
 WHERE char *AttributionLocale;
-WHERE char *AttachFormat;
-WHERE char *ConfigCharset;
-WHERE char *DateFormat;
+WHERE char *AttachFormat; ///< Config: printf-like format string for the attachment menu
+WHERE char *ConfigCharset; ///< Config: Character set that the config files are in
+WHERE char *DateFormat; ///< Config: strftime format string for the `%d` expando
 WHERE char *DsnNotify;
 WHERE char *DsnReturn;
-WHERE char *Editor;
-WHERE char *Hostname;
-WHERE char *IndexFormat;
+WHERE char *Editor; ///< Config: External command to use as an email editor
+WHERE char *Hostname; ///< Config: Fully-qualified domain name of this machine
+WHERE char *IndexFormat; ///< Config: printf-like format string for the index menu (emails)
 
 #ifdef USE_IMAP
-WHERE char *ImapUser;
+WHERE char *ImapUser; ///< Config: (imap) Username for the IMAP server
 #endif
-WHERE char *Mbox;
+WHERE char *Mbox; ///< Config: Folder that receives read emails (see Move)
 WHERE char *MailcapPath;
-WHERE char *Folder;
+WHERE char *Folder; ///< Config: Base folder for a set of mailboxes
 #ifdef USE_HCACHE
 WHERE char *HeaderCache;
 #if defined(HAVE_GDBM) || defined(HAVE_BDB)
@@ -127,19 +127,19 @@ WHERE char *HeaderCachePagesize;
 #endif /* USE_HCACHE */
 
 #ifdef USE_SOCKET
-WHERE short NetInc;
+WHERE short NetInc; ///< Config: (socket) Update the progress bar after this many KB sent/received (0 to disable)
 #endif /* USE_SOCKET */
 
 #ifdef USE_NNTP
-WHERE char *NewsServer;
+WHERE char *NewsServer; ///< Config: (nntp) Url of the news server
 #endif
 WHERE char *Record;
 WHERE char *Pager;
-WHERE char *PagerFormat;
+WHERE char *PagerFormat; ///< Config: printf-like format string for the pager's status bar
 WHERE char *Postponed;
-WHERE char *IndentString;
+WHERE char *IndentString; ///< Config: String used to indent 'reply' text
 WHERE char *PrintCommand;
-WHERE char *NewMailCommand;
+WHERE char *NewMailCommand; ///< Config: External command to run when new mail arrives
 WHERE char *Realname;
 WHERE char *Shell;
 WHERE char *SimpleSearch;
@@ -147,16 +147,16 @@ WHERE char *SimpleSearch;
 WHERE char *SmtpUrl;
 #endif /* USE_SMTP */
 WHERE char *Spoolfile;
-WHERE char *StatusFormat;
-WHERE char *TsStatusFormat;
-WHERE char *TsIconFormat;
-WHERE char *Visual;
+WHERE char *StatusFormat; ///< Config: printf-like format string for the index's status line
+WHERE char *TsStatusFormat; ///< Config: printf-like format string for the terminal's status (window title)
+WHERE char *TsIconFormat; ///< Config: printf-like format string for the terminal's icon title
+WHERE char *Visual; ///< Config: Editor to use when '~v' is given in the built-in editor
 
-WHERE short ReadInc;
+WHERE short ReadInc; ///< Config: Update the progress bar after this many records read (0 to disable)
 WHERE short SleepTime;
 WHERE short Timeout;
 WHERE short Wrap;
-WHERE short WriteInc;
+WHERE short WriteInc; ///< Config: Update the progress bar after this many records written (0 to disable)
 
 #ifdef USE_SIDEBAR
 WHERE short SidebarWidth;
@@ -169,7 +169,7 @@ WHERE short ImapPollTimeout;
 /* -- formerly in pgp.h -- */
 WHERE char *PgpDefaultKey;
 WHERE char *PgpSignAs;
-WHERE char *PgpEntryFormat;
+WHERE char *PgpEntryFormat; ///< Config: printf-like format string for the PGP key selection menu
 
 /* -- formerly in smime.h -- */
 WHERE char *SmimeDefaultKey;
@@ -187,11 +187,11 @@ WHERE struct Regex *QuoteRegex;
 
 /* Quad-options */
 WHERE unsigned char Bounce;
-WHERE unsigned char Copy;
+WHERE unsigned char Copy; ///< Config: Save outgoing emails to $record
 WHERE unsigned char Delete;
 WHERE unsigned char MimeForward;
 WHERE unsigned char Print;
-WHERE unsigned char Quit;
+WHERE unsigned char Quit; ///< Config: Prompt before exiting NeoMutt
 #ifdef USE_SSL
 WHERE unsigned char SslStarttls;
 #endif
@@ -200,21 +200,21 @@ WHERE unsigned char PostModerated;
 WHERE unsigned char FollowupToPoster;
 #endif
 
-WHERE bool ArrowCursor;
-WHERE bool AsciiChars;
-WHERE bool Askbcc;
-WHERE bool Askcc;
+WHERE bool ArrowCursor; ///< Config: Use an arrow '->' instead of highlighting in the index
+WHERE bool AsciiChars; ///< Config: Use plain ASCII characters, when drawing email threads
+WHERE bool Askbcc; ///< Config: Ask the user for the blind-carbon-copy recipients
+WHERE bool Askcc; ///< Config: Ask the user for the carbon-copy recipients
 WHERE bool Autoedit;
 WHERE bool AutoTag;
-WHERE bool Beep;
-WHERE bool BeepNew;
+WHERE bool Beep; ///< Config: Make a noise when an error occurs
+WHERE bool BeepNew; ///< Config: Make a noise when new mail arrives
 WHERE bool BrailleFriendly;
-WHERE bool CheckMboxSize;
-WHERE bool Confirmappend;
-WHERE bool Confirmcreate;
+WHERE bool CheckMboxSize; ///< Config: (mbox,mmdf) Use mailbox size as an indicator of new mail
+WHERE bool Confirmappend; ///< Config: Confirm before appending emails to a mailbox
+WHERE bool Confirmcreate; ///< Config: Confirm before creating a new mailbox
 WHERE bool DeleteUntag;
-WHERE bool EditHeaders;
-WHERE bool FlagSafe;
+WHERE bool EditHeaders; ///< Config: Let the user edit the email headers whilst editing an email
+WHERE bool FlagSafe; ///< Config: Protect flagged messages from deletion
 WHERE bool ForwardDecode;
 WHERE bool ForwardQuote;
 #ifdef USE_HCACHE
@@ -223,9 +223,9 @@ WHERE bool HeaderCacheCompress;
 #endif /* HAVE_QDBM */
 #endif
 WHERE bool Header;
-WHERE bool Help;
+WHERE bool Help; ///< Config: Display a help line with common key bindings
 #ifdef USE_IMAP
-WHERE bool ImapCheckSubscribed;
+WHERE bool ImapCheckSubscribed; ///< Config: (imap) Ask the IMAP server for a list of subscribed folders
 WHERE bool ImapListSubscribed;
 WHERE bool ImapPassive;
 WHERE bool ImapPeek;
@@ -250,7 +250,7 @@ WHERE bool ReadOnly;
 WHERE bool Resolve;
 WHERE bool ResumeDraftFiles;
 WHERE bool SaveAddress;
-WHERE bool SaveEmpty;
+WHERE bool SaveEmpty; ///< Config: (mbox,mmdf) Preserve empty mailboxes
 WHERE bool Score;
 #ifdef USE_SIDEBAR
 WHERE bool SidebarVisible;

diff --git a/hdrline.c b/hdrline.c
index 222ca19314b3fafaccbdf42eb3ec3e75ab162b9a..02001b7608718f588fa31a1a74eaae4da4c49b12 100644 (file)
--- a/hdrline.c
+++ b/hdrline.c
@@ -48,8 +48,8 @@
 #include "sort.h"
 
 /* These Config Variables are only used in hdrline.c */
-struct MbTable *FlagChars;
-struct MbTable *FromChars;
+struct MbTable *FlagChars; ///< Config: User-configurable index flags, e.g. tagged, new, etc
+struct MbTable *FromChars; ///< Config: User-configurable index flags, e.g. to address, cc address, etc
 struct MbTable *ToChars;
 
 /**

diff --git a/imap/auth.c b/imap/auth.c
index 77b6646faf5e34f65772608f442b96e9bf81671c..dbb16756337df965d56e17e6e411f5fbdd607438 100644 (file)
--- a/imap/auth.c
+++ b/imap/auth.c
@@ -34,7 +34,7 @@
 #include "auth.h"
 
 /* These Config Variables are only used in imap/auth.c */
-char *ImapAuthenticators;
+char *ImapAuthenticators; ///< Config: (imap) List of allowed IMAP authentication methods
 
 /**
  * imap_authenticators - Accepted authentication methods

diff --git a/imap/message.c b/imap/message.c
index e661d726141008772f44605c6a2e01cb86af6c2f..a6dfc61a4ca0b43c70e719b8d5d83567a9c7fdb4 100644 (file)
--- a/imap/message.c
+++ b/imap/message.c
@@ -65,7 +65,7 @@
 struct BodyCache;
 
 /* These Config Variables are only used in imap/message.c */
-char *ImapHeaders;
+char *ImapHeaders; ///< Config: (imap) Additional email headers to download when getting index
 
 /**
  * new_header_data - Create a new ImapHeaderData

diff --git a/imap/util.c b/imap/util.c
index ba56d287f03924b15536a8d00408633a2b910166..34147a532b5fe27245e3746d8c5e4be479fe1a33 100644 (file)
--- a/imap/util.c
+++ b/imap/util.c
@@ -61,7 +61,7 @@
 #endif
 
 /* These Config Variables are only used in imap/util.c */
-char *ImapDelimChars;
+char *ImapDelimChars; ///< Config: (imap) Characters that denote separators in IMAP folders
 short ImapPipelineDepth;
 
 /**

diff --git a/maildir/mh.c b/maildir/mh.c
index 16f7312bb9b23058d05796015927b87133ba86d0..195314bea6c3c9c10a1ac915c623dafbd84541e4 100644 (file)
--- a/maildir/mh.c
+++ b/maildir/mh.c
@@ -67,7 +67,7 @@
 #endif
 
 /* These Config Variables are only used in maildir/mh.c */
-bool CheckNew;
+bool CheckNew; ///< Config: (maildir,mh) Check for new mail while the mailbox is open
 bool MaildirHeaderCacheVerify;
 bool MhPurge;
 char *MhSeqFlagged;

diff --git a/mutt/charset.c b/mutt/charset.c
index 7abeda263ca3c81ebe3249196366bc76b5e2a1ea..07049c1deedc838da2506ee880434b271e46d899 100644 (file)
--- a/mutt/charset.c
+++ b/mutt/charset.c
@@ -48,8 +48,8 @@
 #define EILSEQ EINVAL
 #endif
 
-char *AssumedCharset; /**< Config: Encoding schemes for messages without indication */
-char *Charset;        /**< Config: User's choice of character set */
+char *AssumedCharset; ///< Config: Encoding schemes for messages without indication
+char *Charset; ///< Config: Default character set for displaying text on screen
 
 /**
  * ReplacementChar - When a Unicode character can't be displayed, use this instead

diff --git a/mutt/history.c b/mutt/history.c
index b9a72158f16566dd1626ed0781a129d2396917f6..83b7e68976d34ee5b783c279097d33d03b78ba69 100644 (file)
--- a/mutt/history.c
+++ b/mutt/history.c
@@ -83,10 +83,10 @@
 #include "string2.h"
 
 /* These Config Variables are only used in history.c */
-short History;          /**< Number of history entries stored in memory */
-char *HistoryFile;      /**< File in which to store all the histories */
-bool HistoryRemoveDups; /**< Remove duplicate history entries */
-short SaveHistory; /**< Number of history entries, per category, stored on disk */
+short History; ///< Config: Number of history entries to keep in memory per category
+char *HistoryFile;      ///< Config: File to save history in
+bool HistoryRemoveDups; ///< Config: Remove duplicate entries from the history
+short SaveHistory; ///< Config: Number of history entries to save per category
 
 #define HC_FIRST HC_CMD
 

diff --git a/mutt_account.c b/mutt_account.c
index 4fda2f797a36b07d5011f4673208775e985e9b21..9f8c1ceb984d770c01e6ce57c0a83b788c793eba 100644 (file)
--- a/mutt_account.c
+++ b/mutt_account.c
@@ -38,12 +38,12 @@
 #include "options.h"
 
 /* These Config Variables are only used in mutt_account.c */
-char *ImapLogin;
-char *ImapPass;
-char *NntpPass;
-char *NntpUser;
-char *PopPass;
-char *PopUser;
+char *ImapLogin; ///< Config: (imap) Login name for the IMAP server (defaults to ImapUser)
+char *ImapPass; ///< Config: (imap) Password for the IMAP server
+char *NntpPass; ///< Config: (nntp) Password for the news server
+char *NntpUser; ///< Config: (nntp) Username for the news server
+char *PopPass;  ///< Config: (pop) Password of the POP server
+char *PopUser;  ///< Config: (pop) Username of the POP server
 char *SmtpPass;
 
 /**

diff --git a/mutt_thread.c b/mutt_thread.c
index d857c3930b87bfb471bbfa4f99c57359f5dca22f..09bee27d70799c3bb3cc9530be8657e6ed7f503d 100644 (file)
--- a/mutt_thread.c
+++ b/mutt_thread.c
@@ -43,7 +43,7 @@ bool HideMissing;
 bool HideThreadSubject;
 bool HideTopLimited;
 bool HideTopMissing;
-bool NarrowTree;
+bool NarrowTree; ///< Config: Draw a narrower thread tree in the index
 bool SortRe;
 bool StrictThreads;
 bool ThreadReceived;

diff --git a/muttlib.c b/muttlib.c
index aec9f31fff3241771963dd1cb8e8ce1246d60083..04165fbec612ce6780b93c995193d524c5b510a6 100644 (file)
--- a/muttlib.c
+++ b/muttlib.c
@@ -60,7 +60,7 @@
 #endif
 
 /* These Config Variables are only used in muttlib.c */
-struct Regex *GecosMask;
+struct Regex *GecosMask; ///< Config: Regex for parsing GECOS field of /etc/passwd
 
 static const char *xdg_env_vars[] = {
   [XDG_CONFIG_HOME] = "XDG_CONFIG_HOME",

diff --git a/mx.c b/mx.c
index 3fbb01186b7de548bdbded318895b25bd66bd2b1..d954520aa14d1ceed686d652e2f138ed3c762f6e 100644 (file)
--- a/mx.c
+++ b/mx.c
@@ -85,8 +85,8 @@
 
 /* These Config Variables are only used in mx.c */
 unsigned char CatchupNewsgroup;
-bool KeepFlagged;
-unsigned char Move;
+bool KeepFlagged; ///< Config: Don't move flagged messages from Spoolfile to Mbox
+unsigned char Move; ///< Config: Move emails from Spoolfile to Mbox when read
 char *Trash;
 
 /**

diff --git a/nntp/newsrc.c b/nntp/newsrc.c
index 7eca0ad167ce48b531d97f577131f6f151ab7a34..4304e6dbed7cc445cdf2c99c71ee6e1f8f4c15b7 100644 (file)
--- a/nntp/newsrc.c
+++ b/nntp/newsrc.c
@@ -61,8 +61,8 @@
 #endif
 
 /* These Config Variables are only used in nntp/newsrc.c */
-char *NewsCacheDir;
-char *Newsrc;
+char *NewsCacheDir; ///< Config: (nntp) Directory for cached news articles
+char *Newsrc; ///< Config: (nntp) File containing list of subscribed newsgroups
 
 struct BodyCache;
 

diff --git a/nntp/nntp.c b/nntp/nntp.c
index 0251d060e789394e1147c736f9a56282c6d402fb..94372548a734861d335c40c1f45039c1f5997b6c 100644 (file)
--- a/nntp/nntp.c
+++ b/nntp/nntp.c
@@ -67,7 +67,7 @@
 
 /* These Config Variables are only used in nntp/nntp.c */
 char *NntpAuthenticators;
-short NntpContext;
+short NntpContext; ///< Config: (nntp) Maximum number of articles to list (0 for all articles)
 bool NntpListgroup;
 bool NntpLoadDescription;
 short NntpPoll;

diff --git a/pager.c b/pager.c
index 033c82b21dbdc7c2523663502c8ed0f04c381fa1..8e1868e39463bd49fc8eab895bcab0f2ea2330d4 100644 (file)
--- a/pager.c
+++ b/pager.c
@@ -79,7 +79,7 @@
 /* These Config Variables are only used in pager.c */
 bool AllowAnsi;
 bool HeaderColorPartial;
-short PagerContext;
+short PagerContext; ///< Config: Number of lines of overlap when changing pages in the pager
 short PagerIndexLines;
 bool PagerStop;
 short SearchContext;

diff --git a/pop/pop.c b/pop/pop.c
index 60d7f054c05d9b111a103958edea9d0e31248ac2..f943823d19c33497ab6fbc17e2e96355d1e62299 100644 (file)
--- a/pop/pop.c
+++ b/pop/pop.c
@@ -66,8 +66,8 @@ struct BodyCache;
 
 /* These Config Variables are only used in pop/pop.c */
 short PopCheckinterval;
-unsigned char PopDelete;
-char *PopHost;
+unsigned char PopDelete; ///< Config: (pop) After downloading POP messages, delete them on the server
+char *PopHost; ///< Config: (pop) Url of the POP server
 bool PopLast;
 
 #ifdef USE_HCACHE

diff --git a/query.c b/query.c
index 90563a97fe5ea08d873e42bdc0db8f182d17b8ab..c31fa248b9273b796315fefe192ecb6831d38b0a 100644 (file)
--- a/query.c
+++ b/query.c
@@ -44,7 +44,7 @@
 
 /* These Config Variables are only used in query.c */
 char *QueryCommand;
-char *QueryFormat;
+char *QueryFormat; ///< Config: printf-like format string for the query menu (address book)
 
 /**
  * struct Query - An entry from an external address-book

diff --git a/recvattach.c b/recvattach.c
index bd92e34635575bf3f680257be1e4f50b892db35f..4681fbe8b1ff0073934472d50b09adc7be4b594c 100644 (file)
--- a/recvattach.c
+++ b/recvattach.c
@@ -67,7 +67,7 @@
 char *AttachSep;
 bool AttachSplit;
 bool DigestCollapse;
-char *MessageFormat;
+char *MessageFormat; ///< Config: printf-like format string for listing attached messages
 
 static void mutt_update_recvattach_menu(struct AttachCtx *actx, struct Menu *menu, bool init);
 

diff --git a/remailer.c b/remailer.c
index 631c551ddf1c2fd2e635858d702f96cc345195dc..30dbb937efffbe4404cb6ef3ada7b0bcf348ca8a 100644 (file)
--- a/remailer.c
+++ b/remailer.c
@@ -45,7 +45,7 @@
 #include "sendlib.h"
 
 /* These Config Variables are only used in remailer.c */
-char *MixEntryFormat;
+char *MixEntryFormat; ///< Config: (mixmaster) printf-like format string for the mixmaster chain
 char *Mixmaster;
 
 #define MIX_CAP_COMPRESS (1 << 0)

diff --git a/send.c b/send.c
index 0969ee07807d40993f9ba7a9342614833a9e3bcc..2f2772e2cef6c7102880bcda1aa524a67debab21 100644 (file)
--- a/send.c
+++ b/send.c
@@ -76,8 +76,8 @@ unsigned char AbortNoattach; /* forgotten attachment detector */
 struct Regex *AbortNoattachRegex;
 unsigned char AbortNosubject;
 unsigned char AbortUnmodified;
-bool AskFollowUp;
-bool AskXCommentTo;
+bool AskFollowUp; ///< Config: (nntp) Ask the user for follow-up groups before editing
+bool AskXCommentTo; ///< Config: (nntp) Ask the user for the 'X-Comment-To' field before editing
 char *ContentType;
 bool CryptAutoencrypt;
 bool CryptAutopgp;
@@ -86,20 +86,20 @@ bool CryptAutosmime;
 bool CryptReplyencrypt;
 bool CryptReplysign;
 bool CryptReplysignencrypted;
-char *EmptySubject;
-bool FastReply;
-unsigned char FccAttach;
-bool FccClear;
+char *EmptySubject; ///< Config: Subject to use when replying to an email with none
+bool FastReply; ///< Config: Don't prompt for the recipients and subject when replying/forwarding
+unsigned char FccAttach; ///< Config: Save send message with all their attachments
+bool FccClear; ///< Config: Save sent messages unencrypted and unsigned
 bool FollowupTo;
 char *ForwardAttributionIntro;
 char *ForwardAttributionTrailer;
 unsigned char ForwardEdit;
-char *ForwardFormat;
+char *ForwardFormat; ///< Config: printf-like format string to control the subject when forwarding a message
 bool ForwardReferences;
 bool Hdrs;
 unsigned char HonorFollowupTo;
 bool IgnoreListReplyTo;
-unsigned char Include;
+unsigned char Include; ///< Config: Include a copy of the email that's being replied to
 bool Metoo;
 bool NmRecord;
 bool PgpReplyinline;

diff --git a/sendlib.c b/sendlib.c
index 3caab5dd7bef11579c311e19b59ca523d8fdad91..8bc993a7cc2bb4ae7a749c2ce3e91df7addb97ec 100644 (file)
--- a/sendlib.c
+++ b/sendlib.c
@@ -73,7 +73,7 @@ bool BounceDelivered;
 bool EncodeFrom;
 bool ForwardDecrypt;
 bool HiddenHost;
-char *Inews;
+char *Inews; ///< Config: (nntp) External command to post news articles
 bool MimeForwardDecode;
 bool MimeSubject; /**< encode subject line with RFC2047 */
 char *MimeTypeQueryCommand;
@@ -82,7 +82,7 @@ char *Sendmail;
 short SendmailWait;
 bool Use8bitmime;
 bool UseEnvelopeFrom;
-bool UserAgent;
+bool UserAgent; ///< Config: Add a 'User-Agent' head to outgoing mail
 short WrapHeaders;
 
 /**

diff --git a/sidebar.c b/sidebar.c
index 3f60207a5eea892d60616bb37299fd6ca700237f..659962a269a1423a84f30d3ea5f96bb45d081633 100644 (file)
--- a/sidebar.c
+++ b/sidebar.c
@@ -58,7 +58,7 @@ short SidebarComponentDepth;
 char *SidebarDelimChars;
 char *SidebarDividerChar;
 bool SidebarFolderIndent;
-char *SidebarFormat;
+char *SidebarFormat; ///< Config: (sidebar) printf-like format string for the sidebar panel
 char *SidebarIndentString;
 bool SidebarNewMailOnly;
 bool SidebarNextNewWrap;