doxy: rename pages

Improve the consistency of page naming.
gui-co · Sep 6, 2020 · 346364c · 346364c
1 parent 8a6a581
commit 346364c
Show file tree

Hide file tree

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

diff --git a/alias/lib.h b/alias/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page alias ALIAS: Email Aliases
+ * @page lib_alias ALIAS: Email Aliases
  *
  * Email Aliases
  *

diff --git a/autocrypt/lib.h b/autocrypt/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page 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/bcache.c b/bcache/bcache.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page bcache BCACHE: Body Caching - local copies of email bodies
+ * @page bcache_bcache Body Caching - local copies of email bodies
  *
  * Body Caching - local copies of email bodies
  */

diff --git a/bcache/lib.h b/bcache/lib.h
@@ -21,6 +21,16 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page lib_bcache BCACHE: Body Caching - local copies of email bodies
+ *
+ * Body Caching - local copies of email bodies
+ *
+ * | File                | Description                |
+ * | :------------------ | :------------------------- |
+ * | bcache/bcache.c     | @subpage bcache_bcache     |
+ */
+
 #ifndef MUTT_BCACHE_LIB_H
 #define MUTT_BCACHE_LIB_H
 

diff --git a/browser.c b/browser.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page browser GUI component for displaying/selecting items from a list
+ * @page neo_browser GUI component for displaying/selecting items from a list
  *
  * GUI component for displaying/selecting items from a list
  */

diff --git a/command_parse.c b/command_parse.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page command_parse Functions to parse commands in a config file
+ * @page neo_command_parse Functions to parse commands in a config file
  *
  * Functions to parse commands in a config file
  */

diff --git a/commands.c b/commands.c
@@ -23,7 +23,7 @@
  */
 
 /**
- * @page commands Manage where the email is piped to external commands
+ * @page neo_commands Manage where the email is piped to external commands
  *
  * Manage where the email is piped to external commands
  */

diff --git a/complete.c b/complete.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page complete String auto-completion routines
+ * @page neo_complete String auto-completion routines
  *
  * String auto-completion routines
  */

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

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

diff --git a/compress/lib.h b/compress/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page 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 config CONFIG: Flexible handling of config items
+ * @page lib_config CONFIG: Flexible handling of config items
  *
  * User configurable variables.
  *

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

diff --git a/context.c b/context.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page ctx The "currently-open" mailbox
+ * @page neo_ctx The "currently-open" mailbox
  *
  * The "currently-open" mailbox
  */

diff --git a/copy.c b/copy.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page copy Duplicate the structure of an entire email
+ * @page neo_copy Duplicate the structure of an entire email
  *
  * Duplicate the structure of an entire email
  */

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

diff --git a/debug/lib.h b/debug/lib.h
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page debug DEBUG: Debugging tools
+ * @page lib_debug DEBUG: Debugging tools
  *
  * Debugging tools
  *

diff --git a/editmsg.c b/editmsg.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page editmsg Prepare an email to be edited
+ * @page neo_editmsg Prepare an email to be edited
  *
  * Prepare an email to be edited
  */

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

diff --git a/enriched.c b/enriched.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page enriched Rich text handler
+ * @page neo_enriched Rich text handler
  *
  * Rich text handler
  */

diff --git a/enter.c b/enter.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page enter GUI ask the user to enter a string
+ * @page neo_enter GUI ask the user to enter a string
  *
  * GUI ask the user to enter a string
  */

diff --git a/flags.c b/flags.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page flags Manipulate the flags in an email header
+ * @page neo_flags Manipulate the flags in an email header
  *
  * Manipulate the flags in an email header
  */

diff --git a/functions.c b/functions.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page functions Definitions of user functions
+ * @page neo_functions Definitions of user functions
  *
  * Definitions of user functions
  *

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

diff --git a/handler.c b/handler.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page handler Decide how to display email content
+ * @page neo_handler Decide how to display email content
  *
  * Decide how to display email content
  */

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

diff --git a/hdrline.c b/hdrline.c
@@ -24,7 +24,7 @@
  */
 
 /**
- * @page hdrline String processing routines to generate the mail index
+ * @page neo_hdrline String processing routines to generate the mail index
  *
  * String processing routines to generate the mail index
  */

diff --git a/help.c b/help.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page help Generate the help-page and GUI display it
+ * @page neo_help Generate the help-page and GUI display it
  *
  * Generate and help-page and GUI display it
  */

diff --git a/helpbar/lib.h b/helpbar/lib.h
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page helpbar HELPBAR: One-liner Help
+ * @page lib_helpbar HELPBAR: One-liner Help
  *
  * One-liner Help
  *

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

diff --git a/hook.c b/hook.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page hook Parse and execute user-defined hooks
+ * @page neo_hook Parse and execute user-defined hooks
  *
  * Parse and execute user-defined hooks
  */

diff --git a/icommands.c b/icommands.c
@@ -23,7 +23,7 @@
  */
 
 /**
- * @page icommands Information commands
+ * @page neo_icommands Information commands
  *
  * Information commands
  */

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

diff --git a/index.c b/index.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page index2 GUI manage the main index (list of emails)
+ * @page neo_index GUI manage the main index (list of emails)
  *
  * GUI manage the main index (list of emails)
  */

diff --git a/init.c b/init.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page init Config/command parsing
+ * @page neo_init Config/command parsing
  *
  * Config/command parsing
  */

diff --git a/keymap.c b/keymap.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page keymap Manage keymappings
+ * @page neo_keymap Manage keymappings
  *
  * Manage keymappings
  */

diff --git a/mailcap.c b/mailcap.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page mailcap RFC1524 Mailcap routines
+ * @page neo_mailcap RFC1524 Mailcap routines
  *
  * RFC1524 defines a format for the Multimedia Mail Configuration, which is the
  * standard mailcap file format under Unix which specifies what external

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

diff --git a/maillist.c b/maillist.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page maillist Handle mailing lists
+ * @page neo_maillist Handle mailing lists
  *
  * Handle mailing lists
  */

diff --git a/main.c b/main.c
@@ -24,7 +24,7 @@
  */
 
 /**
- * @page main Command line processing
+ * @page neo_main Command line processing
  *
  * Command line processing
  */

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

diff --git a/menu.c b/menu.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @page menu GUI present the user with a selectable list
+ * @page neo_menu GUI present the user with a selectable list
  *
  * GUI present the user with a selectable list
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,7 +21,7 @@ @@
      */
     /**
-     * @page address ADDRESS: Email Address Handling
+     * @page lib_address ADDRESS: Email Address Handling
      *
      * Email Address Handling
      *
@@ Expand Down @@