doxy: expando_api

georgalis · Jul 23, 2021 · c60683b · c60683b
1 parent 3990399
commit c60683b
Show file tree

Hide file tree

Showing 21 changed files with 24 additions and 20 deletions.
diff --git a/alias/dlgalias.c b/alias/dlgalias.c
@@ -109,7 +109,7 @@ static const struct Mapping AliasHelp[] = {
 };
 
 /**
- * alias_format_str - Format a string for the alias list - Implements ::format_t
+ * alias_format_str - Format a string for the alias list - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/alias/dlgquery.c b/alias/dlgquery.c
@@ -169,7 +169,7 @@ static int query_search(struct Menu *menu, regex_t *rx, int line)
 }
 
 /**
- * query_format_str - Format a string for the query menu - Implements ::format_t
+ * query_format_str - Format a string for the query menu - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/autocrypt/dlgautocrypt.c b/autocrypt/dlgautocrypt.c
@@ -121,7 +121,7 @@ static const struct Mapping AutocryptAcctHelp[] = {
 };
 
 /**
- * autocrypt_format_str - Format a string for the Autocrypt account list - Implements ::format_t
+ * autocrypt_format_str - Format a string for the Autocrypt account list - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:-----------------------------------------------------------------

diff --git a/browser.c b/browser.c
@@ -383,7 +383,7 @@ static bool link_is_dir(const char *folder, const char *path)
 }
 
 /**
- * folder_format_str - Format a string for the folder browser - Implements ::format_t
+ * folder_format_str - Format a string for the folder browser - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/compmbox/compress.c b/compmbox/compress.c
@@ -239,7 +239,7 @@ static void compress_info_free(struct Mailbox *m)
 }
 
 /**
- * compress_format_str - Expand the filenames in a command string - Implements ::format_t
+ * compress_format_str - Expand the filenames in a command string - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/compose/cbar.c b/compose/cbar.c
@@ -91,7 +91,7 @@ int num_attachments(struct ComposeAttachData *adata)
 }
 
 /**
- * compose_format_str - Create the status bar string for compose mode - Implements ::format_t
+ * compose_format_str - Create the status bar string for compose mode - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/format_flags.h b/format_flags.h
@@ -38,6 +38,10 @@ typedef uint8_t MuttFormatFlags;         ///< Flags for mutt_expando_format(), e
 #define MUTT_FORMAT_PLAIN       (1 << 7) ///< Do not prepend DISP_TO, DISP_CC ...
 
 /**
+ * @defgroup expando_api Expando API
+ *
+ * Callback functions for mutt_expando_format().
+ *
  * typedef format_t - Prototype for a mutt_expando_format() callback function
  * @param[out] buf      Buffer in which to save string
  * @param[in]  buflen   Buffer length

diff --git a/hdrline.c b/hdrline.c
@@ -381,7 +381,7 @@ static bool thread_is_old(struct Email *e)
 }
 
 /**
- * index_format_str - Format a string for the index list - Implements ::format_t
+ * index_format_str - Format a string for the index list - Implements ::format_t  - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:-----------------------------------------------------------------

diff --git a/history/dlghistory.c b/history/dlghistory.c
@@ -81,7 +81,7 @@ static const struct Mapping HistoryHelp[] = {
 };
 
 /**
- * history_format_str - Format a string for the history list - Implements ::format_t
+ * history_format_str - Format a string for the history list - Implements ::format_t  - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------

diff --git a/muttlib.c b/muttlib.c
@@ -767,7 +767,7 @@ void mutt_safe_path(struct Buffer *dest, const struct Address *a)
 }
 
 /**
- * mutt_expando_format - Expand expandos (%x) in a string
+ * mutt_expando_format - Expand expandos (%x) in a string - @ingroup expando_api
  * @param[out] buf      Buffer in which to save string
  * @param[in]  buflen   Buffer length
  * @param[in]  col      Starting column

diff --git a/ncrypt/dlggpgme.c b/ncrypt/dlggpgme.c
@@ -995,7 +995,7 @@ static char crypt_flags(KeyFlags flags)
 }
 
 /**
- * crypt_format_str - Format a string for the key selection menu - Implements ::format_t
+ * crypt_format_str - Format a string for the key selection menu - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/ncrypt/dlgpgp.c b/ncrypt/dlgpgp.c
@@ -319,7 +319,7 @@ static char pgp_flags(KeyFlags flags)
 }
 
 /**
- * pgp_entry_format_str - Format an entry on the PGP key selection menu - Implements ::format_t
+ * pgp_entry_format_str - Format an entry on the PGP key selection menu - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/ncrypt/pgpinvoke.c b/ncrypt/pgpinvoke.c
@@ -65,7 +65,7 @@ struct PgpCommandContext
 };
 
 /**
- * pgp_command_format_str - Format a PGP command string - Implements ::format_t
+ * pgp_command_format_str - Format a PGP command string - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:-----------------------------------------------------------------

diff --git a/ncrypt/smime.c b/ncrypt/smime.c
@@ -194,7 +194,7 @@ bool smime_class_valid_passphrase(void)
  */
 
 /**
- * smime_command_format_str - Format an SMIME command - Implements ::format_t
+ * smime_command_format_str - Format an SMIME command - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:-----------------------------------------------------------------

diff --git a/nntp/browse.c b/nntp/browse.c
@@ -40,7 +40,7 @@
 #include "muttlib.h"
 
 /**
- * group_index_format_str - Format a string for the newsgroup menu - Implements ::format_t
+ * group_index_format_str - Format a string for the newsgroup menu - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/nntp/newsrc.c b/nntp/newsrc.c
@@ -911,7 +911,7 @@ void nntp_clear_cache(struct NntpAccountData *adata)
 }
 
 /**
- * nntp_format_str - Expand the newsrc filename - Implements ::format_t
+ * nntp_format_str - Expand the newsrc filename - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/pattern/dlgpattern.c b/pattern/dlgpattern.c
@@ -106,7 +106,7 @@ static const struct Mapping PatternHelp[] = {
 };
 
 /**
- * pattern_format_str - Format a string for the pattern completion menu - Implements ::format_t
+ * pattern_format_str - Format a string for the pattern completion menu - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:----------------------

diff --git a/recvattach.c b/recvattach.c
@@ -245,7 +245,7 @@ void mutt_update_tree(struct AttachCtx *actx)
 }
 
 /**
- * attach_format_str - Format a string for the attachment menu - Implements ::format_t
+ * attach_format_str - Format a string for the attachment menu - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/remailer.c b/remailer.c
@@ -465,7 +465,7 @@ static const char *mix_format_caps(struct Remailer *r)
 }
 
 /**
- * mix_format_str - Format a string for the remailer menu - Implements ::format_t
+ * mix_format_str - Format a string for the remailer menu - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/sidebar/window.c b/sidebar/window.c
@@ -304,7 +304,7 @@ static int calc_path_depth(const char *mbox, const char *delims, const char **la
 }
 
 /**
- * sidebar_format_str - Format a string for the sidebar - Implements ::format_t
+ * sidebar_format_str - Format a string for the sidebar - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------

diff --git a/status.c b/status.c
@@ -71,7 +71,7 @@ struct MenuStatusLineData
 };
 
 /**
- * status_format_str - Create the status bar string - Implements ::format_t
+ * status_format_str - Create the status bar string - Implements ::format_t - @ingroup expando_api
  *
  * | Expando | Description
  * |:--------|:--------------------------------------------------------