doxy: tidy

[ci skip]
georgalis · Oct 24, 2021 · 4c9fa28 · 4c9fa28
1 parent 72ba9a8
commit 4c9fa28
Show file tree

Hide file tree

Showing 47 changed files with 36 additions and 93 deletions.
diff --git a/alias/dlgalias.c b/alias/dlgalias.c
@@ -25,8 +25,6 @@
 /**
  * @page alias_dlgalias Address Book Dialog
  *
- * ## Overview
- *
  * The Address Book Dialog allows the user to select, add or delete aliases.
  *
  * This is a @ref gui_simple

diff --git a/alias/dlgquery.c b/alias/dlgquery.c
@@ -25,8 +25,6 @@
 /**
  * @page alias_dlgquery Address Query Dialog
  *
- * ## Overview
- *
  * The Address Query Dialog will show aliases from an external query.
  * User can select aliases from the list.
  *

diff --git a/attach/dlg_attach.c b/attach/dlg_attach.c
@@ -24,8 +24,6 @@
 /**
  * @page attach_dialog Attachment Selection Dialog
  *
- * ## Overview
- *
  * The Attachment Selection Dialog lets the user select an email attachment.
  *
  * This is a @ref gui_simple

diff --git a/autocrypt/dlgautocrypt.c b/autocrypt/dlgautocrypt.c
@@ -23,8 +23,6 @@
 /**
  * @page autocrypt_account Autocrypt account dialog
  *
- * ## Overview
- *
  * The Autocrypt Account Dialog lets the user set up or update an Autocrypt Account.
  *
  * This is a @ref gui_simple

diff --git a/browser.c b/browser.c
@@ -24,8 +24,6 @@
 /**
  * @page neo_browser File/Mailbox Browser Dialog
  *
- * ## Overview
- *
  * The File/Mailbox Browser Dialog lets the user select from a list of files or
  * mailboxes.
  *

diff --git a/compose/attach.c b/compose/attach.c
@@ -23,8 +23,6 @@
 /**
  * @page compose_attach Attachments window
  *
- * ## Overview
- *
  * The Compose Attachments Window displays the attachments of an email.
  *
  * ## Windows

diff --git a/compose/cbar.c b/compose/cbar.c
@@ -23,8 +23,6 @@
 /**
  * @page compose_cbar Compose Bar (status)
  *
- * ## Overview
- *
  * The Compose Bar Window displays status info about the email.
  *
  * ## Windows

diff --git a/compose/compose.c b/compose/compose.c
@@ -26,8 +26,6 @@
 /**
  * @page compose_dialog Compose Email Dialog
  *
- * ## Overview
- *
  * The Compose Email Dialog lets the user edit the fields before sending an email.
  * They can also add/remove/reorder attachments.
  *

diff --git a/compose/envelope.c b/compose/envelope.c
@@ -23,8 +23,6 @@
 /**
  * @page compose_envelope Envelope Window
  *
- * ## Overview
- *
  * The Compose Envelope Window displays the header fields of an email.
  *
  * ## Windows

diff --git a/compose/lib.h b/compose/lib.h
@@ -35,6 +35,7 @@
  * | compose/config.c       | @subpage compose_config        |
  * | compose/env_data.c     | @subpage compose_env_data      |
  * | compose/envelope.c     | @subpage compose_envelope      |
+ * | compose/functions.c    | @subpage compose_functions     |
  * | compose/shared_data.c  | @subpage compose_shared_data   |
  */
 

diff --git a/conn/dlgverifycert.c b/conn/dlgverifycert.c
@@ -23,8 +23,6 @@
 /**
  * @page conn_gui Certificate Verification Dialog
  *
- * ## Overview
- *
  * The Certificate Verification Dialog lets the user check the details of a
  * certificate.
  *

diff --git a/dlg_postpone.c b/dlg_postpone.c
@@ -24,8 +24,6 @@
 /**
  * @page neo_dlg_postpone Postponed Email Selection Dialog
  *
- * ## Overview
- *
  * The Postponed Email Selection Dialog lets the user set a postponed (draft)
  * email.
  *

diff --git a/gui/dialog.c b/gui/dialog.c
@@ -23,8 +23,6 @@
 /**
  * @page gui_dialog Dialog Windows
  *
- * ## Overview
- *
  * A Dialog is an interactive set of windows allowing the user to perform some
  * task, e.g. @ref alias_dlgalias
  *

diff --git a/gui/msgwin.c b/gui/msgwin.c
@@ -23,8 +23,6 @@
 /**
  * @page gui_msgwin Message Window
  *
- * ## Overview
- *
  * The Message Window is a one-line interactive window at the bottom of the
  * screen.  It's used for asking the user questions, displaying messages and
  * for a progress bar.

diff --git a/gui/rootwin.c b/gui/rootwin.c
@@ -23,8 +23,6 @@
 /**
  * @page gui_rootwin Root Window
  *
- * ## Overview
- *
  * NeoMutt is built from a set of nested windows.  Each window defines a region
  * of the screen which is responsible for a single concept.  This could be a high-level
  * component like the @ref compose_dialog, or a single element like the @ref index_ibar.

diff --git a/gui/sbar.c b/gui/sbar.c
@@ -23,8 +23,6 @@
 /**
  * @page gui_sbar Simple Bar (status)
  *
- * ## Overview
- *
  * The Simple Bar is a simple non-interactive window to display a message or
  * trivial status information.
  *

diff --git a/gui/simple.c b/gui/simple.c
@@ -23,8 +23,6 @@
 /**
  * @page gui_simple Simple Dialog
  *
- * ## Overview
- *
  * The Simple Dialog is an interactive set of windows containing a Menu and a
  * status bar.
  *

diff --git a/hcache/hcache.c b/hcache/hcache.c
@@ -243,7 +243,7 @@ static bool create_hcache_dir(const char *path)
  * @param hcpath Buffer for the result
  * @param path   Base directory, from $header_cache
  * @param folder Mailbox name (including protocol)
- * @param namer  Callback to generate database filename - Implements ::hcache_namer_t - @ingroup hcache_namer_api
+ * @param namer  Callback to generate database filename - Implements ::hcache_namer_t
  *
  * Generate the pathname for the hcache database, it will be of the form:
  *     BASE/FOLDER/NAME

diff --git a/helpbar/helpbar.c b/helpbar/helpbar.c
@@ -23,8 +23,6 @@
 /**
  * @page helpbar_helpbar Help Bar Window
  *
- * ## Overview
- *
  * The Help Bar is a non-interactive window that displays some
  * helpful key bindings for the current screen.
  *

diff --git a/history/dlghistory.c b/history/dlghistory.c
@@ -23,8 +23,6 @@
 /**
  * @page history_dlghistory History Selection Dialog
  *
- * ## Overview
- *
  * The History Selection Dialog lets the user choose a string from the history,
  * e.g. a past command.
  *

diff --git a/index/dlg_index.c b/index/dlg_index.c
@@ -24,8 +24,6 @@
 /**
  * @page index_dialog Index Dialog
  *
- * ## Overview
- *
  * The Index Dialog is the main screen within NeoMutt.  It contains @ref
  * index_index (a list of emails), @ref pager_dialog (a view of an email) and
  * @ref sidebar_window (a list of mailboxes).

diff --git a/index/ibar.c b/index/ibar.c
@@ -23,8 +23,6 @@
 /**
  * @page index_ibar Index Bar (status)
  *
- * ## Overview
- *
  * The Index Bar Window displays status info about the email list.
  *
  * ## Windows

diff --git a/index/index.c b/index/index.c
@@ -23,8 +23,6 @@
 /**
  * @page index_index Index Window
  *
- * ## Overview
- *
  * The Index Window displays a list of emails to the user.
  *
  * ## Windows

diff --git a/index/ipanel.c b/index/ipanel.c
@@ -23,8 +23,6 @@
 /**
  * @page index_ipanel Index Panel
  *
- * ## Overview
- *
  * The Index Panel is a non-interactive container around the email list and a
  * status bar.
  *

diff --git a/main.c b/main.c
@@ -32,7 +32,6 @@
  * <img style="float: left; padding-right: 0.5em;" src="globals.svg">
  * <img style="float: left; padding-right: 0.5em;" src="functions.svg">
  * <img style="float: left; padding-right: 0.5em;" src="enums.svg">
- * <img style="float: left; padding-right: 0.5em;" src="config.svg">
  * <img style="float: left; padding-right: 0.5em;" src="members.svg">
  * <img style="float: left; padding-right: 0.5em;" src="defines.svg">
  * <br>
@@ -52,12 +51,12 @@
  * @ref lib_address, @ref lib_alias, @ref lib_attach, @ref lib_autocrypt,
  * @ref lib_bcache, @ref lib_color, @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.
+ * @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
  *
@@ -94,6 +93,7 @@
  * | mutt_body.c     | @subpage neo_mutt_body     |
  * | mutt_commands.c | @subpage neo_mutt_commands |
  * | mutt_config.c   | @subpage neo_mutt_config   |
+ * | mutt_globals.h  | @subpage neo_mutt_globals  |
  * | mutt_header.c   | @subpage neo_mutt_header   |
  * | mutt_history.c  | @subpage neo_mutt_history  |
  * | mutt_logging.c  | @subpage neo_mutt_logging  |
@@ -105,6 +105,7 @@
  * | mx.c            | @subpage neo_mx            |
  * | myvar.c         | @subpage neo_myvar         |
  * | opcodes.c       | @subpage neo_opcode        |
+ * | options.h       | @subpage neo_options       |
  * | postpone.c      | @subpage neo_postpone      |
  * | recvcmd.c       | @subpage neo_recvcmd       |
  * | remailer.c      | @subpage neo_remailer      |

diff --git a/menu/window.c b/menu/window.c
@@ -23,8 +23,6 @@
 /**
  * @page menu_window Window wrapper around a Menu
  *
- * ## Overview
- *
  * The Menu Window is an interactive window that allows a user to work with a
  * list of items.  The Menu can be configured to allow single or multiple
  * selections and it can handle arbitrary data, sorting, custom colouring and

diff --git a/mutt/buffer.c b/mutt/buffer.c
@@ -22,7 +22,7 @@
  */
 
 /**
- * @page mutt_buffer General purpose object for storing and parsing strings
+ * @page mutt_buffer Helper object for storing and parsing strings
  *
  * The Buffer object make parsing and manipulating strings easier.
  */

diff --git a/mutt/lib.h b/mutt/lib.h
@@ -46,7 +46,6 @@
  * | mutt/md5.c       | @subpage mutt_md5       |
  * | mutt/memory.c    | @subpage mutt_memory    |
  * | mutt/notify.c    | @subpage mutt_notify    |
- * | mutt/observer.h  | @subpage mutt_observer  |
  * | mutt/path.c      | @subpage mutt_path      |
  * | mutt/pool.c      | @subpage mutt_pool      |
  * | mutt/prex.c      | @subpage mutt_prex      |

diff --git a/mutt/observer.h b/mutt/observer.h
@@ -20,12 +20,6 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
- * @page mutt_observer Observer of notifications
- *
- * Observer of notifications
- */
-
 #ifndef MUTT_LIB_OBSERVER_H
 #define MUTT_LIB_OBSERVER_H
 

diff --git a/mutt_globals.h b/mutt_globals.h
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page neo_mutt_globals Global variables
+ *
+ * Global variables
+ */
+
 #ifndef MUTT_GLOBALS_H
 #define MUTT_GLOBALS_H
 

diff --git a/ncrypt/dlggpgme.c b/ncrypt/dlggpgme.c
@@ -23,8 +23,6 @@
 /**
  * @page crypt_dlggpgme GPGME Key Selection Dialog
  *
- * ## Overview
- *
  * The GPGME Key Selection Dialog lets the user select a PGP key.
  *
  * This is a @ref gui_simple

diff --git a/ncrypt/dlgpgp.c b/ncrypt/dlgpgp.c
@@ -23,8 +23,6 @@
 /**
  * @page crypt_dlgpgp PGP Key Selection Dialog
  *
- * ## Overview
- *
  * The PGP Key Selection Dialog lets the user select a PGP key.
  *
  * This is a @ref gui_simple

diff --git a/ncrypt/dlgsmime.c b/ncrypt/dlgsmime.c
@@ -23,8 +23,6 @@
 /**
  * @page crypt_dlgsmime SMIME Key Selection Dialog
  *
- * ## Overview
- *
  * The SMIME Key Selection Dialog lets the user select a SMIME key.
  *
  * This is a @ref gui_simple

diff --git a/nntp/newsrc.c b/nntp/newsrc.c
@@ -23,7 +23,7 @@
  */
 
 /**
- * @page nntp_newsrc Read/parse/write an NNTP config file of subscribed newsgroups
+ * @page nntp_newsrc Read/write a file of subscribed newsgroups
  *
  * Read/parse/write an NNTP config file of subscribed newsgroups
  */

diff --git a/nntp/nntp.c b/nntp/nntp.c
@@ -24,7 +24,7 @@
  */
 
 /**
- * @page nntp_nntp Usenet network mailbox type; talk to an NNTP server
+ * @page nntp_nntp Talk to an NNTP server
  *
  * Usenet network mailbox type; talk to an NNTP server
  *

diff --git a/options.h b/options.h
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page neo_options Option variables
+ *
+ * Option variables
+ */
+
 #ifndef MUTT_OPTIONS_H
 #define MUTT_OPTIONS_H
 

diff --git a/pager/dlg_pager.c b/pager/dlg_pager.c
@@ -24,8 +24,6 @@
 /**
  * @page pager_dialog Pager Dialog
  *
- * ## Overview
- *
  * The Pager Dialog displays some text to the user that can be paged through.
  * The actual contents depend on the caller, but are usually an email, file or help.
  *

diff --git a/pager/do_pager.c b/pager/do_pager.c
@@ -24,8 +24,6 @@
 /**
  * @page pager_dopager Simple Pager Dialog
  *
- * ## Overview
- *
  * The Simple Pager Dialog displays text to the user that can be paged.
  *
  * ## Windows

diff --git a/pager/lib.h b/pager/lib.h
@@ -31,6 +31,7 @@
  * | pager/display.c      | @subpage pager_display      |
  * | pager/dlg_pager.c    | @subpage pager_dialog       |
  * | pager/do_pager.c     | @subpage pager_dopager      |
+ * | pager/functions.c    | @subpage pager_functions    |
  * | pager/message.c      | @subpage pager_message      |
  * | pager/pager.c        | @subpage pager_pager        |
  * | pager/pbar.c         | @subpage pager_pbar         |
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,7 +22,7 @@ @@
      */
     /**
-     * @page mutt_buffer General purpose object for storing and parsing strings
+     * @page mutt_buffer Helper object for storing and parsing strings
      *
      * The Buffer object make parsing and manipulating strings easier.
      */
@@ Expand Down @@