doxy: add headers

diff --git a/conn/conn.h b/conn/conn.h
index ec0ae087695d781cd9f93b20eb90747a968fa10c..9783dcd1c58251729b49f8ec4547dd584d96ffab 100644 (file)
--- 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 3f4ee254e0c246327e9763bd359bae4e4981d45b..7367fdc22811b5893a4cfa218f6552890349156c 100644 (file)
--- 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 3a2a0cee45febad994273eb8610148b00b9d6f67..662f4db80f9ddd0d10d5631c21e63c577922f00c 100644 (file)
--- 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 f24cb25faa1e5e21cbc5998a9c31cd628b070e7c..0a144e83ffbe7fc92e512299f45d1e7bd8d11abf 100644 (file)
--- a/mutt_window.c
+++ b/mutt_window.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @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 4c6462af434eca32e736bc24c409fe6e243a0373..bb1069a1c60fb7600ed47b932cb0e0136780a282 100644 (file)
--- a/ncrypt/crypt.c
+++ b/ncrypt/crypt.c
@@ -25,6 +25,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page crypt_crypt Signing/encryption multiplexor
+ *
+ * Signing/encryption multiplexor
+ */
+
 #include "config.h"
 #include <limits.h>
 #include <locale.h>

diff --git a/ncrypt/crypt_gpgme.c b/ncrypt/crypt_gpgme.c
index 5d4cf95c7160fa2069cc0bc69600ffc2afa419ba..3c26294fba6b4d24713fe1b75bb475b0c6870d6b 100644 (file)
--- 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 <ctype.h>
 #include <errno.h>
@@ -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 04fd38b91f00d01c9ce1fecc4c193930361b05d7..01b069b6d9cfce6f7484916da195a485233ae002 100644 (file)
--- a/ncrypt/crypt_mod.c
+++ b/ncrypt/crypt_mod.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @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 24a3d885945e5371e491540a4083fb2554c5bbd4..a0ed4941ffdd69d45d8b61d4e072daf5889df3d5 100644 (file)
--- a/ncrypt/crypt_mod_pgp_classic.c
+++ b/ncrypt/crypt_mod_pgp_classic.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page crypt_crypt_mod_pgp Wrappers for calls to CLI PGP
+ *
+ * Wrappers for calls to CLI PGP
+ */
+
 #include "config.h"
 #include <stdio.h>
 #include "crypt_mod.h"

diff --git a/ncrypt/crypt_mod_pgp_gpgme.c b/ncrypt/crypt_mod_pgp_gpgme.c
index 7999accc96ea1f2e2bf085d12ea390876af9bab7..c55819178c71f1e68235a42792a5b3e333339f5e 100644 (file)
--- a/ncrypt/crypt_mod_pgp_gpgme.c
+++ b/ncrypt/crypt_mod_pgp_gpgme.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page crypt_crypt_mod_pgp_gpgme Wrappers for calls to GPGME PGP
+ *
+ * Wrappers for calls to GPGME PGP
+ */
+
 #include "config.h"
 #include <stdio.h>
 #include "crypt_gpgme.h"

diff --git a/ncrypt/crypt_mod_smime_classic.c b/ncrypt/crypt_mod_smime_classic.c
index 04da2097cd4ee0e053683f4a31e29f3bb178b315..9a70a19b2083802f5d7db89b9ee1d94a86e94272 100644 (file)
--- a/ncrypt/crypt_mod_smime_classic.c
+++ b/ncrypt/crypt_mod_smime_classic.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page crypt_crypt_mod_smime Wrappers for calls to CLI SMIME
+ *
+ * Wrappers for calls to CLI SMIME
+ */
+
 #include "config.h"
 #include <stdio.h>
 #include "crypt_mod.h"

diff --git a/ncrypt/crypt_mod_smime_gpgme.c b/ncrypt/crypt_mod_smime_gpgme.c
index e3e887eafa1be81ec6085f8fd3072d6608c4d9bd..dc7011fbbc6c6073e7fd602e64bcb1d4634bdbe6 100644 (file)
--- a/ncrypt/crypt_mod_smime_gpgme.c
+++ b/ncrypt/crypt_mod_smime_gpgme.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page crypt_crypt_mod_smime_gpgme Wrappers for calls to GPGME SMIME
+ *
+ * Wrappers for calls to GPGME SMIME
+ */
+
 #include "config.h"
 #include <stdio.h>
 #include "crypt_gpgme.h"

diff --git a/ncrypt/cryptglue.c b/ncrypt/cryptglue.c
index 3351f41a72a239d8be2d44835137ed0b66868ad1..9ffebcfd2b1219b52e5e277ba2996cafe221b256 100644 (file)
--- a/ncrypt/cryptglue.c
+++ b/ncrypt/cryptglue.c
@@ -21,12 +21,14 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* 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 5e180e8fe3e991bf990b5b9bd569929b4cb268e4..43d0fd7f99b452479a3b5e6bee6f7570e72d0f90 100644 (file)
--- a/ncrypt/gnupgparse.c
+++ b/ncrypt/gnupgparse.c
@@ -21,7 +21,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* 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 a22158a5b7ca962d9f0c9e189013c781345dcc4c..a8ef18762f8f788f9f6224928f9ea83630d370b7 100644 (file)
--- a/ncrypt/ncrypt.h
+++ b/ncrypt/ncrypt.h
@@ -21,6 +21,31 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @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 bd9ac99973ccfa2650067e7a46c1d8f8816ed217..55c4b862ece28f9d355aaa3650834293943099da 100644 (file)
--- a/ncrypt/pgp.c
+++ b/ncrypt/pgp.c
@@ -22,7 +22,10 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* 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 5b19dd8a9877ba8766576fa4bff8bb567fac43c0..e24d3f06cdd4d8624254c1718ac45182b3c73dd1 100644 (file)
--- a/ncrypt/pgpinvoke.c
+++ b/ncrypt/pgpinvoke.c
@@ -20,8 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* 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 3559e3111e86de3350d5d70bfb527aacc08f8dad..5a635412a877f58d96444b6e77922e3369397768 100644 (file)
--- a/ncrypt/pgpkey.c
+++ b/ncrypt/pgpkey.c
@@ -21,6 +21,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page crypt_pgpkey PGP key management routines
+ *
+ * PGP key management routines
+ */
+
 #include "config.h"
 #include <ctype.h>
 #include <limits.h>

diff --git a/ncrypt/pgplib.c b/ncrypt/pgplib.c
index 90641d97cedb4546ec1643c5426e31294e2e7e0d..ee886febe0dbaad6d5a5697a97ccf0ab4187c7f1 100644 (file)
--- a/ncrypt/pgplib.c
+++ b/ncrypt/pgplib.c
@@ -20,7 +20,11 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* Generally useful, pgp-related functions. */
+/**
+ * @page crypt_pgplib Misc PGP helper routines
+ *
+ * Misc PGP helper routines
+ */
 
 #include "config.h"
 #include <stdbool.h>

diff --git a/ncrypt/pgpmicalg.c b/ncrypt/pgpmicalg.c
index 132ba2b0c0bc8c6582a97cc81e81e976b52bd24a..1e44a47bb23dbe79d1eed37415393af3f924826d 100644 (file)
--- a/ncrypt/pgpmicalg.c
+++ b/ncrypt/pgpmicalg.c
@@ -20,8 +20,10 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* 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 1b5b8b715d397d47651afe9ebf98015e87344753..6038589edfbf56009ad175bbf458cc9c008d5f45 100644 (file)
--- a/ncrypt/pgppacket.c
+++ b/ncrypt/pgppacket.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page crypt_pgppacket Parse PGP data packets
+ *
+ * Parse PGP data packets
+ */
+
 #include "config.h"
 #include <stdbool.h>
 #include <stdio.h>

diff --git a/ncrypt/smime.c b/ncrypt/smime.c
index b86737bfaf26cd6172b782d6ef123d33c22f3bb8..5fb22e978653fbabea5d9fdb354f964f353aacb0 100644 (file)
--- a/ncrypt/smime.c
+++ b/ncrypt/smime.c
@@ -22,6 +22,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page crypt_smime SMIME helper routines
+ *
+ * SMIME helper routines
+ */
+
 #include "config.h"
 #include <limits.h>
 #include <stdbool.h>

diff --git a/terminal.c b/terminal.c
index 7e18d51b8645ecb744265059e1eb2c6421d0e9bd..d027bf21d47f5068a065846560c8ab595266adc6 100644 (file)
--- a/terminal.c
+++ b/terminal.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page terminal Set the terminal title/icon
+ *
+ * Set the terminal title/icon
+ */
+
 #include "config.h"
 #include <stdbool.h>
 #include <stdio.h>