doxy source fixes

diff --git a/conn/conn_globals.c b/conn/conn_globals.c
index 1a0a52bdeefee2bd164204b98939d73cdaec7669..3d237881bb7c83e3b13b95685ae932b01ab21af6 100644 (file)
--- a/conn/conn_globals.c
+++ b/conn/conn_globals.c
@@ -47,14 +47,3 @@ short SslMinDhPrimeBits = 0; /**< Config: Minimum keysize for Diffie-Hellman key
 const char *Preconnect = NULL; /**< Config: Shell command to run before making a connection */
 const char *Tunnel = NULL; /**< Config: Shell command to establish a tunnel */
 #endif
-
-/* These Config Variables are only used in conn/conn_raw.c */
-extern bool UseIpv6;
-
-/* These Config Variables are only used in conn/ssl_gnutls.c */
-extern bool SslUseSslv3;
-extern bool SslUseTlsv1;
-extern bool SslUseTlsv11;
-extern bool SslUseTlsv12;
-extern bool SslVerifyDates;
-extern bool SslVerifyHost;

diff --git a/conn/conn_globals.h b/conn/conn_globals.h
index 6d4a417951fb254069374c51027109dd1573ac56..17688b65f5a5e7c3b23513a91928ac86af42d6c4 100644 (file)
--- a/conn/conn_globals.h
+++ b/conn/conn_globals.h
@@ -44,4 +44,15 @@ extern const char *Preconnect;
 extern const char *Tunnel;
 #endif
 
+/* These Config Variables are only used in conn/conn_raw.c */
+extern bool UseIpv6;
+
+/* These Config Variables are only used in conn/ssl_gnutls.c */
+extern bool SslUseSslv3;
+extern bool SslUseTlsv1;
+extern bool SslUseTlsv11;
+extern bool SslUseTlsv12;
+extern bool SslVerifyDates;
+extern bool SslVerifyHost;
+
 #endif /* _CONN_GLOBALS_H */

diff --git a/conn/sasl.c b/conn/sasl.c
index 9320cbf9d5f796727dd65365ffc3744e933f618e..643acf7b9cc12473f4620ecef004f76fdf1032a9 100644 (file)
--- a/conn/sasl.c
+++ b/conn/sasl.c
@@ -706,7 +706,7 @@ void mutt_sasl_setup_conn(struct Connection *conn, sasl_conn_t *saslconn)
 }
 
 /**
- * mutt_sasl_done - Invoke when processing is complete.
+ * mutt_sasl_done - Invoke when processing is complete
  *
  * This is a cleanup function, used to free all memory used by the library.
  * Invoke when processing is complete.

diff --git a/conn/tunnel.c b/conn/tunnel.c
index 076532382ccb7f0c87bb95c2635b61756bc4f791..4f73d77e3039ca1f2da0e3e65efa8945d862fef2 100644 (file)
--- a/conn/tunnel.c
+++ b/conn/tunnel.c
@@ -226,7 +226,7 @@ static int tunnel_socket_poll(struct Connection *conn, time_t wait_secs)
 }
 
 /**
- * mutt_tunnel_socket_setup - setups tunnel connection functions.
+ * mutt_tunnel_socket_setup - sets up tunnel connection functions
  * @param conn Connection to assign functions to
  *
  * Assign tunnel socket functions to the Connection conn.

diff --git a/email/address.c b/email/address.c
index 1fa0008b6530f95de508d9a2bbfe173ebd204d2e..9cab3d0a91be6679de532d4d0bc98b9e9531e679 100644 (file)
--- a/email/address.c
+++ b/email/address.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page address Representation of an email address
+ * @page email_address Representation of an email address
  *
  * Representation of an email address
  */

diff --git a/email/attach.c b/email/attach.c
index 2e4eab4fb48e5e2bb0cc8a9ed43d6cb1f1e5af1a..7bc6b5d65fe2c6ce42199c99aeac22b2289a5124 100644 (file)
--- a/email/attach.c
+++ b/email/attach.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page attach Handling of email attachments
+ * @page email_attach Handling of email attachments
  *
  * Handling of email attachments
  */

diff --git a/email/body.c b/email/body.c
index 84dbabf63a44c0518adc2de5d196d6bcf4edc818..af672db26588ddbd938439e0789c9cb2fb25ef1b 100644 (file)
--- a/email/body.c
+++ b/email/body.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page body Representation of the body of an email
+ * @page email_body Representation of the body of an email
  *
  * Representation of the body of an email
  */

diff --git a/email/email.h b/email/email.h
index 7e141364b06c57476cc14c9e0f5f9fd993930515..d919a8ecc8ad4ae394bdf07bebc561263cdf5e87 100644 (file)
--- a/email/email.h
+++ b/email/email.h
@@ -21,23 +21,20 @@
  */
 
 /**
- * @page mutt Structs that make up an email
+ * @page email Structs that make up an email
  *
  * Structs that make up an email
  *
- * | File              | Description        |
- * | :---------------- | :----------------- |
- * | email/address.c   | @subpage address   |
- * | email/attach.c    | @subpage attach    |
- * | email/body.c      | @subpage body      |
- * | email/envelope.c  | @subpage envelope  |
- * | email/header.c    | @subpage header    |
- * | email/parameter.c | @subpage parameter |
- * | email/tags.c      | @subpage tags      |
- * | email/thread.c    | @subpage thread    |
- *
- * @note The library is self-contained -- some files may depend on others in
- *       the library, but none depends on source from outside.
+ * | File              | Description              |
+ * | :---------------- | :----------------------- |
+ * | email/address.c   | @subpage email_address   |
+ * | email/attach.c    | @subpage email_attach    |
+ * | email/body.c      | @subpage email_body      |
+ * | email/envelope.c  | @subpage email_envelope  |
+ * | email/header.c    | @subpage email_header    |
+ * | email/parameter.c | @subpage email_parameter |
+ * | email/tags.c      | @subpage email_tags      |
+ * | email/thread.c    | @subpage email_thread    |
  */
 
 #ifndef _EMAIL_EMAIL_H

diff --git a/email/envelope.c b/email/envelope.c
index 61b6af21574a80b725b550c38b445806cfc3908e..4720bad27853e31da9e45b22f08d2a038b870f80 100644 (file)
--- a/email/envelope.c
+++ b/email/envelope.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page envelope Representation of an email header (envelope)
+ * @page email_envelope Representation of an email header (envelope)
  *
  * Representation of an email header (envelope)
  */

diff --git a/email/header.c b/email/header.c
index 18569be767fff263fe1cbc089d3e6c26048424de..94bc08fee866e9557a09b9470cd44c6e8843231e 100644 (file)
--- a/email/header.c
+++ b/email/header.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page header Representation of the email's header
+ * @page email_header Representation of the email's header
  *
  * Representation of the email's header
  */

diff --git a/email/parameter.c b/email/parameter.c
index cef8842dbed384beef8da035e7129c9986341bb8..41e699813ddd9f3c96991f31ed90a9912a7b587f 100644 (file)
--- a/email/parameter.c
+++ b/email/parameter.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page parameter Store attributes associated with a MIME part
+ * @page email_parameter Store attributes associated with a MIME part
  *
  * Store attributes associated with a MIME part
  */

diff --git a/email/tags.c b/email/tags.c
index e8c8d3e49377c0cda62c43e194c68b99a1061533..72f29dab710aa4fda91bbb5fc741409f6667948c 100644 (file)
--- a/email/tags.c
+++ b/email/tags.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page tags Driver based email tags
+ * @page email_tags Driver based email tags
  *
  * Driver based email tags
  */

diff --git a/email/thread.c b/email/thread.c
index 48ea55ed1483ebadf698f83f768ce85c6f9d9063..27d02a7b3002545c6a4bff66d109c2b3a92cb4ff 100644 (file)
--- a/email/thread.c
+++ b/email/thread.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page thread Create/manipulate threading in emails
+ * @page email_thread Create/manipulate threading in emails
  *
  * Create/manipulate threading in emails
  */

diff --git a/maildir/maildir.h b/maildir/maildir.h
index dbeb2c2437d8deb70d739fbd9df8029dd1a138a1..48e7865d9fae3a8f6d9e07992706a1dd7dc8aa1c 100644 (file)
--- a/maildir/maildir.h
+++ b/maildir/maildir.h
@@ -20,6 +20,16 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page maildir Maildir local mailbox type
+ *
+ * Maildir local mailbox type
+ *
+ * | File         | Description              |
+ * | :----------- | :----------------------- |
+ * | maildir/mh.c | @subpage maildir_maildir |
+ */
+
 #ifndef _MAILDIR_MAILDIR_H
 #define _MAILDIR_MAILDIR_H
 

diff --git a/maildir/mh.c b/maildir/mh.c
index 54abd99185e5ca381787c7ccf235119934fbe03e..7ef174ce5e2e87261ac5989c3eb09bb659f6d85d 100644 (file)
--- a/maildir/mh.c
+++ b/maildir/mh.c
@@ -22,6 +22,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page maildir_maildir Maildir/MH local mailbox type
+ *
+ * Maildir/MH local mailbox type
+ */
+
 #include "config.h"
 #include <ctype.h>
 #include <dirent.h>

diff --git a/mbox/mbox.c b/mbox/mbox.c
index d3192bae7e61abd6007992bae3e2fcba3ecd6aa7..bb422b93e98e8eb4205d3ee3fb8e84b48f10dd12 100644 (file)
--- a/mbox/mbox.c
+++ b/mbox/mbox.c
@@ -20,7 +20,13 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* This file contains code to parse ``mbox'' and ``mmdf'' style mailboxes */
+/**
+ * @page mbox_mbox Mbox local mailbox type
+ *
+ * Mbox local mailbox type
+ *
+ * This file contains code to parse 'mbox' and 'mmdf' style mailboxes.
+ */
 
 #include "config.h"
 #include <fcntl.h>

diff --git a/mbox/mbox.h b/mbox/mbox.h
index 6f91065ed1af384dadad28dee0e18769637bc918..49f48474c2a833df87f5d32e2071019778e6a9ed 100644 (file)
--- a/mbox/mbox.h
+++ b/mbox/mbox.h
@@ -20,6 +20,16 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mbox Mbox local mailbox type
+ *
+ * Mbox local mailbox type
+ *
+ * | File        | Description        |
+ * | :---------- | :----------------- |
+ * | mbox/mbox.c | @subpage mbox_mbox |
+ */
+
 #ifndef _MBOX_MBOX_H
 #define _MBOX_MBOX_H
 

diff --git a/mutt/mutt.h b/mutt/mutt.h
index d8ddfbbd3d57cb8b93834020176c917e0f709b4b..a054257f2f4c5f891cb665b1173c3056d68e6aa4 100644 (file)
--- a/mutt/mutt.h
+++ b/mutt/mutt.h
@@ -51,6 +51,8 @@
  *
  * @note The library is self-contained -- some files may depend on others in
  *       the library, but none depends on source from outside.
+ *
+ * @image html libmutt.svg
  */
 
 #ifndef _MUTT_MUTT_H

diff --git a/mutt_body.c b/mutt_body.c
index ab92c619d6723c94bef753d2aa8ad8d7ce9f237f..61a597bc6b620619a37d0f87b744fa0a6d018d70 100644 (file)
--- a/mutt_body.c
+++ b/mutt_body.c
@@ -20,12 +20,6 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
- * @page body Representation of the body of an email
- *
- * Representation of the body of an email
- */
-
 #include "config.h"
 #include <limits.h>
 #include <stdbool.h>

diff --git a/nntp/newsrc.c b/nntp/newsrc.c
index 9d535bd3be87734966745f8ea4d495b931092e00..3fa1ae9a60300c3317dd94cf0977b869ed52382e 100644 (file)
--- a/nntp/newsrc.c
+++ b/nntp/newsrc.c
@@ -23,7 +23,7 @@
  */
 
 /**
- * @page newsrc Read/parse/write an NNTP config file of subscribed newsgroups
+ * @page nntp_newsrc Read/parse/write an NNTP config file of subscribed newsgroups
  *
  * Read/parse/write an NNTP config file of subscribed newsgroups
  */

diff --git a/nntp/nntp.c b/nntp/nntp.c
index 7f64b6b83e9254d92c07aa65d5cbca36f9b0ec1c..da10fd32c2696b981617682e142dc8d7bf8bc792 100644 (file)
--- a/nntp/nntp.c
+++ b/nntp/nntp.c
@@ -23,7 +23,7 @@
  */
 
 /**
- * @page nntp Usenet network mailbox type; talk to an NNTP server
+ * @page nntp_nntp Usenet network mailbox type; talk to an NNTP server
  *
  * Usenet network mailbox type; talk to an NNTP server
  */

diff --git a/nntp/nntp.h b/nntp/nntp.h
index b863206e059c4d11183aca874fb43dd58f111adf..3673c9d84ed7ce667b4c1306d94aae4ba6694083 100644 (file)
--- a/nntp/nntp.h
+++ b/nntp/nntp.h
@@ -22,6 +22,17 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page nntp Usenet network mailbox type; talk to an NNTP server
+ *
+ * Usenet network mailbox type; talk to an NNTP server
+ *
+ * | File          | Description          |
+ * | :------------ | :------------------- |
+ * | nntp/newsrc.c | @subpage nntp_newsrc |
+ * | nntp/nntp.c   | @subpage nntp_nntp   |
+ */
+
 #ifndef _NNTP_NNTP_H
 #define _NNTP_NNTP_H
 

diff --git a/notmuch/mutt_notmuch.c b/notmuch/mutt_notmuch.c
index 791d3524c60138fe89fd14563386393994a0fa32..7553581b69e7dfc52ff21b40453233f0a6089ba9 100644 (file)
--- a/notmuch/mutt_notmuch.c
+++ b/notmuch/mutt_notmuch.c
@@ -35,6 +35,12 @@
  *   (or parse URI from another resource)
  */
 
+/**
+ * @page nm_notmuch Notmuch virtual mailbox type
+ *
+ * Notmuch virtual mailbox type
+ */
+
 #include "config.h"
 #include <ctype.h>
 #include <errno.h>

diff --git a/notmuch/mutt_notmuch.h b/notmuch/mutt_notmuch.h
index 92f92ff90c2e02887c1263335ffa179625147c26..ac41d28f38b772ada32c69b995f124d2c8afbd21 100644 (file)
--- a/notmuch/mutt_notmuch.h
+++ b/notmuch/mutt_notmuch.h
@@ -20,6 +20,16 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page notmuch Notmuch virtual mailbox type
+ *
+ * Notmuch virtual mailbox type
+ *
+ * | File                   | Description         |
+ * | :--------------------- | :------------------ |
+ * | notmuch/mutt_notmuch.c | @subpage nm_notmuch |
+ */
+
 #ifndef _MUTT_NOTMUCH_H
 #define _MUTT_NOTMUCH_H
 

diff --git a/pop/pop.c b/pop/pop.c
index 97a16fd76f29fbb736a89cb1d7ed6ca8dc9be9d6..4f0df9b01c72b7a496bc00301e6acb26df5bac8d 100644 (file)
--- a/pop/pop.c
+++ b/pop/pop.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page pop POP network mailbox
+ * @page pop_pop POP network mailbox
  *
  * POP network mailbox
  */

diff --git a/pop/pop.h b/pop/pop.h
index ea2743102d9431903e38434bbf3e1a0d5eaaace4..d5e5e829df9a1641f1894ef91a379a1258988282 100644 (file)
--- a/pop/pop.h
+++ b/pop/pop.h
@@ -25,6 +25,18 @@
 
 #include "mx.h"
 
+/**
+ * @page pop POP network mailbox
+ *
+ * POP network mailbox
+ *
+ * | File           | Description       |
+ * | :------------- | :---------------- |
+ * | pop/pop_auth.c | @subpage pop_auth |
+ * | pop/pop.c      | @subpage pop_pop  |
+ * | pop/pop_lib.c  | @subpage pop_lib  |
+ */
+
 /* These Config Variables are only used in pop/pop.c */
 extern short         PopCheckinterval;
 extern unsigned char PopDelete;

diff --git a/pop/pop_lib.c b/pop/pop_lib.c
index 791d8449904f6225a6ae4b018d5b790be46713fd..c3e23880f0d6170488d7b94816e1ee97938e93fc 100644 (file)
--- a/pop/pop_lib.c
+++ b/pop/pop_lib.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page pop_lib POP helper routines
+ *
+ * POP helper routines
+ */
+
 #include "config.h"
 #include <errno.h>
 #include <netdb.h>