doxy: doc config items

diff --git a/email/header.h b/email/header.h
index b1a90a8beb63f0da3e8f4312ed2a9d531d5af5d1..948ca859a1992a8936b52766f9d3090e6e8bec54 100644 (file)
--- a/email/header.h
+++ b/email/header.h
@@ -32,7 +32,7 @@
 /**
  * struct Header - The header/envelope of an email
  */
-struct Header ///< Config: Include the message headers in the reply email (Weed applies)
+struct Header
 {
   unsigned int security : 12; /**< bit 0-8: flags, bit 9,10: application.
                                  see: mutt_crypt.h pgplib.h, smime.h */

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

diff --git a/globals.h b/globals.h
index cbbf2e87c4540ae5d7667fae2ab56a81cefde6c9..9369981768db56650c730348853d11a575eb0265 100644 (file)
--- a/globals.h
+++ b/globals.h
@@ -138,7 +138,7 @@ WHERE char *Pager;
 WHERE char *PagerFormat; ///< Config: printf-like format string for the pager's status bar
 WHERE char *Postponed;
 WHERE char *IndentString; ///< Config: String used to indent 'reply' text
-WHERE char *PrintCommand;
+WHERE char *PrintCommand; ///< Config: External command to print a message
 WHERE char *NewMailCommand; ///< Config: External command to run when new mail arrives
 WHERE char *Realname;
 WHERE char *Shell;
@@ -222,7 +222,7 @@ WHERE bool ForwardQuote;
 WHERE bool HeaderCacheCompress;
 #endif /* HAVE_QDBM */
 #endif
-WHERE bool Header;
+WHERE bool Header; ///< Config: Include the message headers in the reply email (Weed applies)
 WHERE bool Help; ///< Config: Display a help line with common key bindings
 #ifdef USE_IMAP
 WHERE bool ImapCheckSubscribed; ///< Config: (imap) Ask the IMAP server for a list of subscribed folders

diff --git a/ncrypt/pgpinvoke.c b/ncrypt/pgpinvoke.c
index 71cdff4006c0ed3dea5c1d02457a975763a97b41..372f6cd427076b9bdeac6ac711f4e62766ec19f7 100644 (file)
--- a/ncrypt/pgpinvoke.c
+++ b/ncrypt/pgpinvoke.c
@@ -50,19 +50,19 @@
 #include "protos.h"
 
 /* These Config Variables are only used in ncrypt/pgpinvoke.c */
-char *PgpClearsignCommand;
-char *PgpDecodeCommand;
-char *PgpDecryptCommand;
-char *PgpEncryptOnlyCommand;
-char *PgpEncryptSignCommand;
-char *PgpExportCommand;
-char *PgpGetkeysCommand;
-char *PgpImportCommand;
-char *PgpListPubringCommand;
-char *PgpListSecringCommand;
-char *PgpSignCommand;
-char *PgpVerifyCommand;
-char *PgpVerifyKeyCommand;
+char *PgpClearsignCommand; ///< Config: (pgp) External command to inline-sign a messsage
+char *PgpDecodeCommand; ///< Config: (pgp) External command to decode a PGP attachment
+char *PgpDecryptCommand; ///< Config: (pgp) External command to decrypt a PGP message
+char *PgpEncryptOnlyCommand; ///< Config: (pgp) External command to encrypt, but not sign a message
+char *PgpEncryptSignCommand; ///< Config: (pgp) External command to encrypt and sign a message
+char *PgpExportCommand; ///< Config: (pgp) External command to export a public key from the user's keyring
+char *PgpGetkeysCommand; ///< Config: (pgp) External command to download a key for an email address
+char *PgpImportCommand; ///< Config: (pgp) External command to import a key into the user's keyring
+char *PgpListPubringCommand; ///< Config: (pgp) External command to list the public keys in a user's keyring
+char *PgpListSecringCommand; ///< Config: (pgp) External command to list the private keys in a user's keyring
+char *PgpSignCommand; ///< Config: (pgp) External command to create a detached PGP signature
+char *PgpVerifyCommand; ///< Config: (pgp) External command to verify PGP signatures
+char *PgpVerifyKeyCommand; ///< Config: (pgp) External command to verify key information
 
 /**
  * struct PgpCommandContext - Data for a PGP command

diff --git a/ncrypt/smime.c b/ncrypt/smime.c
index f394797d9fa462eb1d6222086c6dd819aff08928..577a45eab3381718a9e019ddc63695211ad2bbeb 100644 (file)
--- a/ncrypt/smime.c
+++ b/ncrypt/smime.c
@@ -66,20 +66,20 @@
 bool SmimeAskCertLabel;
 char *SmimeCaLocation;
 char *SmimeCertificates;
-char *SmimeDecryptCommand;
+char *SmimeDecryptCommand;  ///< Config: (smime) External command to decrypt an SMIME message
 bool SmimeDecryptUseDefaultKey;
-char *SmimeEncryptCommand;
-char *SmimeGetCertCommand;
-char *SmimeGetCertEmailCommand;
-char *SmimeGetSignerCertCommand;
-char *SmimeImportCertCommand;
+char *SmimeEncryptCommand;  ///< Config: (smime) External command to encrypt a message
+char *SmimeGetCertCommand;  ///< Config: (smime) External command to extract a certificate from a message
+char *SmimeGetCertEmailCommand;  ///< Config: (smime) External command to get a certificate for an email
+char *SmimeGetSignerCertCommand;  ///< Config: (smime) External command to extract a certificate from an email
+char *SmimeImportCertCommand;  ///< Config: (smime) External command to import a certificate
 char *SmimeKeys;
-char *SmimePk7outCommand;
-char *SmimeSignCommand;
+char *SmimePk7outCommand;  ///< Config: (smime) External command to extract a public certificate
+char *SmimeSignCommand;  ///< Config: (smime) External command to sign a message
 char *SmimeSignDigestAlg;
 long SmimeTimeout;
-char *SmimeVerifyCommand;
-char *SmimeVerifyOpaqueCommand;
+char *SmimeVerifyCommand;  ///< Config: (smime) External command to verify a signed message
+char *SmimeVerifyOpaqueCommand;  ///< Config: (smime) External command to verify a signature
 
 /**
  * struct SmimeCommandContext - Data for a SIME command

diff --git a/query.c b/query.c
index c31fa248b9273b796315fefe192ecb6831d38b0a..28e973a1790d62707577cd87a7a6f01bedd3254f 100644 (file)
--- a/query.c
+++ b/query.c
@@ -43,7 +43,7 @@
 #include "send.h"
 
 /* These Config Variables are only used in query.c */
-char *QueryCommand;
+char *QueryCommand; ///< Config: External command to query and external address book
 char *QueryFormat; ///< Config: printf-like format string for the query menu (address book)
 
 /**

diff --git a/send.c b/send.c
index 2f2772e2cef6c7102880bcda1aa524a67debab21..c492455f9558ac483a849e6c48f0bce75401c0aa 100644 (file)
--- a/send.c
+++ b/send.c
@@ -78,7 +78,7 @@ unsigned char AbortNosubject;
 unsigned char AbortUnmodified;
 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;
+char *ContentType; ///< Config: Default "Content-Type" for newly composed messages
 bool CryptAutoencrypt;
 bool CryptAutopgp;
 bool CryptAutosign;

diff --git a/sendlib.c b/sendlib.c
index 8bc993a7cc2bb4ae7a749c2ce3e91df7addb97ec..b6ba153eda90c963701d726250df014c28ebb017 100644 (file)
--- a/sendlib.c
+++ b/sendlib.c
@@ -75,8 +75,8 @@ bool ForwardDecrypt;
 bool HiddenHost;
 char *Inews; ///< Config: (nntp) External command to post news articles
 bool MimeForwardDecode;
-bool MimeSubject; /**< encode subject line with RFC2047 */
-char *MimeTypeQueryCommand;
+bool MimeSubject; ///< encode subject line with RFC2047
+char *MimeTypeQueryCommand; ///< Config: External command to determine the MIME type of an attachment
 bool MimeTypeQueryFirst;
 char *Sendmail;
 short SendmailWait;