From: Richard Russon Date: Sun, 5 Aug 2018 21:56:42 +0000 (+0100) Subject: doxy: doc config items X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=966b68f7ad2a8bd7446b8f18f52beddb4c7330d2;p=neomutt doxy: doc config items --- diff --git a/commands.c b/commands.c index 579d1b595..3cc63a968 100644 --- a/commands.c +++ b/commands.c @@ -69,7 +69,7 @@ #endif /* These Config Variables are only used in commands.c */ -unsigned char CryptVerifySig; /* verify PGP signatures */ +unsigned char CryptVerifySig; /* verify PGP signatures */ ///< Config: Verify PGP or SMIME signatures 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 diff --git a/config/address.c b/config/address.c index 019218b0c..2477fff84 100644 --- a/config/address.c +++ b/config/address.c @@ -202,7 +202,7 @@ static intptr_t address_native_get(const struct ConfigSet *cs, void *var, } /** - * address_reset - Reset an Address to its initial value - Implements ::cst_regex + * address_reset - Reset an Address to its initial value - Implements ::cst_reset */ static int address_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/bool.c b/config/bool.c index fe0975da5..fe8e1eeff 100644 --- a/config/bool.c +++ b/config/bool.c @@ -165,7 +165,7 @@ static intptr_t bool_native_get(const struct ConfigSet *cs, void *var, } /** - * bool_reset - Reset a Bool to its initial value - Implements ::cst_regex + * bool_reset - Reset a Bool to its initial value - Implements ::cst_reset */ static int bool_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/long.c b/config/long.c index 27f713afb..33ae350a6 100644 --- a/config/long.c +++ b/config/long.c @@ -143,7 +143,7 @@ static intptr_t long_native_get(const struct ConfigSet *cs, void *var, } /** - * long_reset - Reset a Long to its initial value - Implements ::cst_regex + * long_reset - Reset a Long to its initial value - Implements ::cst_reset */ static int long_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/magic.c b/config/magic.c index 2e1651bfc..85c5176c7 100644 --- a/config/magic.c +++ b/config/magic.c @@ -167,7 +167,7 @@ static intptr_t magic_native_get(const struct ConfigSet *cs, void *var, } /** - * magic_reset - Reset a Mailbox Magic to its initial value - Implements ::cst_regex + * magic_reset - Reset a Mailbox Magic to its initial value - Implements ::cst_reset */ static int magic_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/mbtable.c b/config/mbtable.c index b48dba9b4..7641bb431 100644 --- a/config/mbtable.c +++ b/config/mbtable.c @@ -244,7 +244,7 @@ static intptr_t mbtable_native_get(const struct ConfigSet *cs, void *var, } /** - * mbtable_reset - Reset an MbTable to its initial value - Implements ::cst_regex + * mbtable_reset - Reset an MbTable to its initial value - Implements ::cst_reset */ static int mbtable_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/number.c b/config/number.c index 81a598cce..3de938cf2 100644 --- a/config/number.c +++ b/config/number.c @@ -162,7 +162,7 @@ static intptr_t number_native_get(const struct ConfigSet *cs, void *var, } /** - * number_reset - Reset a Number to its initial value - Implements ::cst_regex + * number_reset - Reset a Number to its initial value - Implements ::cst_reset */ static int number_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/path.c b/config/path.c index 10976b178..0ef48f78f 100644 --- a/config/path.c +++ b/config/path.c @@ -199,7 +199,7 @@ static intptr_t path_native_get(const struct ConfigSet *cs, void *var, } /** - * path_reset - Reset a Path to its initial value - Implements ::cst_regex + * path_reset - Reset a Path to its initial value - Implements ::cst_reset */ static int path_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/quad.c b/config/quad.c index 5bbf8c515..aa43cbc06 100644 --- a/config/quad.c +++ b/config/quad.c @@ -164,7 +164,7 @@ static intptr_t quad_native_get(const struct ConfigSet *cs, void *var, } /** - * quad_reset - Reset a Quad-option to its initial value - Implements ::cst_regex + * quad_reset - Reset a Quad-option to its initial value - Implements ::cst_reset */ static int quad_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/regex.c b/config/regex.c index 3f761b321..6e8915a3a 100644 --- a/config/regex.c +++ b/config/regex.c @@ -204,7 +204,7 @@ static intptr_t regex_native_get(const struct ConfigSet *cs, void *var, } /** - * regex_reset - Reset a Regex to its initial value - Implements ::cst_regex + * regex_reset - Reset a Regex to its initial value - Implements ::cst_reset */ static int regex_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/sort.c b/config/sort.c index ced454d10..0d16e4e98 100644 --- a/config/sort.c +++ b/config/sort.c @@ -351,7 +351,7 @@ static intptr_t sort_native_get(const struct ConfigSet *cs, void *var, } /** - * sort_reset - Reset a Sort to its initial value - Implements ::cst_regex + * sort_reset - Reset a Sort to its initial value - Implements ::cst_reset */ static int sort_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/config/string.c b/config/string.c index 4a44d7ced..9019866ac 100644 --- a/config/string.c +++ b/config/string.c @@ -200,7 +200,7 @@ static intptr_t string_native_get(const struct ConfigSet *cs, void *var, } /** - * string_reset - Reset a String to its initial value - Implements ::cst_regex + * string_reset - Reset a String to its initial value - Implements ::cst_reset */ static int string_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) diff --git a/curs_main.c b/curs_main.c index 9a56ce8c8..e5be2c497 100644 --- a/curs_main.c +++ b/curs_main.c @@ -92,7 +92,7 @@ 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 PgpAutoDecode; ///< Config: Automatically decrypt PGP messages bool UncollapseJump; ///< Config: When opening a thread, jump to the next unread message bool UncollapseNew; ///< Config: Open collapsed threads when new mail arrives diff --git a/globals.h b/globals.h index 09a778633..ad114c744 100644 --- a/globals.h +++ b/globals.h @@ -167,14 +167,14 @@ WHERE short ImapPollTimeout; #endif /* -- formerly in pgp.h -- */ -WHERE char *PgpDefaultKey; -WHERE char *PgpSignAs; +WHERE char *PgpDefaultKey; ///< Config: Default key to use for PGP operations +WHERE char *PgpSignAs; ///< Config: Use this alternative key for signing messages WHERE char *PgpEntryFormat; ///< Config: printf-like format string for the PGP key selection menu /* -- formerly in smime.h -- */ -WHERE char *SmimeDefaultKey; -WHERE char *SmimeSignAs; -WHERE char *SmimeEncryptWith; +WHERE char *SmimeDefaultKey; ///< Config: Default key for SMIME operations +WHERE char *SmimeSignAs; ///< Config: Use this alternative key for signing messages +WHERE char *SmimeEncryptWith; ///< Config: Algorithm for encryption #ifdef USE_NOTMUCH WHERE int NmQueryWindowDuration; @@ -265,17 +265,17 @@ WHERE bool WaitKey; ///< Config: Prompt to press a key after running external c WHERE bool WrapSearch; WHERE bool WriteBcc; /**< write out a bcc header? */ -WHERE bool CryptUsePka; +WHERE bool CryptUsePka; ///< Config: Use GPGME to use PKA (lookup PGP keys using DNS) /* PGP options */ -WHERE bool CryptConfirmhook; -WHERE bool CryptOpportunisticEncrypt; -WHERE bool SmimeIsDefault; -WHERE bool PgpIgnoreSubkeys; -WHERE bool PgpLongIds; -WHERE bool PgpShowUnusable; -WHERE bool PgpAutoinline; +WHERE bool CryptConfirmhook; ///< Config: Prompt the user to confirm keys before use +WHERE bool CryptOpportunisticEncrypt; ///< Config: Enable encryption when the recipient's key is available +WHERE bool SmimeIsDefault; ///< Config: Use SMIME rather than PGP by default +WHERE bool PgpIgnoreSubkeys; ///< Config: Only use the principal PGP key +WHERE bool PgpLongIds; ///< Config: Display long PGP key IDs to the user +WHERE bool PgpShowUnusable; ///< Config: Show non-usable keys in the key selection +WHERE bool PgpAutoinline; ///< Config: Use old-style inline PGP messages (not recommended) /* news options */ diff --git a/ncrypt/crypt.c b/ncrypt/crypt.c index 38b4ff3a9..53eb35483 100644 --- a/ncrypt/crypt.c +++ b/ncrypt/crypt.c @@ -59,14 +59,14 @@ #include "state.h" /* These Config Variables are only used in ncrypt/crypt.c */ -bool CryptTimestamp; +bool CryptTimestamp; ///< Config: Add a timestamp to PGP or SMIME output to prevent spoofing unsigned char PgpEncryptSelf; -unsigned char PgpMimeAuto; /* ask to revert to PGP/MIME when inline fails */ -bool PgpRetainableSigs; -bool PgpSelfEncrypt; -bool PgpStrictEnc; +unsigned char PgpMimeAuto; /* ask to revert to PGP/MIME when inline fails */ ///< Config: Prompt the user to use MIME if inline PGP fails +bool PgpRetainableSigs; ///< Config: Create nested multipart/signed or encrypted messages +bool PgpSelfEncrypt; ///< Config: Encrypted messages will also be encrypted to PgpDefaultKey too +bool PgpStrictEnc; ///< Config: Encode PGP signed messages with quoted-printable (don't unset) unsigned char SmimeEncryptSelf; -bool SmimeSelfEncrypt; +bool SmimeSelfEncrypt; ///< Config: Encrypted messages will also be encrypt to SmimeDefaultKey too /** * crypt_current_time - Print the current time diff --git a/ncrypt/cryptglue.c b/ncrypt/cryptglue.c index b627de140..aa3ad8851 100644 --- a/ncrypt/cryptglue.c +++ b/ncrypt/cryptglue.c @@ -50,7 +50,7 @@ struct Header; struct State; /* These Config Variables are only used in ncrypt/cryptglue.c */ -bool CryptUseGpgme; +bool CryptUseGpgme; ///< Config: Use GPGME crypto backend #ifdef CRYPT_BACKEND_CLASSIC_PGP extern struct CryptModuleSpecs crypt_mod_pgp_classic; diff --git a/ncrypt/pgp.c b/ncrypt/pgp.c index 047b7298f..27c704426 100644 --- a/ncrypt/pgp.c +++ b/ncrypt/pgp.c @@ -65,12 +65,12 @@ #include "state.h" /* These Config Variables are only used in ncrypt/pgp.c */ -bool PgpCheckExit; -bool PgpCheckGpgDecryptStatusFd; -struct Regex *PgpDecryptionOkay; -struct Regex *PgpGoodSign; -long PgpTimeout; -bool PgpUseGpgAgent; +bool PgpCheckExit; ///< Config: Check the exit code of PGP subprocess +bool PgpCheckGpgDecryptStatusFd; ///< Config: File descriptor used for status info +struct Regex *PgpDecryptionOkay; ///< Config: Text indicating a successful decryption +struct Regex *PgpGoodSign; ///< Config: Text indicating a good signature +long PgpTimeout; ///< Config: Time in seconds to cache a passphrase +bool PgpUseGpgAgent; ///< Config: Use a PGP agent for caching passwords char PgpPass[LONG_STRING]; time_t PgpExptime = 0; /* when does the cached passphrase expire? */ diff --git a/ncrypt/smime.c b/ncrypt/smime.c index 3881e5a93..a999c4073 100644 --- a/ncrypt/smime.c +++ b/ncrypt/smime.c @@ -63,21 +63,21 @@ #include "state.h" /* These Config Variables are only used in ncrypt/smime.c */ -bool SmimeAskCertLabel; -char *SmimeCaLocation; -char *SmimeCertificates; +bool SmimeAskCertLabel; ///< Config: Prompt the user for a label for SMIME certificates +char *SmimeCaLocation; ///< Config: File containing trusted certificates +char *SmimeCertificates; ///< Config: File containing user's public certificates char *SmimeDecryptCommand; ///< Config: (smime) External command to decrypt an SMIME message -bool SmimeDecryptUseDefaultKey; +bool SmimeDecryptUseDefaultKey; ///< Config: Use the default key for decryption 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 *SmimeKeys; ///< Config: File containing user's private certificates 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 *SmimeSignDigestAlg; ///< Config: Digest algorithm +long SmimeTimeout; ///< Config: Time in seconds to cache a passphrase char *SmimeVerifyCommand; ///< Config: (smime) External command to verify a signed message char *SmimeVerifyOpaqueCommand; ///< Config: (smime) External command to verify a signature diff --git a/notmuch/mutt_notmuch.c b/notmuch/mutt_notmuch.c index cc1b55ad0..c408c4b95 100644 --- a/notmuch/mutt_notmuch.c +++ b/notmuch/mutt_notmuch.c @@ -2287,7 +2287,7 @@ char *nm_get_description(struct Context *ctx) } /** - * nm_desc&ription_to_path - Find a path from a folder's description + * nm_description_to_path - Find a path from a folder's description * @param desc Description * @param buf Buffer for path * @param buflen Length of buffer diff --git a/send.c b/send.c index 36abcb745..0032499c1 100644 --- a/send.c +++ b/send.c @@ -78,13 +78,13 @@ 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; ///< Config: Default "Content-Type" for newly composed messages -bool CryptAutoencrypt; -bool CryptAutopgp; -bool CryptAutosign; -bool CryptAutosmime; -bool CryptReplyencrypt; -bool CryptReplysign; -bool CryptReplysignencrypted; +bool CryptAutoencrypt; ///< Config: Automatically PGP encrypt all outgoing mail +bool CryptAutopgp; ///< Config: Allow automatic PGP functions +bool CryptAutosign; ///< Config: Automatically PGP sign all outgoing mail +bool CryptAutosmime; ///< Config: Allow automatic SMIME functions +bool CryptReplyencrypt; ///< Config: Encrypt replies to encrypted messages +bool CryptReplysign; ///< Config: Sign replies to signed messages +bool CryptReplysignencrypted; ///< Config: Sign replies to encrypted messages 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 @@ -101,7 +101,7 @@ bool IgnoreListReplyTo; unsigned char Include; ///< Config: Include a copy of the email that's being replied to bool Metoo; bool NmRecord; -bool PgpReplyinline; +bool PgpReplyinline; ///< Config: Reply using old-style inline PGP messages (not recommended) char *PostIndentString; bool PostponeEncrypt; ///< Config: Self-encrypt postponed messages char *PostponeEncryptAs; ///< Config: Fallback encryption key for postponed messages diff --git a/sort.h b/sort.h index f5838cc60..e6edd7b88 100644 --- a/sort.h +++ b/sort.h @@ -60,6 +60,6 @@ WHERE short Sort; ///< Config: Sort method for the index WHERE short SortAux; /* auxiliary sorting method */ ///< Config: Secondary sort method for the index /* FIXME: This one does not belong to here */ -WHERE short PgpSortKeys; +WHERE short PgpSortKeys; ///< Config: Sort order for PGP keys #endif /* _MUTT_SORT_H */