doxy: tidy libraries

georgalis · Aug 2, 2021 · 0ed1908 · 0ed1908
1 parent d847a5d
commit 0ed1908
Show file tree

Hide file tree

Showing 34 changed files with 64 additions and 78 deletions.
diff --git a/address/lib.h b/address/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page lib_address ADDRESS: Email Address Handling
+ * @page lib_address Address
  *
  * Email Address Handling
  *

diff --git a/alias/lib.h b/alias/lib.h
@@ -21,9 +21,9 @@
  */
 
 /**
- * @page lib_alias ALIAS: Email Aliases
+ * @page lib_alias Alias
  *
- * Email Aliases
+ * Email Aliases (Address Book)
  *
  * | File                | Description                |
  * | :------------------ | :------------------------- |

diff --git a/autocrypt/lib.h b/autocrypt/lib.h
@@ -21,7 +21,9 @@
  */
 
 /**
- * @page lib_autocrypt AUTOCRYPT: End-to-end encryption
+ * @page lib_autocrypt Autocrypt
+ *
+ * End-to-end encryption
  *
  * This is an implementation of Autocrypt Level 1.1. https://autocrypt.org/
  *

diff --git a/bcache/lib.h b/bcache/lib.h
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page lib_bcache BCACHE: Body Caching - local copies of email bodies
+ * @page lib_bcache Bcache
  *
  * Body Caching - local copies of email bodies
  *

diff --git a/compmbox/lib.h b/compmbox/lib.h
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page lib_compmbox COMPMBOX: Compressed Mailbox
+ * @page lib_compmbox Compmbox
  *
  * Compressed mbox local mailbox type
  *

diff --git a/compose/lib.h b/compose/lib.h
@@ -21,9 +21,9 @@
  */
 
 /**
- * @page lib_compose COMPOSE: Display and edit an email's headers
+ * @page lib_compose Compose
  *
- * Display the mailboxes in a side panel
+ * Compose an email
  *
  * | File                   | Description                    |
  * | :--------------------- | :----------------------------- |

diff --git a/compress/lib.h b/compress/lib.h
@@ -21,7 +21,9 @@
  */
 
 /**
- * @page lib_compress COMPRESS: Data compression
+ * @page lib_compress Compress
+ *
+ * Data compression
  *
  * These compression methods are used by the \ref hcache.
  *

diff --git a/config/lib.h b/config/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page lib_config CONFIG: Flexible handling of config items
+ * @page lib_config Config
  *
  * User configurable variables.
  *

diff --git a/conn/lib.h b/conn/lib.h
@@ -21,9 +21,9 @@
  */
 
 /**
- * @page lib_conn CONN: Network connections and their encryption
+ * @page lib_conn Conn
  *
- * Manage external connections.
+ * Network connections and their encryption
  *
  * | File                | Description              |
  * | :------------------ | :----------------------- |

diff --git a/core/lib.h b/core/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page lib_core CORE: Backbone objects of NeoMutt
+ * @page lib_core Core
  *
  * Backbone objects of NeoMutt
  *

diff --git a/debug/lib.h b/debug/lib.h
@@ -21,9 +21,9 @@
  */
 
 /**
- * @page lib_debug DEBUG: Debugging tools
+ * @page lib_debug Debug
  *
- * Debugging tools
+ * Debugging code
  *
  * | File                | Description                |
  * | :------------------ | :------------------------- |

diff --git a/email/lib.h b/email/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page lib_email EMAIL: Structs that make up an email
+ * @page lib_email Email
  *
  * Structs that make up an email
  *

diff --git a/gui/lib.h b/gui/lib.h
@@ -21,9 +21,9 @@
  */
 
 /**
- * @page lib_gui GUI: Graphical code
+ * @page lib_gui Gui
  *
- * Curses and Window code.
+ * Curses and Window code
  *
  * | File                | Description                |
  * | :------------------ | :------------------------- |

diff --git a/hcache/lib.h b/hcache/lib.h
@@ -25,7 +25,9 @@
  */
 
 /**
- * @page lib_hcache HCACHE: Header cache API
+ * @page lib_hcache Hcache
+ *
+ * Cache of Email headers
  *
  * The Header Cache saves data from email headers to a local store in order to
  * speed up network mailboxes.

diff --git a/helpbar/lib.h b/helpbar/lib.h
@@ -22,7 +22,9 @@
  */
 
 /**
- * @page lib_helpbar HELPBAR: Help line showing key bindings
+ * @page lib_helpbar Helpbar
+ *
+ * Help line showing key bindings
  *
  * This one-line Window lives at the top of the screen.
  * It displays some commonly-used key bindings for the current screen.

diff --git a/history/lib.h b/history/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page lib_history HISTORY: Read/write command history from/to a file
+ * @page lib_history History
  *
  * Read/write command history from/to a file
  *

diff --git a/imap/lib.h b/imap/lib.h
@@ -23,7 +23,7 @@
  */
 
 /**
- * @page lib_imap IMAP: Network Mailbox
+ * @page lib_imap Imap
  *
  * IMAP network mailbox
  *

diff --git a/index/lib.h b/index/lib.h
@@ -21,9 +21,9 @@
  */
 
 /**
- * @page lib_index INDEX: GUI manage the main index (list of emails)
+ * @page lib_index Index
  *
- * GUI manage the main index (list of emails)
+ * Display a list of Emails
  *
  * | File                 | Description                 |
  * | :------------------- | :-------------------------- |

diff --git a/maildir/lib.h b/maildir/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page lib_maildir MAILDIR: Local mailbox type
+ * @page lib_maildir Maildir
  *
  * Maildir local mailbox type
  *

diff --git a/main.c b/main.c
@@ -39,50 +39,24 @@
  *
  * ## Libraries
  *
- * Each library helps to untangle the code by grouping similar functions and
- * reducing dependencies.
+ * [Each library](pages.html) helps to untangle the code by grouping similar
+ * functions and reducing dependencies.
  *
  * The goal is that each library is:
  * - Self-contained (it may rely on other libraries)
  * - Independently testable (i.e. without using NeoMutt)
  * - Fully documented
  * - Robust
  *
- * | Library            |
- * | :----------------- |
- * | @ref lib_address   |
- * | @ref lib_alias     |
- * | @ref lib_autocrypt |
- * | @ref lib_bcache    |
- * | @ref lib_compmbox  |
- * | @ref lib_compose   |
- * | @ref lib_compress  |
- * | @ref lib_config    |
- * | @ref lib_conn      |
- * | @ref lib_core      |
- * | @ref lib_debug     |
- * | @ref lib_email     |
- * | @ref lib_gui       |
- * | @ref lib_hcache    |
- * | @ref lib_helpbar   |
- * | @ref lib_history   |
- * | @ref lib_imap      |
- * | @ref lib_index     |
- * | @ref lib_maildir   |
- * | @ref lib_mbox      |
- * | @ref lib_menu      |
- * | @ref lib_mutt      |
- * | @ref lib_ncrypt    |
- * | @ref lib_nntp      |
- * | @ref lib_notmuch   |
- * | @ref lib_pager     |
- * | @ref lib_pattern   |
- * | @ref lib_pop       |
- * | @ref lib_progress  |
- * | @ref lib_question  |
- * | @ref lib_send      |
- * | @ref lib_sidebar   |
- * | @ref lib_store     |
+ * Libraries:
+ * @ref lib_address, @ref lib_alias, @ref lib_autocrypt, @ref lib_bcache,
+ * @ref lib_compmbox, @ref lib_compose, @ref lib_compress, @ref lib_config,
+ * @ref lib_conn, @ref lib_core, @ref lib_debug, @ref lib_email, @ref lib_gui,
+ * @ref lib_hcache, @ref lib_helpbar, @ref lib_history, @ref lib_imap,
+ * @ref lib_index, @ref lib_maildir, @ref lib_mbox, @ref lib_menu,
+ * @ref lib_mutt, @ref lib_ncrypt, @ref lib_nntp, @ref lib_notmuch,
+ * @ref lib_pager, @ref lib_pattern, @ref lib_pop, @ref lib_progress,
+ * @ref lib_question, @ref lib_send, @ref lib_sidebar, @ref lib_store.
  *
  * ## Miscellaneous files
  *

diff --git a/mbox/lib.h b/mbox/lib.h
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page lib_mbox MBOX: Local mailbox type
+ * @page lib_mbox Mbox
  *
  * Mbox local mailbox type
  *

diff --git a/menu/lib.h b/menu/lib.h
@@ -21,9 +21,9 @@
  */
 
 /**
- * @page lib_menu MENU: GUI present the user with a selectable list
+ * @page lib_menu Menu
  *
- * GUI present the user with a selectable list
+ * A selectable list
  *
  * | File             | Description             |
  * | :--------------- | :---------------------- |

diff --git a/mutt/lib.h b/mutt/lib.h
@@ -21,7 +21,9 @@
  */
 
 /**
- * @page lib_mutt MUTT: Shared code for handling strings, files, dates, etc
+ * @page lib_mutt Mutt
+ *
+ * Shared code for handling strings, files, dates, etc
  *
  * Each source file in the library provides a group of related functions.
  *

diff --git a/ncrypt/lib.h b/ncrypt/lib.h
@@ -23,7 +23,7 @@
  */
 
 /**
- * @page lib_ncrypt NCRYPT: Encrypt/decrypt/sign/verify emails
+ * @page lib_ncrypt Ncrypt
  *
  * Encrypt/decrypt/sign/verify emails
  *

diff --git a/nntp/lib.h b/nntp/lib.h
@@ -23,7 +23,7 @@
  */
 
 /**
- * @page lib_nntp NNTP: Usenet network mailbox type; talk to an NNTP server
+ * @page lib_nntp Nntp
  *
  * Usenet network mailbox type; talk to an NNTP server
  *

diff --git a/notmuch/lib.h b/notmuch/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page lib_notmuch NOTMUCH: Virtual mailbox type
+ * @page lib_notmuch Notmuch
  *
  * Notmuch virtual mailbox type
  *

diff --git a/pager/lib.h b/pager/lib.h
@@ -21,9 +21,9 @@
  */
 
 /**
- * @page lib_pager PAGER: GUI display contents of an email or help
+ * @page lib_pager Pager
  *
- * GUI Display contents of an email or help
+ * Display contents of an email or help
  *
  * | File                 | Description                 |
  * | :------------------- | :-------------------------- |

diff --git a/pattern/lib.h b/pattern/lib.h
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page lib_pattern PATTERN: Match patterns to emails
+ * @page lib_pattern Pattern
  *
  * Match patterns to emails
  *

diff --git a/pop/lib.h b/pop/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page lib_pop POP: Network mailbox
+ * @page lib_pop Pop
  *
  * POP network mailbox
  *

diff --git a/progress/lib.h b/progress/lib.h
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page lib_progress PROGRESS: Progress Bar
+ * @page lib_progress Progress
  *
  * Progress Bar
  *

diff --git a/question/lib.h b/question/lib.h
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page lib_question QUESTION: Ask the user a question
+ * @page lib_question Question
  *
  * Ask the user a question
  *

diff --git a/send/lib.h b/send/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page lib_send SEND: Shared code for sending Emails
+ * @page lib_send Send
  *
  * Shared code for sending Emails
  *

diff --git a/sidebar/lib.h b/sidebar/lib.h
@@ -23,7 +23,7 @@
  */
 
 /**
- * @page lib_sidebar SIDEBAR: Display the mailboxes in a side panel
+ * @page lib_sidebar Sidebar
  *
  * Display the mailboxes in a side panel
  *

diff --git a/store/lib.h b/store/lib.h
@@ -22,7 +22,9 @@
  */
 
 /**
- * @page lib_store STORE: Key value store
+ * @page lib_store Store
+ *
+ * Key value store
  *
  * These databases provide Key/Value storage for NeoMutt.
  * They are used by the \ref hcache.
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,7 +21,7 @@ @@
      */
     /**
-     * @page lib_address ADDRESS: Email Address Handling
+     * @page lib_address Address
      *
      * Email Address Handling
      *
@@ Expand Down @@