From: Richard Russon Date: Mon, 9 Jul 2018 15:40:34 +0000 (+0100) Subject: doxy source fixes X-Git-Tag: 2019-10-25~757^2~8 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c8537d8a3460781e63518dc6d5b7890e6a72ddbe;p=neomutt doxy source fixes --- diff --git a/conn/conn_globals.c b/conn/conn_globals.c index 1a0a52bde..3d237881b 100644 --- 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 6d4a41795..17688b65f 100644 --- 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 9320cbf9d..643acf7b9 100644 --- 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 076532382..4f73d77e3 100644 --- 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 1fa0008b6..9cab3d0a9 100644 --- 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 2e4eab4fb..7bc6b5d65 100644 --- 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 84dbabf63..af672db26 100644 --- 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 7e141364b..d919a8ecc 100644 --- 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 61b6af215..4720bad27 100644 --- 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 18569be76..94bc08fee 100644 --- 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 cef8842db..41e699813 100644 --- 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 e8c8d3e49..72f29dab7 100644 --- 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 48ea55ed1..27d02a7b3 100644 --- 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 dbeb2c243..48e7865d9 100644 --- a/maildir/maildir.h +++ b/maildir/maildir.h @@ -20,6 +20,16 @@ * this program. If not, see . */ +/** + * @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 54abd9918..7ef174ce5 100644 --- a/maildir/mh.c +++ b/maildir/mh.c @@ -22,6 +22,12 @@ * this program. If not, see . */ +/** + * @page maildir_maildir Maildir/MH local mailbox type + * + * Maildir/MH local mailbox type + */ + #include "config.h" #include #include diff --git a/mbox/mbox.c b/mbox/mbox.c index d3192bae7..bb422b93e 100644 --- a/mbox/mbox.c +++ b/mbox/mbox.c @@ -20,7 +20,13 @@ * this program. If not, see . */ -/* 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 diff --git a/mbox/mbox.h b/mbox/mbox.h index 6f91065ed..49f48474c 100644 --- a/mbox/mbox.h +++ b/mbox/mbox.h @@ -20,6 +20,16 @@ * this program. If not, see . */ +/** + * @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 d8ddfbbd3..a054257f2 100644 --- 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 ab92c619d..61a597bc6 100644 --- a/mutt_body.c +++ b/mutt_body.c @@ -20,12 +20,6 @@ * this program. If not, see . */ -/** - * @page body Representation of the body of an email - * - * Representation of the body of an email - */ - #include "config.h" #include #include diff --git a/nntp/newsrc.c b/nntp/newsrc.c index 9d535bd3b..3fa1ae9a6 100644 --- 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 7f64b6b83..da10fd32c 100644 --- 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 b863206e0..3673c9d84 100644 --- a/nntp/nntp.h +++ b/nntp/nntp.h @@ -22,6 +22,17 @@ * this program. If not, see . */ +/** + * @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 791d3524c..7553581b6 100644 --- 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 #include diff --git a/notmuch/mutt_notmuch.h b/notmuch/mutt_notmuch.h index 92f92ff90..ac41d28f3 100644 --- a/notmuch/mutt_notmuch.h +++ b/notmuch/mutt_notmuch.h @@ -20,6 +20,16 @@ * this program. If not, see . */ +/** + * @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 97a16fd76..4f0df9b01 100644 --- 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 ea2743102..d5e5e829d 100644 --- 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 791d84499..c3e23880f 100644 --- a/pop/pop_lib.c +++ b/pop/pop_lib.c @@ -20,6 +20,12 @@ * this program. If not, see . */ +/** + * @page pop_lib POP helper routines + * + * POP helper routines + */ + #include "config.h" #include #include