From 71dd09ab34cf1e0c66b1517b89abbc1454759041 Mon Sep 17 00:00:00 2001 From: Richard Russon Date: Thu, 12 Apr 2018 11:00:59 +0100 Subject: [PATCH] doxy: add headers --- conn/conn.h | 3 ++- conn/ssl.c | 2 +- mutt/mutt.h | 2 +- mutt_window.c | 6 ++++++ ncrypt/crypt.c | 6 ++++++ ncrypt/crypt_gpgme.c | 12 +++++++++--- ncrypt/crypt_mod.c | 6 ++++++ ncrypt/crypt_mod_pgp_classic.c | 6 ++++++ ncrypt/crypt_mod_pgp_gpgme.c | 6 ++++++ ncrypt/crypt_mod_smime_classic.c | 6 ++++++ ncrypt/crypt_mod_smime_gpgme.c | 6 ++++++ ncrypt/cryptglue.c | 10 ++++++---- ncrypt/gnupgparse.c | 7 ++++++- ncrypt/ncrypt.h | 25 +++++++++++++++++++++++++ ncrypt/pgp.c | 11 +++++++---- ncrypt/pgpinvoke.c | 8 ++++++-- ncrypt/pgpkey.c | 6 ++++++ ncrypt/pgplib.c | 6 +++++- ncrypt/pgpmicalg.c | 6 ++++-- ncrypt/pgppacket.c | 6 ++++++ ncrypt/smime.c | 6 ++++++ terminal.c | 6 ++++++ 22 files changed, 138 insertions(+), 20 deletions(-) diff --git a/conn/conn.h b/conn/conn.h index ec0ae0876..9783dcd1c 100644 --- a/conn/conn.h +++ b/conn/conn.h @@ -21,7 +21,7 @@ */ /** - * @page conn Connection Library + * @page conn Network connections and their encryption * * Manage external connections. * @@ -29,6 +29,7 @@ * | :------------------ | :----------------------- | * | conn/conn_globals.c | @subpage conn_globals | * | conn/getdomain.c | @subpage conn_getdomain | + * | conn/conn_raw.c | @subpage conn_raw | * | conn/sasl.c | @subpage conn_sasl | * | conn/sasl_plain.c | @subpage conn_sasl_plain | * | conn/socket.c | @subpage conn_socket | diff --git a/conn/ssl.c b/conn/ssl.c index 3f4ee254e..7367fdc22 100644 --- a/conn/ssl.c +++ b/conn/ssl.c @@ -956,7 +956,7 @@ static int interactive_check_cert(X509 *cert, int idx, size_t len, SSL *ssl, int struct Menu *menu = mutt_menu_new(MENU_GENERIC); int done, row; FILE *fp = NULL; - int ALLOW_SKIP = 0; /**< All caps tells Coverity that this is effectively a preproc condition */ + int ALLOW_SKIP = 0; /* All caps tells Coverity that this is effectively a preproc condition */ mutt_menu_push_current(menu); diff --git a/mutt/mutt.h b/mutt/mutt.h index 3a2a0cee4..662f4db80 100644 --- a/mutt/mutt.h +++ b/mutt/mutt.h @@ -21,7 +21,7 @@ */ /** - * @page mutt Shared functions + * @page mutt Shared code for handling strings, files, dates, etc * * Each source file in the library provides a group of related functions. * diff --git a/mutt_window.c b/mutt_window.c index f24cb25fa..0a144e83f 100644 --- a/mutt_window.c +++ b/mutt_window.c @@ -20,6 +20,12 @@ * this program. If not, see . */ +/** + * @page window Window management + * + * Window management + */ + #include "config.h" #include "globals.h" #include "mutt/logging.h" diff --git a/ncrypt/crypt.c b/ncrypt/crypt.c index 4c6462af4..bb1069a1c 100644 --- a/ncrypt/crypt.c +++ b/ncrypt/crypt.c @@ -25,6 +25,12 @@ * this program. If not, see . */ +/** + * @page crypt_crypt Signing/encryption multiplexor + * + * Signing/encryption multiplexor + */ + #include "config.h" #include #include diff --git a/ncrypt/crypt_gpgme.c b/ncrypt/crypt_gpgme.c index 5d4cf95c7..3c26294fb 100644 --- a/ncrypt/crypt_gpgme.c +++ b/ncrypt/crypt_gpgme.c @@ -27,6 +27,12 @@ * crypt_gpgme.c - GPGME based crypto operations */ +/** + * @page crypt_crypt_gpgme Wrapper for PGP/SMIME calls to GPGME + * + * Wrapper for PGP/SMIME calls to GPGME + */ + #include "config.h" #include #include @@ -2394,7 +2400,7 @@ void pgp_gpgme_invoke_import(const char *fname) * * strip the signature and PGP's dash-escaping. * - * XXX - charset handling: We assume that it is safe to do character set + * XXX charset handling: We assume that it is safe to do character set * decoding first, dash decoding second here, while we do it the other way * around in the main handler. * @@ -2514,7 +2520,7 @@ int pgp_gpgme_application_handler(struct Body *m, struct State *s) } else { - /* XXX - we may wish to recode here */ + /* XXX we may wish to recode here */ if (s->prefix) state_puts(s->prefix, s); state_puts(buf, s); @@ -2672,7 +2678,7 @@ int pgp_gpgme_application_handler(struct Body *m, struct State *s) else { /* A traditional PGP part may mix signed and unsigned content */ - /* XXX - we may wish to recode here */ + /* XXX we may wish to recode here */ if (s->prefix) state_puts(s->prefix, s); state_puts(buf, s); diff --git a/ncrypt/crypt_mod.c b/ncrypt/crypt_mod.c index 04fd38b91..01b069b6d 100644 --- a/ncrypt/crypt_mod.c +++ b/ncrypt/crypt_mod.c @@ -20,6 +20,12 @@ * this program. If not, see . */ +/** + * @page crypt_crypt_mod Register crypto modules + * + * Register crypto modules + */ + #include "config.h" #include "mutt/mutt.h" #include "mutt/queue.h" diff --git a/ncrypt/crypt_mod_pgp_classic.c b/ncrypt/crypt_mod_pgp_classic.c index 24a3d8859..a0ed4941f 100644 --- a/ncrypt/crypt_mod_pgp_classic.c +++ b/ncrypt/crypt_mod_pgp_classic.c @@ -20,6 +20,12 @@ * this program. If not, see . */ +/** + * @page crypt_crypt_mod_pgp Wrappers for calls to CLI PGP + * + * Wrappers for calls to CLI PGP + */ + #include "config.h" #include #include "crypt_mod.h" diff --git a/ncrypt/crypt_mod_pgp_gpgme.c b/ncrypt/crypt_mod_pgp_gpgme.c index 7999accc9..c55819178 100644 --- a/ncrypt/crypt_mod_pgp_gpgme.c +++ b/ncrypt/crypt_mod_pgp_gpgme.c @@ -20,6 +20,12 @@ * this program. If not, see . */ +/** + * @page crypt_crypt_mod_pgp_gpgme Wrappers for calls to GPGME PGP + * + * Wrappers for calls to GPGME PGP + */ + #include "config.h" #include #include "crypt_gpgme.h" diff --git a/ncrypt/crypt_mod_smime_classic.c b/ncrypt/crypt_mod_smime_classic.c index 04da2097c..9a70a19b2 100644 --- a/ncrypt/crypt_mod_smime_classic.c +++ b/ncrypt/crypt_mod_smime_classic.c @@ -20,6 +20,12 @@ * this program. If not, see . */ +/** + * @page crypt_crypt_mod_smime Wrappers for calls to CLI SMIME + * + * Wrappers for calls to CLI SMIME + */ + #include "config.h" #include #include "crypt_mod.h" diff --git a/ncrypt/crypt_mod_smime_gpgme.c b/ncrypt/crypt_mod_smime_gpgme.c index e3e887eaf..dc7011fbb 100644 --- a/ncrypt/crypt_mod_smime_gpgme.c +++ b/ncrypt/crypt_mod_smime_gpgme.c @@ -20,6 +20,12 @@ * this program. If not, see . */ +/** + * @page crypt_crypt_mod_smime_gpgme Wrappers for calls to GPGME SMIME + * + * Wrappers for calls to GPGME SMIME + */ + #include "config.h" #include #include "crypt_gpgme.h" diff --git a/ncrypt/cryptglue.c b/ncrypt/cryptglue.c index 3351f41a7..9ffebcfd2 100644 --- a/ncrypt/cryptglue.c +++ b/ncrypt/cryptglue.c @@ -21,12 +21,14 @@ * this program. If not, see . */ -/* This file dispatches the generic crypto functions to the implemented backend +/** + * @page crypt_cryptglue Wrapper around crypto functions + * + * This file dispatches the generic crypto functions to the implemented backend * or provides dummy stubs. Note, that some generic functions are handled in * crypt.c. - */ - -/* Note: This file has been changed to make use of the new module system. + * + * @note This file has been changed to make use of the new module system. * Consequently there's a 1:1 mapping between the functions contained in this * file and the functions implemented by the crypto modules. */ diff --git a/ncrypt/gnupgparse.c b/ncrypt/gnupgparse.c index 5e180e8fe..43d0fd7f9 100644 --- a/ncrypt/gnupgparse.c +++ b/ncrypt/gnupgparse.c @@ -21,7 +21,12 @@ * this program. If not, see . */ -/* NOTE: This code used to be the parser for GnuPG's output. +/** + * @page crypt_gnupg Parse the output of CLI PGP program + * + * Parse the output of CLI PGP program + * + * @note This code used to be the parser for GnuPG's output. * * Nowadays, we are using an external pubring lister with PGP which mimics * gpg's output format. diff --git a/ncrypt/ncrypt.h b/ncrypt/ncrypt.h index a22158a5b..a8ef18762 100644 --- a/ncrypt/ncrypt.h +++ b/ncrypt/ncrypt.h @@ -21,6 +21,31 @@ * this program. If not, see . */ +/** + * @page ncrypt Encrypt/decrypt/sign/verify emails + * + * Encrypt/decrypt/sign/verify emails + * + * | File | Description | + * | :------------------------------- | :----------------------------------- | + * | ncrypt/crypt.c | @subpage crypt_crypt | + * | ncrypt/cryptglue.c | @subpage crypt_cryptglue | + * | ncrypt/crypt_gpgme.c | @subpage crypt_crypt_gpgme | + * | ncrypt/crypt_mod.c | @subpage crypt_crypt_mod | + * | ncrypt/crypt_mod_pgp_classic.c | @subpage crypt_crypt_mod_pgp | + * | ncrypt/crypt_mod_pgp_gpgme.c | @subpage crypt_crypt_mod_pgp_gpgme | + * | ncrypt/crypt_mod_smime_classic.c | @subpage crypt_crypt_mod_smime | + * | ncrypt/crypt_mod_smime_gpgme.c | @subpage crypt_crypt_mod_smime_gpgme | + * | ncrypt/gnupgparse.c | @subpage crypt_gnupg | + * | ncrypt/pgp.c | @subpage crypt_pgp | + * | ncrypt/pgpinvoke.c | @subpage crypt_pgpinvoke | + * | ncrypt/pgpkey.c | @subpage crypt_pgpkey | + * | ncrypt/pgplib.c | @subpage crypt_pgplib | + * | ncrypt/pgpmicalg.c | @subpage crypt_pgpmicalg | + * | ncrypt/pgppacket.c | @subpage crypt_pgppacket | + * | ncrypt/smime.c | @subpage crypt_smime | + */ + #ifndef _NCRYPT_NCRYPT_H #define _NCRYPT_NCRYPT_H diff --git a/ncrypt/pgp.c b/ncrypt/pgp.c index bd9ac9997..55c4b862e 100644 --- a/ncrypt/pgp.c +++ b/ncrypt/pgp.c @@ -22,7 +22,10 @@ * this program. If not, see . */ -/* This file contains all of the PGP routines necessary to sign, encrypt, +/** + * @page crypt_pgp PGP sign, encrypt, check routines + * + * This file contains all of the PGP routines necessary to sign, encrypt, * verify and decrypt PGP messages in either the new PGP/MIME format, or in the * older Application/Pgp format. It also contains some code to cache the * user's passphrase for repeat use when decrypting or signing a message. @@ -257,7 +260,7 @@ static int pgp_check_decryption_okay(FILE *fpin) /** * pgp_copy_clearsigned - Copy a clearsigned message, stripping the signature * - * XXX - charset handling: We assume that it is safe to do character set + * XXX charset handling: We assume that it is safe to do character set * decoding first, dash decoding second here, while we do it the other way * around in the main handler. * @@ -369,7 +372,7 @@ int pgp_application_pgp_handler(struct Body *m, struct State *s) } else { - /* XXX - we may wish to recode here */ + /* XXX we may wish to recode here */ if (s->prefix) state_puts(s->prefix, s); state_puts(buf, s); @@ -574,7 +577,7 @@ int pgp_application_pgp_handler(struct Body *m, struct State *s) else { /* A traditional PGP part may mix signed and unsigned content */ - /* XXX - we may wish to recode here */ + /* XXX we may wish to recode here */ if (s->prefix) state_puts(s->prefix, s); state_puts(buf, s); diff --git a/ncrypt/pgpinvoke.c b/ncrypt/pgpinvoke.c index 5b19dd8a9..e24d3f06c 100644 --- a/ncrypt/pgpinvoke.c +++ b/ncrypt/pgpinvoke.c @@ -20,8 +20,12 @@ * this program. If not, see . */ -/* This file contains the new pgp invocation code. Note that this - * is almost entirely format based. +/** + * @page crypt_pgpinvoke Wrapper around calls to external PGP program + * + * This file contains the new pgp invocation code. + * + * @note This is almost entirely format based. */ #include "config.h" diff --git a/ncrypt/pgpkey.c b/ncrypt/pgpkey.c index 3559e3111..5a635412a 100644 --- a/ncrypt/pgpkey.c +++ b/ncrypt/pgpkey.c @@ -21,6 +21,12 @@ * this program. If not, see . */ +/** + * @page crypt_pgpkey PGP key management routines + * + * PGP key management routines + */ + #include "config.h" #include #include diff --git a/ncrypt/pgplib.c b/ncrypt/pgplib.c index 90641d97c..ee886febe 100644 --- a/ncrypt/pgplib.c +++ b/ncrypt/pgplib.c @@ -20,7 +20,11 @@ * this program. If not, see . */ -/* Generally useful, pgp-related functions. */ +/** + * @page crypt_pgplib Misc PGP helper routines + * + * Misc PGP helper routines + */ #include "config.h" #include diff --git a/ncrypt/pgpmicalg.c b/ncrypt/pgpmicalg.c index 132ba2b0c..1e44a47bb 100644 --- a/ncrypt/pgpmicalg.c +++ b/ncrypt/pgpmicalg.c @@ -20,8 +20,10 @@ * this program. If not, see . */ -/* This module peeks at a PGP signature and figures out the hash - * algorithm. +/** + * @page crypt_pgpmicalg Identify the hash algorithm from a PGP signature + * + * Identify the hash algorithm from a PGP signature */ #include "config.h" diff --git a/ncrypt/pgppacket.c b/ncrypt/pgppacket.c index 1b5b8b715..6038589ed 100644 --- a/ncrypt/pgppacket.c +++ b/ncrypt/pgppacket.c @@ -20,6 +20,12 @@ * this program. If not, see . */ +/** + * @page crypt_pgppacket Parse PGP data packets + * + * Parse PGP data packets + */ + #include "config.h" #include #include diff --git a/ncrypt/smime.c b/ncrypt/smime.c index b86737bfa..5fb22e978 100644 --- a/ncrypt/smime.c +++ b/ncrypt/smime.c @@ -22,6 +22,12 @@ * this program. If not, see . */ +/** + * @page crypt_smime SMIME helper routines + * + * SMIME helper routines + */ + #include "config.h" #include #include diff --git a/terminal.c b/terminal.c index 7e18d51b8..d027bf21d 100644 --- a/terminal.c +++ b/terminal.c @@ -20,6 +20,12 @@ * this program. If not, see . */ +/** + * @page terminal Set the terminal title/icon + * + * Set the terminal title/icon + */ + #include "config.h" #include #include -- 2.40.0