]> granicus.if.org Git - neomutt/commitdiff
doxy: add pages
authorRichard Russon <rich@flatcap.org>
Mon, 10 Dec 2018 00:37:19 +0000 (00:37 +0000)
committerRichard Russon <rich@flatcap.org>
Mon, 10 Dec 2018 00:55:23 +0000 (00:55 +0000)
47 files changed:
account.c
alias.c
bcache.c
browser.c
color.c
commands.c
compose.c
curs_lib.c
edit.c
enriched.c
group.c
handler.c
hdrline.c
help.c
index.c
init.c
keymap.c
mailbox.c
menu.c
monitor.c
mutt_attach.c
mutt_body.c
mutt_header.c
mutt_history.c
mutt_lua.c
mutt_parse.c
mutt_thread.c
mutt_url.c
muttlib.c
myvar.c
nntp/nntp.h
notmuch/mutt_notmuch.h
notmuch/nm_db.c
pager.c
pattern.c
query.c
recvattach.c
recvcmd.c
remailer.c
rfc3676.c
score.c
send.c
sendlib.c
smtp.c
sort.c
state.c
wcscasecmp.c

index bbfbbbeab3528a16df3c7b5e48da162291c17868..fabae266f7508485187f1c6fd914fe33a35caff7 100644 (file)
--- a/account.c
+++ b/account.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page account Representation of an account
+ *
+ * Representation of an account
+ */
+
 #include "config.h"
 #include "mutt/mutt.h"
 #include "account.h"
diff --git a/alias.c b/alias.c
index 0fd8639f28d89e29d06ea93983fd3a2279010a1b..7066ebed1e2138e79c45ff83341297e7961e635f 100644 (file)
--- a/alias.c
+++ b/alias.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page alias Representation of a single alias to an email address
+ *
+ * Representation of a single alias to an email address
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include <errno.h>
index 8d47190b735fcd646be2c5055d0fe161fb486b5c..a483d2a0eeb5c2eeb01c2f5bdb67576cced96801 100644 (file)
--- a/bcache.c
+++ b/bcache.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page bcache Body Caching - local copies of email bodies
+ *
+ * Body Caching - local copies of email bodies
+ */
+
 #include "config.h"
 #include <dirent.h>
 #include <errno.h>
index 3c7c2f90ebcfac1a584a7915b56dd9f02331f244..490286c6c8d8c8f58013fbb0ea17517b22ce5feb 100644 (file)
--- a/browser.c
+++ b/browser.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page browser GUI component for displaying/selecting items from a list
+ *
+ * GUI component for displaying/selecting items from a list
+ */
+
 #include "config.h"
 #include <dirent.h>
 #include <errno.h>
diff --git a/color.c b/color.c
index 9b8f8979fa22b40ff9bafd8deb9e6253d4d8ad61..1f9c4b002cd4a674d7c93004ed37b9d5fe717626 100644 (file)
--- a/color.c
+++ b/color.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page color Color and attribute parsing
+ *
+ * Color and attribute parsing
+ */
+
 #include "config.h"
 #include <regex.h>
 #include <stdbool.h>
index 758dfc112dafc9751e407cc1801df6f13c20c1a8..b4671330b63c7d74d3e46308b6cf74e63b147a25 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page commands Manage where the email is piped to external commands
+ *
+ * Manage where the email is piped to external commands
+ */
+
 #include "config.h"
 #include <errno.h>
 #include <limits.h>
index 8081409db5e64f284564044776786b08c3b737e4..b8b03a25702b97a9bdc65c2fdac6a59479982a3f 100644 (file)
--- a/compose.c
+++ b/compose.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page compose GUI editor for an email's headers
+ *
+ * GUI editor for an email's headers
+ */
+
 #include "config.h"
 #include <errno.h>
 #include <limits.h>
index 602901b16156be6a74d4c32ceca4ce876ec98701..06e69463c396031b36331ad826822b2ab722b69f 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page curs_lib GUI miscellaneous curses (window drawing) routines
+ *
+ * GUI miscellaneous curses (window drawing) routines
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include <ctype.h>
diff --git a/edit.c b/edit.c
index 5d59e68dfc6f324ad74964419bb4f29cb66844d7..470a1f9516154bd5a149738a0b086db0d643bb9c 100644 (file)
--- a/edit.c
+++ b/edit.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page edit GUI basic built-in text editor
+ *
+ * GUI basic built-in text editor
+ */
+
 /* Close approximation of the mailx(1) builtin editor for sending mail. */
 
 #include "config.h"
index d585dc93da2e72559925620cc30ba9c8a670c8d5..9f10472f3b8b05c4a858831e954c67c332f30d85 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page enriched Rich text handler
+ *
+ * Rich text handler
+ */
+
 /**
  * A (not so) minimal implementation of RFC1563.
  */
diff --git a/group.c b/group.c
index d8e243856eb68b41235051e6cabe2602a32fac7e..7ed3f0dd255baf8b3f2fe09941ac4ac4704056e1 100644 (file)
--- a/group.c
+++ b/group.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page group Handling for email address groups
+ *
+ * Handling for email address groups
+ */
+
 #include "config.h"
 #include <stdbool.h>
 #include <stdlib.h>
index edbd111ac7474f4076b21ab42c74d4a1241e0216..ae056c5db13809125d9a6e54fe4a1ac6da4609f8 100644 (file)
--- a/handler.c
+++ b/handler.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page handler Decide how to display email content
+ *
+ * Decide how to display email content
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include <ctype.h>
index 78854a9c0ed575dc6e612659c594dfc9b7bc9188..93917f6834a51f0b7c52ddb1bbd5de583f70a3f7 100644 (file)
--- a/hdrline.c
+++ b/hdrline.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page hdrline String processing routines to generate the mail index
+ *
+ * String processing routines to generate the mail index
+ */
+
 #include "config.h"
 #include <locale.h>
 #include <stdbool.h>
diff --git a/help.c b/help.c
index e2c3499dace5c12f5de52911451245ef8d394fab..30f913454e6d2d5b3a8cb61f05c8f2605a739801 100644 (file)
--- a/help.c
+++ b/help.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page help Generate the help-line and help-page and GUI display them
+ *
+ * Generate the help-line and help-page and GUI display them
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include <limits.h>
diff --git a/index.c b/index.c
index 1e13b7496c06ba094ab5becb39d63f47ff924562..d68da0ef69d4f444e0355489c1f171ff436b0654 100644 (file)
--- a/index.c
+++ b/index.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page index2 GUI manage the main index (list of emails)
+ *
+ * GUI manage the main index (list of emails)
+ */
+
 #include "config.h"
 #include <assert.h>
 #include <ctype.h>
diff --git a/init.c b/init.c
index 3cb097f2459543e52dca27e4cde94e8a31e35a52..fa5cb1ca50bcf27a2e3dd0559f2612146e512146 100644 (file)
--- a/init.c
+++ b/init.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page init Config/command parsing
+ *
+ * Config/command parsing
+ */
+
 #include "config.h"
 #include <ctype.h>
 #include <errno.h>
index b3162c14cc5f5753ee3857b006a3c0f5ba349f9a..fe8bd7b8216a546b3385881601819b03d811a3ce 100644 (file)
--- a/keymap.c
+++ b/keymap.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page keymap Manage keymappings
+ *
+ * Manage keymappings
+ */
+
 #include "config.h"
 #include <ctype.h>
 #include <limits.h>
index 30ab7a78e3b396d5cfbf81d43287b4a4c79a342c..60e1dfb7ce942bd8927c6458681ddcd084de0bdc 100644 (file)
--- a/mailbox.c
+++ b/mailbox.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mailbox Representation of a mailbox
+ *
+ * Representation of a mailbox
+ */
+
 #include "config.h"
 #include <dirent.h>
 #include <limits.h>
diff --git a/menu.c b/menu.c
index 681a187006ee7cee66ede8e4d63cdbfe2defe874..5b0932fbba71bbb202b17494669721bd3d934cdf 100644 (file)
--- a/menu.c
+++ b/menu.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page menu GUI present the user with a selectable list
+ *
+ * GUI present the user with a selectable list
+ */
+
 #include "config.h"
 #include <regex.h>
 #include <stdbool.h>
index a0088c61f819d75d6421c1ed79ba70dfdccc7dce..1034adfd740328aa96bcef444980384533f37a48 100644 (file)
--- a/monitor.c
+++ b/monitor.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page monitor Monitor files for changes
+ *
+ * Monitor files for changes
+ */
+
 #include "config.h"
 #include <errno.h>
 #include <limits.h>
index 6ce8ad86d5c26cfa2975f90ab7aab79608d931f2..c2f3e5bb788143cb07c4776b596ce1b5a48c85c9 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mutt_attach Handling of email attachments
+ *
+ * Handling of email attachments
+ */
+
 #include "config.h"
 #include <errno.h>
 #include <fcntl.h>
index 75761d9a98ca0c5097556a31de9f15e1e5e48bfc..788a97528bf657783a38db2e872b2df03b05a3dc 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mutt_body Representation of the body of an email
+ *
+ * Representation of the body of an email
+ */
+
 #include "config.h"
 #include <limits.h>
 #include <stdbool.h>
index 322ef53cc85fb88a5ca90f8b1f5655c151aeed5a..a29e0b4f4705c233e1f3b3c410ae28cae295789e 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mutt_header Manipulate an email's header
+ *
+ * Manipulate an email's header
+ */
+
 #include "config.h"
 #include <limits.h>
 #include <stdbool.h>
index 3bcbc57e01f3452e76e1d8f7fd0e4c5a2d81abfd..09d08815a4944f72e2bd0509cbb1ca176a407b7e 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mutt_history Read/write command history from/to a file
+ *
+ * Read/write command history from/to a file
+ */
+
 #include "config.h"
 #include <stdio.h>
 #include "mutt/mutt.h"
index f9164958807f8627dab70b3ba919d8025a4a9fdb..e3dbece078174a15255627573cb852d779e8be8d 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mutt_lua Integrated Lua scripting
+ *
+ * Integrated Lua scripting
+ */
+
 #include "config.h"
 #include <lauxlib.h>
 #include <limits.h>
index b607d326cde3951c7353cb0b86c0711e4c519e01..c858e612c42b8c74fd1626f5e0de1a8fcde47720 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mutt_parse Miscellaneous email parsing routines
+ *
+ * Miscellaneous email parsing routines
+ */
+
 #include "config.h"
 #include <regex.h>
 #include <stdbool.h>
index 5a303da33076eb4fa2948933ad9cda8320ad49a1..9f46b170d083de074bb4a802d2a28016d660745e 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mutt_thread Create/manipulate threading in emails
+ *
+ * Create/manipulate threading in emails
+ */
+
 #include "config.h"
 #include <limits.h>
 #include <stdbool.h>
index ac5138d9598416a3f52d7f5fbd5a60fd2323ef32..2617223ec478ddc4b09a87a8d78df4195747062d 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page mutt_url Parse and identify different URL schemes
+ *
+ * Parse and identify different URL schemes
+ */
+
 #include "config.h"
 #include <ctype.h>
 #include <stdbool.h>
index b8ad3ef0e4f588c9e916a5615dfdf4fa6d7adda4..05b1e3c497ccac66b6ea81c0e0d3d2ba3a7e03ad 100644 (file)
--- a/muttlib.c
+++ b/muttlib.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page muttlib Some miscellaneous functions
+ *
+ * Some miscellaneous functions
+ */
+
 #include "config.h"
 #include <ctype.h>
 #include <errno.h>
diff --git a/myvar.c b/myvar.c
index c50efce3796e5222df0b487b6964a14b3bc554c5..0fab45cfac123bc4d85de8a3a923b45283810788 100644 (file)
--- a/myvar.c
+++ b/myvar.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page myvar Handling of personal config ('my' variables)
+ *
+ * Handling of personal config ('my' variables)
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include "mutt/mutt.h"
index ad63b6d50d83f95b1f05d8060d0ca8c0f4f4b66e..d2cd3ca361936faca90c351e4291448007445819 100644 (file)
  *
  * Usenet network mailbox type; talk to an NNTP server
  *
- * | File          | Description          |
- * | :------------ | :------------------- |
- * | nntp/newsrc.c | @subpage nntp_newsrc |
- * | nntp/nntp.c   | @subpage nntp_nntp   |
+ * | File            | Description            |
+ * | :-------------- | :--------------------- |
+ * | nntp/browse.c   | @subpage nntp_browse   |
+ * | nntp/complete.c | @subpage nntp_complete |
+ * | nntp/newsrc.c   | @subpage nntp_newsrc   |
+ * | nntp/nntp.c     | @subpage nntp_nntp     |
  */
 
 #ifndef MUTT_NNTP_NNTP_H
index e1643f40a7144387ce3e86184cbed4f063322552..01e3cafc7f8b3efe6b728c007b6843547e2ebf9f 100644 (file)
@@ -28,6 +28,7 @@
  * | File                   | Description         |
  * | :--------------------- | :------------------ |
  * | notmuch/mutt_notmuch.c | @subpage nm_notmuch |
+ * | notmuch/nm_db.c        | @subpage nm_db      |
  */
 
 #ifndef MUTT_NOTMUCH_MUTT_NOTMUCH_H
index 1fd7f3490a809a455489aa8ab6e76212ac94fc6b..bde9f7359ebcd63fcd32708221093d5a3c47244b 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page nm_db Notmuch database handling
+ *
+ * Notmuch database handling
+ */
+
 #include "config.h"
 #include <notmuch.h>
 #include <string.h>
diff --git a/pager.c b/pager.c
index 6ac430ca7851a2a1c7e0d947ab55b27e478c203c..6a74a15ea78c43869678713c2ba5211f7e554ef0 100644 (file)
--- a/pager.c
+++ b/pager.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page pager GUI display a file/email/help in a viewport with paging
+ *
+ * GUI display a file/email/help in a viewport with paging
+ */
+
 #include "config.h"
 #include <ctype.h>
 #include <errno.h>
index 1ae9ba16add6ef5c1aaae3bd04b832714399140e..2b33cc60f9d20dc462893afd8043ef9e54fd6476 100644 (file)
--- a/pattern.c
+++ b/pattern.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page pattern Match patterns to emails
+ *
+ * Match patterns to emails
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include <ctype.h>
diff --git a/query.c b/query.c
index 18c8b23aecb351933fa48be26e4e0d5562ed5c88..ee8a444caea197cd519bc61f8b8b4d050483dade 100644 (file)
--- a/query.c
+++ b/query.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page query Routines for querying and external address book
+ *
+ * Routines for querying and external address book
+ */
+
 #include "config.h"
 #include <regex.h>
 #include <stdbool.h>
index 6dd744e2f139909698c32ee4faa07f1c09a5b8bb..7277a3a7754203906cc0a1ccccabb9ccd353478a 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page recvattach Routines for managing attachments
+ *
+ * Routines for managing attachments
+ */
+
 #include "config.h"
 #include <limits.h>
 #include <stdbool.h>
index a7d357d4e392c622a05c06d812b9a2aaa4790bd6..05f1b81d33e1e5164102d7db496e751ee5d14571 100644 (file)
--- a/recvcmd.c
+++ b/recvcmd.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page recvcmd Send/reply with an attachment
+ *
+ * Send/reply with an attachment
+ */
+
 #include "config.h"
 #include <limits.h>
 #include <stdbool.h>
index e800f2c4ec21a6543bdbf6d7467310a25268b702..9b7431197eede2be8935715a0bb0bbb2fa9b0fe7 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page remailer Support of Mixmaster anonymous remailer
+ *
+ * Support of Mixmaster anonymous remailer
+ */
+
 #include "config.h"
 #include <fcntl.h>
 #include <stdbool.h>
index 227e06d1fdae3e59918a57fc91612383260c5c8e..ff61aad9bff6ad3dda0f89a1c49441ef2bd5b60d 100644 (file)
--- a/rfc3676.c
+++ b/rfc3676.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page rfc3676 RFC3676 Format Flowed routines
+ *
+ * RFC3676 Format Flowed routines
+ */
+
 #include "config.h"
 #include <limits.h>
 #include <stdbool.h>
diff --git a/score.c b/score.c
index 9069d9559b5c2676a3be72a15846ccda7a1d4e21..588667d1c300850fe370da99b48e761bd04e3fb0 100644 (file)
--- a/score.c
+++ b/score.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page score Routines for adding user scores to emails
+ *
+ * Routines for adding user scores to emails
+ */
+
 #include "config.h"
 #include <stdbool.h>
 #include <stdlib.h>
diff --git a/send.c b/send.c
index 0634cf94f94905ffa79cf7a55c3dd809b4d00ee4..a544ac5438875deab9e8d8edfe3b9c2a84e2a3c5 100644 (file)
--- a/send.c
+++ b/send.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page send Prepare and send an email
+ *
+ * Prepare and send an email
+ */
+
 #include "config.h"
 #include <errno.h>
 #include <limits.h>
index 33cb2a58eaa198ede1405b01db17a44d2e57a407..3f66f192b4999953fed59b5f1824d92408bf5097 100644 (file)
--- a/sendlib.c
+++ b/sendlib.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page sendlib Miscellaneous functions for sending an email
+ *
+ * Miscellaneous functions for sending an email
+ */
+
 #include "config.h"
 #include <errno.h>
 #include <fcntl.h>
diff --git a/smtp.c b/smtp.c
index 9a0489260e26e54f5561362791e6ba78fe6af63b..32330aed0a30e48a3eee685b6563d4269e4b5088 100644 (file)
--- a/smtp.c
+++ b/smtp.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page smtp Send email to an SMTP server
+ *
+ * Send email to an SMTP server
+ */
+
 /* This file contains code for direct SMTP delivery of email messages. */
 
 #include "config.h"
diff --git a/sort.c b/sort.c
index 321a4a090b53bd2a42f9ceae7f0c07fce63b9bd6..b9fa3138086e7460ab1105d0ba19a98d664c1d38 100644 (file)
--- a/sort.c
+++ b/sort.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page sort Assorted sorting methods
+ *
+ * Assorted sorting methods
+ */
+
 #include "config.h"
 #include <stdbool.h>
 #include <stdlib.h>
diff --git a/state.c b/state.c
index 2b8657ae9ecd4c6892306c533bcd01bf363e1df6..bb3a38e5d20a55c5f9206a6b74dc81c986793091 100644 (file)
--- a/state.c
+++ b/state.c
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page state Keep track when processing files
+ *
+ * Keep track when processing files
+ */
+
 #include "config.h"
 #include <limits.h>
 #include <stdarg.h>
index 5156e5eaec1a6e09976e92bc46a94be90de08d6c..612cfbfed79e446c1cc997e51c53858b1ffc7043 100644 (file)
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page wcscasecmp For systems lacking wcscasecmp()
+ *
+ * For systems lacking wcscasecmp()
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include <wctype.h>