doxy: doc globals

diff --git a/account.h b/account.h
index 7e5459317cba6a7eaf5e12fb4b4deb53f29720e8..d8e1b370c5131f4ffb730804fc315ec4d7f2d02d 100644 (file)
--- a/account.h
+++ b/account.h
@@ -44,7 +44,7 @@ struct Account
 
 TAILQ_HEAD(AccountList, Account);
 
-extern struct AccountList AllAccounts;
+extern struct AccountList AllAccounts; ///< List of all Accounts
 
 struct Account *account_new(void);
 void            account_remove_mailbox(struct Account *a, struct Mailbox *m);

diff --git a/curs_lib.h b/curs_lib.h
index 1b152897a07bca13032c63ea9bcde2116e96ffbc..15173c1eb52e1975d9d6860f31397991bf2b1e4f 100644 (file)
--- a/curs_lib.h
+++ b/curs_lib.h
@@ -35,7 +35,7 @@ struct Pager;
 /* These Config Variables are only used in curs_lib.c */
 extern bool MetaKey; /**< interpret ALT-x as ESC-x */
 
-extern int MuttGetchTimeout;
+extern int MuttGetchTimeout; ///< Timeout in ms for mutt_getch()
 
 /* For mutt_simple_format() justifications */
 #define FMT_LEFT   -1

diff --git a/email/email_globals.h b/email/email_globals.h
index 0a8fbc97b63b987f611a8870f667bfc79bf941dc..e0a1c21c830821ac4b0a30c10d47461fa431aec4 100644 (file)
--- a/email/email_globals.h
+++ b/email/email_globals.h
@@ -34,9 +34,9 @@ extern char *              SpamSeparator;
 extern bool                Weed;
 
 /* Global variables */
-extern struct ListHead    Ignore;
-extern struct RegexList   NoSpamList;
-extern struct ReplaceList SpamList;
-extern struct ListHead    UnIgnore;
+extern struct ListHead Ignore;      ///< List of header patterns to ignore
+extern struct RegexList NoSpamList; ///< List of regexes to whitelist non-spam emails
+extern struct ReplaceList SpamList; ///< List of regexes and patterns to match spam emails
+extern struct ListHead UnIgnore;    ///< List of header patterns to unignore (see)
 
 #endif /* MUTT_EMAIL_EMAIL_GLOBALS_H */

diff --git a/globals.h b/globals.h
index d87d7ddbd22a078153aa6e131d10d20f7a7b74c8..4c8a874c85dc7386fda1580284f620d27765f960 100644 (file)
--- a/globals.h
+++ b/globals.h
@@ -36,63 +36,63 @@
 #include "sort.h"
 #endif /* MAIN_C */
 
-WHERE struct ConfigSet *Config;
+WHERE struct ConfigSet *Config; ///< Wrapper around the user's config settings
 
 WHERE struct Context *Context;
 
-WHERE bool ErrorBufMessage;
-WHERE char ErrorBuf[STRING];
-WHERE char AttachmentMarker[STRING];
+WHERE bool ErrorBufMessage;          ///< true if the last message was an error
+WHERE char ErrorBuf[STRING];         ///< Copy of the last error message
+WHERE char AttachmentMarker[STRING]; ///< Unique ANSI string to mark PGP messages in an email
 
-WHERE char *HomeDir;
-WHERE char *ShortHostname;
+WHERE char *HomeDir;       ///< User's home directory
+WHERE char *ShortHostname; ///< Short version of the hostname
 
-WHERE char *Username;
+WHERE char *Username; ///< User's login name
 
-WHERE char *CurrentFolder;
-WHERE char *LastFolder;
+WHERE char *CurrentFolder; ///< Currently selected mailbox
+WHERE char *LastFolder;    ///< Previously selected mailbox
 
 extern const char *GitVer;
 
-WHERE struct Hash *Groups;
-WHERE struct Hash *ReverseAliases;
-WHERE struct Hash *TagFormats;
+WHERE struct Hash *Groups;         ///< Hash table of alias groups (name -> Group)
+WHERE struct Hash *ReverseAliases; ///< Hash table of aliases (email address -> alias)
+WHERE struct Hash *TagFormats;     ///< Hash table of tag-formats (tag -> format string)
 
 /* Lists of strings */
-WHERE struct ListHead AlternativeOrderList INITVAL(STAILQ_HEAD_INITIALIZER(AlternativeOrderList));
-WHERE struct ListHead AutoViewList INITVAL(STAILQ_HEAD_INITIALIZER(AutoViewList));
-WHERE struct ListHead HeaderOrderList INITVAL(STAILQ_HEAD_INITIALIZER(HeaderOrderList));
-WHERE struct ListHead MailToAllow INITVAL(STAILQ_HEAD_INITIALIZER(MailToAllow));
-WHERE struct ListHead MimeLookupList INITVAL(STAILQ_HEAD_INITIALIZER(MimeLookupList));
-WHERE struct ListHead Muttrc INITVAL(STAILQ_HEAD_INITIALIZER(Muttrc));
+WHERE struct ListHead AlternativeOrderList INITVAL(STAILQ_HEAD_INITIALIZER(AlternativeOrderList)); ///< List of preferred mime types to display
+WHERE struct ListHead AutoViewList INITVAL(STAILQ_HEAD_INITIALIZER(AutoViewList));                 ///< List of mime types to auto view
+WHERE struct ListHead HeaderOrderList INITVAL(STAILQ_HEAD_INITIALIZER(HeaderOrderList));           ///< List of header fields in the order they should be displayed
+WHERE struct ListHead MailToAllow INITVAL(STAILQ_HEAD_INITIALIZER(MailToAllow));                   ///< List of permitted fields in a mailto: uri
+WHERE struct ListHead MimeLookupList INITVAL(STAILQ_HEAD_INITIALIZER(MimeLookupList));             ///< List of mime types that that shouldn't use the mailcap entry
+WHERE struct ListHead Muttrc INITVAL(STAILQ_HEAD_INITIALIZER(Muttrc));                             ///< List of config files to read
 #ifdef USE_SIDEBAR
-WHERE struct ListHead SidebarWhitelist INITVAL(STAILQ_HEAD_INITIALIZER(SidebarWhitelist));
+WHERE struct ListHead SidebarWhitelist INITVAL(STAILQ_HEAD_INITIALIZER(SidebarWhitelist));         ///< List of mailboxes to alway display in the sidebar
 #endif
-WHERE struct ListHead TempAttachmentsList INITVAL(STAILQ_HEAD_INITIALIZER(TempAttachmentsList));
-WHERE struct ListHead UserHeader INITVAL(STAILQ_HEAD_INITIALIZER(UserHeader));
+WHERE struct ListHead TempAttachmentsList INITVAL(STAILQ_HEAD_INITIALIZER(TempAttachmentsList));   ///< List of temporary files for displaying attachments
+WHERE struct ListHead UserHeader INITVAL(STAILQ_HEAD_INITIALIZER(UserHeader));                     ///< List of custom headers to add to outgoing emails
 
 /* Lists of AttachMatch */
-WHERE struct ListHead AttachAllow INITVAL(STAILQ_HEAD_INITIALIZER(AttachAllow));
-WHERE struct ListHead AttachExclude INITVAL(STAILQ_HEAD_INITIALIZER(AttachExclude));
-WHERE struct ListHead InlineAllow INITVAL(STAILQ_HEAD_INITIALIZER(InlineAllow));
-WHERE struct ListHead InlineExclude INITVAL(STAILQ_HEAD_INITIALIZER(InlineExclude));
-
-WHERE struct RegexList Alternates INITVAL(STAILQ_HEAD_INITIALIZER(Alternates));
-WHERE struct RegexList UnAlternates INITVAL(STAILQ_HEAD_INITIALIZER(UnAlternates));
-WHERE struct RegexList MailLists INITVAL(STAILQ_HEAD_INITIALIZER(MailLists));
-WHERE struct RegexList UnMailLists INITVAL(STAILQ_HEAD_INITIALIZER(UnMailLists));
-WHERE struct RegexList SubscribedLists INITVAL(STAILQ_HEAD_INITIALIZER(SubscribedLists));
-WHERE struct RegexList UnSubscribedLists INITVAL(STAILQ_HEAD_INITIALIZER(UnSubscribedLists));
-WHERE struct ReplaceList SubjectRegexList INITVAL(STAILQ_HEAD_INITIALIZER(SubjectRegexList));
+WHERE struct ListHead AttachAllow INITVAL(STAILQ_HEAD_INITIALIZER(AttachAllow));     ///< List of attachment types to be counted
+WHERE struct ListHead AttachExclude INITVAL(STAILQ_HEAD_INITIALIZER(AttachExclude)); ///< List of attachment types to be ignored
+WHERE struct ListHead InlineAllow INITVAL(STAILQ_HEAD_INITIALIZER(InlineAllow));     ///< List of inline types to counted
+WHERE struct ListHead InlineExclude INITVAL(STAILQ_HEAD_INITIALIZER(InlineExclude)); ///< List of inline types to ignore
+
+WHERE struct RegexList Alternates INITVAL(STAILQ_HEAD_INITIALIZER(Alternates));               ///< List of regexes to match the user's alternate email addresses
+WHERE struct RegexList UnAlternates INITVAL(STAILQ_HEAD_INITIALIZER(UnAlternates));           ///< List of regexes to blacklist false matches in Alternates
+WHERE struct RegexList MailLists INITVAL(STAILQ_HEAD_INITIALIZER(MailLists));                 ///< List of regexes to match mailing lists
+WHERE struct RegexList UnMailLists INITVAL(STAILQ_HEAD_INITIALIZER(UnMailLists));             ///< List of regexes to blacklist false matches in MailLists
+WHERE struct RegexList SubscribedLists INITVAL(STAILQ_HEAD_INITIALIZER(SubscribedLists));     ///< List of regexes to match subscribed mailing lists
+WHERE struct RegexList UnSubscribedLists INITVAL(STAILQ_HEAD_INITIALIZER(UnSubscribedLists)); ///< List of regexes to blacklist false matches in SubscribedLists
+WHERE struct ReplaceList SubjectRegexList INITVAL(STAILQ_HEAD_INITIALIZER(SubjectRegexList)); ///< List of regexes to tidy the view of the email's subject
 
 /* flags for received signals */
-WHERE SIG_ATOMIC_VOLATILE_T SigAlrm;
-WHERE SIG_ATOMIC_VOLATILE_T SigInt;
-WHERE SIG_ATOMIC_VOLATILE_T SigWinch;
+WHERE SIG_ATOMIC_VOLATILE_T SigAlrm;  ///< true after SIGALRM is received
+WHERE SIG_ATOMIC_VOLATILE_T SigInt;   ///< true after SIGINT is received
+WHERE SIG_ATOMIC_VOLATILE_T SigWinch; ///< true after SIGWINCH is received
 
-WHERE int CurrentMenu;
+WHERE int CurrentMenu; ///< Current Menu, e.g. #MENU_PAGER
 
-WHERE struct AliasList Aliases INITVAL(TAILQ_HEAD_INITIALIZER(Aliases));
+WHERE struct AliasList Aliases INITVAL(TAILQ_HEAD_INITIALIZER(Aliases)); ///< List of all the user's email aliases
 
 /* All the variables below are backing for config items */
 

diff --git a/keymap.h b/keymap.h
index 6b6ecbb429266cada9ccdec3a4cf0ad681182cca..2f419b17dcc0276818f7f8f0e737137853cece84 100644 (file)
--- a/keymap.h
+++ b/keymap.h
@@ -86,11 +86,9 @@ enum MenuTypes
   MENU_MAX,
 };
 
-/* the keymap trees (one for each menu) */
-extern struct Keymap *Keymaps[];
+extern struct Keymap *Keymaps[]; ///< Array of Keymap keybindings, one for each Menu
 
-/* dokey() records the last real key pressed  */
-extern int LastKey;
+extern int LastKey; ///< Last real key pressed, recorded by dokey()
 
 extern const struct Mapping Menus[];
 

diff --git a/mailbox.h b/mailbox.h
index d96555b5b5eb524e44ddcb456cfda3b843bd7468..2a613fd4c6e82c2e26adedeaecb49569d20ee26e 100644 (file)
--- a/mailbox.h
+++ b/mailbox.h
@@ -142,7 +142,7 @@ struct MailboxNode
 
 STAILQ_HEAD(MailboxList, MailboxNode);
 
-extern struct MailboxList AllMailboxes;
+extern struct MailboxList AllMailboxes; ///< List of all Mailboxes
 
 struct Mailbox *mailbox_new(void);
 void            mailbox_free(struct Mailbox **m);

diff --git a/monitor.h b/monitor.h
index e5e365edba19989a1b0d47ec98de0422a2f7ca30..d24e813ff20a99fbe3bff6375e9f9c5fd876136c 100644 (file)
--- a/monitor.h
+++ b/monitor.h
@@ -23,8 +23,8 @@
 #ifndef MUTT_MONITOR_H
 #define MUTT_MONITOR_H
 
-extern int MonitorFilesChanged;
-extern int MonitorContextChanged;
+extern int MonitorFilesChanged;   ///< true after a monitored file has changed
+extern int MonitorContextChanged; ///< true after the current mailbox has changed
 
 struct Mailbox;
 

diff --git a/mutt_curses.h b/mutt_curses.h
index 18714a3c8d1b52758952e8f9cbdcb7a8d5340ead..d8e8158fcf0f014d6ac7c32d9834df4d160b3ab0 100644 (file)
--- a/mutt_curses.h
+++ b/mutt_curses.h
@@ -189,18 +189,18 @@ struct ColorLine
 };
 STAILQ_HEAD(ColorLineHead, ColorLine);
 
-extern int *ColorQuote;
-extern int ColorQuoteUsed;
-extern int ColorDefs[];
-extern struct ColorLineHead ColorHdrList;
-extern struct ColorLineHead ColorBodyList;
-extern struct ColorLineHead ColorAttachList;
-extern struct ColorLineHead ColorStatusList;
-extern struct ColorLineHead ColorIndexList;
-extern struct ColorLineHead ColorIndexAuthorList;
-extern struct ColorLineHead ColorIndexFlagsList;
-extern struct ColorLineHead ColorIndexSubjectList;
-extern struct ColorLineHead ColorIndexTagList;
+extern int *ColorQuote;                            ///< Array of colours for quoted email text
+extern int ColorQuoteUsed;                         ///< Number of colours for quoted email text
+extern int ColorDefs[];                            ///< Array of all fixed colours, see enum ColorId
+extern struct ColorLineHead ColorHdrList;          ///< List of colours applied to the email headers
+extern struct ColorLineHead ColorBodyList;         ///< List of colours applied to the email body
+extern struct ColorLineHead ColorAttachList;       ///< List of colours applied to the attachment headers
+extern struct ColorLineHead ColorStatusList;       ///< List of colours applied to the status bar
+extern struct ColorLineHead ColorIndexList;        ///< List of default colours applied to the index
+extern struct ColorLineHead ColorIndexAuthorList;  ///< List of colours applied to the author in the index
+extern struct ColorLineHead ColorIndexFlagsList;   ///< List of colours applied to the flags in the index
+extern struct ColorLineHead ColorIndexSubjectList; ///< List of colours applied to the subject in the index
+extern struct ColorLineHead ColorIndexTagList;     ///< List of colours applied to tags in the index
 
 /* If the system has bkgdset() use it rather than attrset() so that the clr*()
  * functions will properly set the background attributes all the way to the

diff --git a/mutt_logging.h b/mutt_logging.h
index e816c5d59a1ecaefe8ee5cd100a7962eba15faab..6eaf0b307abd277fd3da08e5440e56c82490e5ea 100644 (file)
--- a/mutt_logging.h
+++ b/mutt_logging.h
@@ -29,7 +29,6 @@
 
 extern short DebugLevel;
 extern char *DebugFile;
-extern bool LogAllowDebugSet;
 
 int log_disp_curses(time_t stamp, const char *file, int line, const char *function, int level, ...);
 

diff --git a/myvar.h b/myvar.h
index d3b81f3f705faee533c93418d8d9b8b875a10698..28b50f1845cbd6d5e94e975d701b570269d411e6 100644 (file)
--- a/myvar.h
+++ b/myvar.h
@@ -36,7 +36,7 @@ struct MyVar
 };
 TAILQ_HEAD(MyVarHead, MyVar);
 
-extern struct MyVarHead MyVars;
+extern struct MyVarHead MyVars; ///< List of all the user's custom config variables
 
 void        myvar_del(const char *var);
 const char *myvar_get(const char *var);

diff --git a/ncrypt/ncrypt.h b/ncrypt/ncrypt.h
index a2eacd16d52cae5423c5cfe438df6e722132f48d..3d5bc38fa3912ea5dee58923c5a1b4082635d4d3 100644 (file)
--- a/ncrypt/ncrypt.h
+++ b/ncrypt/ncrypt.h
@@ -60,12 +60,12 @@ struct State;
 
 /* These Config Variables are only used in ncrypt/crypt.c */
 extern bool          CryptTimestamp;
-extern unsigned char PgpEncryptSelf;
-extern unsigned char PgpMimeAuto; /* ask to revert to PGP/MIME when inline fails */
+extern unsigned char PgpEncryptSelf; ///< Deprecated, see PgpSelfEncrypt
+extern unsigned char PgpMimeAuto;
 extern bool          PgpRetainableSigs;
 extern bool          PgpSelfEncrypt;
 extern bool          PgpStrictEnc;
-extern unsigned char SmimeEncryptSelf;
+extern unsigned char SmimeEncryptSelf; ///< Deprecated, see SmimeSelfEncrypt
 extern bool          SmimeSelfEncrypt;
 
 /* These Config Variables are only used in ncrypt/cryptglue.c */

diff --git a/nntp/nntp.h b/nntp/nntp.h
index 2d6b7244409601280b40f662721a32f88f71a000..ad63b6d50d83f95b1f05d8060d0ca8c0f4f4b66e 100644 (file)
--- a/nntp/nntp.h
+++ b/nntp/nntp.h
@@ -61,7 +61,7 @@ extern bool  ShowNewNews;
 extern char *NewsCacheDir;
 extern char *Newsrc;
 
-extern struct NntpAccountData *CurrentNewsSrv;
+extern struct NntpAccountData *CurrentNewsSrv; ///< Current NNTP news server
 extern struct MxOps MxNntpOps;
 
 /* article number type and format */