]> granicus.if.org Git - neomutt/commitdiff
doxygen tidying
authorRichard Russon <rich@flatcap.org>
Fri, 19 Jan 2018 01:12:34 +0000 (01:12 +0000)
committerRichard Russon <rich@flatcap.org>
Wed, 24 Jan 2018 22:59:44 +0000 (22:59 +0000)
conn/conn.h
doxygen/layout.xml
hcache/hcache.h
imap/auth_cram.c
imap/imap.h
mutt/charset.c
mutt/mutt.h

index 1fb506227c0d605ba2f044d94b9dc5dcd7dfe38e..a4f822b31e702e02a9c265e9f85424370e7f485e 100644 (file)
  *
  * Manage external connections.
  *
- * -# @subpage conn_globals
- * -# @subpage conn_getdomain
- * -# @subpage conn_sasl
- * -# @subpage conn_sasl_plain
- * -# @subpage conn_socket
- * -# @subpage conn_ssl
- * -# @subpage conn_ssl_gnutls
- * -# @subpage conn_tunnel
+ * | File                | Description              |
+ * | :------------------ | :----------------------- |
+ * | conn/conn_globals.c | @subpage conn_globals    |
+ * | conn/getdomain.c    | @subpage conn_getdomain  |
+ * | conn/sasl.c         | @subpage conn_sasl       |
+ * | conn/sasl_plain.c   | @subpage conn_sasl_plain |
+ * | conn/socket.c       | @subpage conn_socket     |
+ * | conn/ssl.c          | @subpage conn_ssl        |
+ * | conn/ssl_gnutls.c   | @subpage conn_ssl_gnutls |
+ * | conn/tunnel.c       | @subpage conn_tunnel     |
  */
 
 #ifndef _CONN_CONN_H
index 8709565a9b16e0e3ec585c7caf420251573eb0e1..6c5ac69483b2eeb1471e089d82d828e4165e5d07 100644 (file)
@@ -15,7 +15,7 @@
     </tab>
     <tab type="examples" visible="yes" title="" intro=""/>
     <tab type="usergroup" url="pages.html" title="Libraries">
-       <tab type="pages" visible="yes" title="Libraries" intro="These libraries contain are an attempt to make NeoMutt more modular."/>
+      <tab type="pages" visible="yes" title="Libraries" intro="These libraries contain are an attempt to make NeoMutt more modular."/>
     </tab>
     <tab type="modules" visible="yes" title="" intro=""/>
     <tab type="namespaces" visible="yes" title="">
index e2de88bd5adb759d17d0a968d988769bcb8565ea..7b00ac228f453f249c816329cec4d4f032341ab0 100644 (file)
  * This module defines the user-visible header cache API, which is used within
  * neomutt to cache and restore mail header data.
  *
- * @note This library isn't completely independent.
- * Dependencies:
- * - \ref mutt
- * - Global variables
- *   * Charset
- *   * Charset_is_utf8
- *   * HeaderCacheBackend
- *   * HeaderCachePageSize
- *   * Options
- *   * SpamList
- *   * NoSpamList
- * - Neomutt functions
- *   * mutt_ch_convert_string()
- *   * mutt_encode_path()
- *   * mutt_new_body()
- *   * mutt_env_new()
- *   * mutt_sleep()
- *   * mx_lock_file()
- *   * mx_unlock_file()
- *
  * @subpage hc_hcache
  *
  * Backends:
  *
- * -# @subpage hc_bdb
- * -# @subpage hc_gdbm
- * -# @subpage hc_kc
- * -# @subpage hc_lmdb
- * -# @subpage hc_qdbm
- * -# @subpage hc_tc
+ * | File          | Description      |
+ * | :------------ | :--------------- |
+ * | hcache/bdb.c  | @subpage hc_bdb  |
+ * | hcache/gdbm.c | @subpage hc_gdbm |
+ * | hcache/kc.c   | @subpage hc_kc   |
+ * | hcache/lmdb.c | @subpage hc_lmdb |
+ * | hcache/qdbm.c | @subpage hc_qdbm |
+ * | hcache/tc.c   | @subpage hc_tc   |
  */
 
 #ifndef _MUTT_HCACHE_H
index ddf3d343344569946c1c2fd0302268647dd969fc..d38f5b8479f0e1b3d50ea5345403ae3b264243ec 100644 (file)
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page imap_auth_crap IMAP CRAM-MD5 authentication method
+ * @page imap_auth_cram IMAP CRAM-MD5 authentication method
  *
  * IMAP CRAM-MD5 authentication method
  *
index f366e72eb50a89d37ebd08bf57b88000296bc6eb..8640e30cf9f65a4e9449ceb2210b6d7bd26e33ad 100644 (file)
  *
  * IMAP network mailbox
  *
- * -# @subpage imap_imap
- * -# @subpage imap_auth_anon
- * -# @subpage imap_auth
- * -# @subpage imap_auth_crap
- * -# @subpage imap_auth_gss
- * -# @subpage imap_auth_login
- * -# @subpage imap_auth_plain
- * -# @subpage imap_auth_sasl
- * -# @subpage imap_browse
- * -# @subpage imap_command
- * -# @subpage imap_message
- * -# @subpage imap_utf7
- * -# @subpage imap_util
+ * | File              | Description              |
+ * | :---------------- | :----------------------- |
+ * | imap/imap.c       | @subpage imap_imap       |
+ * | imap/auth_anon.c  | @subpage imap_auth_anon  |
+ * | imap/auth.c       | @subpage imap_auth       |
+ * | imap/auth_cram.c  | @subpage imap_auth_cram  |
+ * | imap/auth_gss.c   | @subpage imap_auth_gss   |
+ * | imap/auth_login.c | @subpage imap_auth_login |
+ * | imap/auth_plain.c | @subpage imap_auth_plain |
+ * | imap/auth_sasl.c  | @subpage imap_auth_sasl  |
+ * | imap/browse.c     | @subpage imap_browse     |
+ * | imap/command.c    | @subpage imap_command    |
+ * | imap/message.c    | @subpage imap_message    |
+ * | imap/utf7.c       | @subpage imap_utf7       |
+ * | imap/util.c       | @subpage imap_util       |
  */
 
 #ifndef _IMAP_IMAP_H
index 5557fe31ebc8144a85d8a505c43e8338e888078d..9088fcc6a6c773c0a711097247cdf4897bc1a1c3 100644 (file)
@@ -287,7 +287,7 @@ static const char *lookup_charset(enum LookupType type, const char *cs)
 
 /**
  * mutt_ch_convert_nonmime_string - Try to convert a string using a list of character sets
- * @param ps[in,out] String to be converted
+ * @param[in,out] ps String to be converted
  * @retval 0  Success
  * @retval -1 Error
  *
index 6ff65b84aba835bbea5745769f20be67d7c231b3..5d4e5a7e88fb1419f3441d740fa9de01663fd01f 100644 (file)
  *
  * Each source file in the library provides a group of related functions.
  *
+ * | File           | Description      |
+ * | :------------- | :--------------- |
+ * | mutt/base64.c  | @subpage base64  |
+ * | mutt/buffer.c  | @subpage buffer  |
+ * | mutt/charset.c | @subpage charset |
+ * | mutt/date.c    | @subpage date    |
+ * | mutt/debug.c   | @subpage debug   |
+ * | mutt/exit.c    | @subpage exit    |
+ * | mutt/file.c    | @subpage file    |
+ * | mutt/hash.c    | @subpage hash    |
+ * | mutt/idna.c    | @subpage idna    |
+ * | mutt/list.c    | @subpage list    |
+ * | mutt/mapping.c | @subpage mapping |
+ * | mutt/mbyte.c   | @subpage mbyte   |
+ * | mutt/md5.c     | @subpage md5     |
+ * | mutt/memory.c  | @subpage memory  |
+ * | mutt/message.c | @subpage message |
+ * | mutt/mime.c    | @subpage mime    |
+ * | mutt/regex.c   | @subpage regex   |
+ * | mutt/rfc2047.c | @subpage rfc2047 |
+ * | mutt/sha1.c    | @subpage sha1    |
+ * | mutt/signal.c  | @subpage signal  |
+ * | mutt/string.c  | @subpage string  |
+ *
  * @note The library is self-contained -- some files may depend on others in
  *       the library, but none depends on source from outside.
- *
- * -# @subpage base64
- * -# @subpage buffer
- * -# @subpage charset
- * -# @subpage date
- * -# @subpage debug
- * -# @subpage exit
- * -# @subpage file
- * -# @subpage hash
- * -# @subpage idna
- * -# @subpage list
- * -# @subpage mapping
- * -# @subpage mbyte
- * -# @subpage md5
- * -# @subpage memory
- * -# @subpage message
- * -# @subpage mime
- * -# @subpage regex
- * -# @subpage sha1
- * -# @subpage signal
- * -# @subpage string
  */
 
 #ifndef _MUTT_MUTT_H