doxy: command_api

alias/commands.c

@@ -42,7 +42,7 @@
 #include "reverse.h"
 
 /**
- * parse_alias - Parse the 'alias' command - Implements Command::parse()
+ * parse_alias - Parse the 'alias' command - Implements Command::parse() - @ingroup command_parse
  *
  * e.g. "alias jim James Smith <js@example.com> # Pointy-haired boss"
  */
@@ -157,7 +157,7 @@ enum CommandResult parse_alias(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_unalias - Parse the 'unalias' command - Implements Command::parse()
+ * parse_unalias - Parse the 'unalias' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_unalias(struct Buffer *buf, struct Buffer *s,
                                  intptr_t data, struct Buffer *err)

alternates.c

@@ -85,7 +85,7 @@ void mutt_alternates_reset(struct Mailbox *m)
 }
 
 /**
- * parse_alternates - Parse the 'alternates' command - Implements Command::parse()
+ * parse_alternates - Parse the 'alternates' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_alternates(struct Buffer *buf, struct Buffer *s,
                                     intptr_t data, struct Buffer *err)
@@ -121,7 +121,7 @@ enum CommandResult parse_alternates(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_unalternates - Parse the 'unalternates' command - Implements Command::parse()
+ * parse_unalternates - Parse the 'unalternates' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_unalternates(struct Buffer *buf, struct Buffer *s,
                                       intptr_t data, struct Buffer *err)

attachments.c

@@ -464,7 +464,7 @@ static int print_attach_list(struct ListHead *h, const char op, const char *name
 }
 
 /**
- * parse_attachments - Parse the 'attachments' command - Implements Command::parse()
+ * parse_attachments - Parse the 'attachments' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_attachments(struct Buffer *buf, struct Buffer *s,
                                      intptr_t data, struct Buffer *err)
@@ -523,7 +523,7 @@ enum CommandResult parse_attachments(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_unattachments - Parse the 'unattachments' command - Implements Command::parse()
+ * parse_unattachments - Parse the 'unattachments' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_unattachments(struct Buffer *buf, struct Buffer *s,
                                        intptr_t data, struct Buffer *err)

command_parse.c

@@ -282,7 +282,7 @@ int source_rc(const char *rcfile_path, struct Buffer *err)
 }
 
 /**
- * parse_cd - Parse the 'cd' command - Implements Command::parse()
+ * parse_cd - Parse the 'cd' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_cd(struct Buffer *buf, struct Buffer *s, intptr_t data,
                             struct Buffer *err)
@@ -310,7 +310,7 @@ enum CommandResult parse_cd(struct Buffer *buf, struct Buffer *s, intptr_t data,
 }
 
 /**
- * parse_echo - Parse the 'echo' command - Implements Command::parse()
+ * parse_echo - Parse the 'echo' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_echo(struct Buffer *buf, struct Buffer *s,
                               intptr_t data, struct Buffer *err)
@@ -330,7 +330,7 @@ enum CommandResult parse_echo(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_finish - Parse the 'finish' command - Implements Command::parse()
+ * parse_finish - Parse the 'finish' command - Implements Command::parse() - @ingroup command_parse
  * @retval  #MUTT_CMD_FINISH Stop processing the current file
  * @retval  #MUTT_CMD_WARNING Failed
  *
@@ -349,7 +349,7 @@ enum CommandResult parse_finish(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_group - Parse the 'group' and 'ungroup' commands - Implements Command::parse()
+ * parse_group - Parse the 'group' and 'ungroup' commands - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_group(struct Buffer *buf, struct Buffer *s,
                                intptr_t data, struct Buffer *err)
@@ -435,7 +435,7 @@ enum CommandResult parse_group(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_ifdef - Parse the 'ifdef' and 'ifndef' commands - Implements Command::parse()
+ * parse_ifdef - Parse the 'ifdef' and 'ifndef' commands - Implements Command::parse() - @ingroup command_parse
  *
  * The 'ifdef' command allows conditional elements in the config file.
  * If a given variable, function, command or compile-time symbol exists, then
@@ -482,7 +482,7 @@ enum CommandResult parse_ifdef(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_ignore - Parse the 'ignore' command - Implements Command::parse()
+ * parse_ignore - Parse the 'ignore' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_ignore(struct Buffer *buf, struct Buffer *s,
                                 intptr_t data, struct Buffer *err)
@@ -498,7 +498,7 @@ enum CommandResult parse_ignore(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_lists - Parse the 'lists' command - Implements Command::parse()
+ * parse_lists - Parse the 'lists' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_lists(struct Buffer *buf, struct Buffer *s,
                                intptr_t data, struct Buffer *err)
@@ -530,7 +530,7 @@ enum CommandResult parse_lists(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_mailboxes - Parse the 'mailboxes' command - Implements Command::parse()
+ * parse_mailboxes - Parse the 'mailboxes' command - Implements Command::parse() - @ingroup command_parse
  *
  * This is also used by 'virtual-mailboxes'.
  */
@@ -625,7 +625,7 @@ enum CommandResult parse_mailboxes(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_my_hdr - Parse the 'my_hdr' command - Implements Command::parse()
+ * parse_my_hdr - Parse the 'my_hdr' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_my_hdr(struct Buffer *buf, struct Buffer *s,
                                 intptr_t data, struct Buffer *err)
@@ -658,7 +658,7 @@ enum CommandResult parse_my_hdr(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_set - Parse the 'set' family of commands - Implements Command::parse()
+ * parse_set - Parse the 'set' family of commands - Implements Command::parse() - @ingroup command_parse
  *
  * This is used by 'reset', 'set', 'toggle' and 'unset'.
  */
@@ -1037,7 +1037,7 @@ enum CommandResult parse_set(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_setenv - Parse the 'setenv' and 'unsetenv' commands - Implements Command::parse()
+ * parse_setenv - Parse the 'setenv' and 'unsetenv' commands - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_setenv(struct Buffer *buf, struct Buffer *s,
                                 intptr_t data, struct Buffer *err)
@@ -1147,7 +1147,7 @@ enum CommandResult parse_setenv(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_source - Parse the 'source' command - Implements Command::parse()
+ * parse_source - Parse the 'source' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_source(struct Buffer *buf, struct Buffer *s,
                                 intptr_t data, struct Buffer *err)
@@ -1176,7 +1176,7 @@ enum CommandResult parse_source(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_spam_list - Parse the 'spam' and 'nospam' commands - Implements Command::parse()
+ * parse_spam_list - Parse the 'spam' and 'nospam' commands - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_spam_list(struct Buffer *buf, struct Buffer *s,
                                    intptr_t data, struct Buffer *err)
@@ -1252,7 +1252,7 @@ enum CommandResult parse_spam_list(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_stailq - Parse a list command - Implements Command::parse()
+ * parse_stailq - Parse a list command - Implements Command::parse() - @ingroup command_parse
  *
  * This is used by 'alternative_order', 'auto_view' and several others.
  */
@@ -1269,7 +1269,7 @@ enum CommandResult parse_stailq(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_subscribe - Parse the 'subscribe' command - Implements Command::parse()
+ * parse_subscribe - Parse the 'subscribe' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_subscribe(struct Buffer *buf, struct Buffer *s,
                                    intptr_t data, struct Buffer *err)
@@ -1304,7 +1304,7 @@ enum CommandResult parse_subscribe(struct Buffer *buf, struct Buffer *s,
 
 #ifdef USE_IMAP
 /**
- * parse_subscribe_to - Parse the 'subscribe-to' command - Implements Command::parse()
+ * parse_subscribe_to - Parse the 'subscribe-to' command - Implements Command::parse() - @ingroup command_parse
  *
  * The 'subscribe-to' command allows to subscribe to an IMAP-Mailbox.
  * Patterns are not supported.
@@ -1351,7 +1351,7 @@ enum CommandResult parse_subscribe_to(struct Buffer *buf, struct Buffer *s,
 #endif
 
 /**
- * parse_tag_formats - Parse the 'tag-formats' command - Implements Command::parse()
+ * parse_tag_formats - Parse the 'tag-formats' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_tag_formats(struct Buffer *buf, struct Buffer *s,
                                      intptr_t data, struct Buffer *err)
@@ -1390,7 +1390,7 @@ enum CommandResult parse_tag_formats(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_tag_transforms - Parse the 'tag-transforms' command - Implements Command::parse()
+ * parse_tag_transforms - Parse the 'tag-transforms' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_tag_transforms(struct Buffer *buf, struct Buffer *s,
                                         intptr_t data, struct Buffer *err)
@@ -1429,7 +1429,7 @@ enum CommandResult parse_tag_transforms(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_unignore - Parse the 'unignore' command - Implements Command::parse()
+ * parse_unignore - Parse the 'unignore' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_unignore(struct Buffer *buf, struct Buffer *s,
                                   intptr_t data, struct Buffer *err)
@@ -1449,7 +1449,7 @@ enum CommandResult parse_unignore(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_unlists - Parse the 'unlists' command - Implements Command::parse()
+ * parse_unlists - Parse the 'unlists' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_unlists(struct Buffer *buf, struct Buffer *s,
                                  intptr_t data, struct Buffer *err)
@@ -1512,7 +1512,7 @@ static void do_unmailboxes_star(void)
 }
 
 /**
- * parse_unmailboxes - Parse the 'unmailboxes' command - Implements Command::parse()
+ * parse_unmailboxes - Parse the 'unmailboxes' command - Implements Command::parse() - @ingroup command_parse
  *
  * This is also used by 'unvirtual-mailboxes'
  */
@@ -1546,7 +1546,7 @@ enum CommandResult parse_unmailboxes(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_unmy_hdr - Parse the 'unmy_hdr' command - Implements Command::parse()
+ * parse_unmy_hdr - Parse the 'unmy_hdr' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_unmy_hdr(struct Buffer *buf, struct Buffer *s,
                                   intptr_t data, struct Buffer *err)
@@ -1590,7 +1590,7 @@ enum CommandResult parse_unmy_hdr(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_unstailq - Parse an unlist command - Implements Command::parse()
+ * parse_unstailq - Parse an unlist command - Implements Command::parse() - @ingroup command_parse
  *
  * This is used by 'unalternative_order', 'unauto_view' and several others.
  */
@@ -1613,7 +1613,7 @@ enum CommandResult parse_unstailq(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * parse_unsubscribe - Parse the 'unsubscribe' command - Implements Command::parse()
+ * parse_unsubscribe - Parse the 'unsubscribe' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult parse_unsubscribe(struct Buffer *buf, struct Buffer *s,
                                      intptr_t data, struct Buffer *err)
@@ -1636,7 +1636,7 @@ enum CommandResult parse_unsubscribe(struct Buffer *buf, struct Buffer *s,
 
 #ifdef USE_IMAP
 /**
- * parse_unsubscribe_from - Parse the 'unsubscribe-from' command - Implements Command::parse()
+ * parse_unsubscribe_from - Parse the 'unsubscribe-from' command - Implements Command::parse() - @ingroup command_parse
  *
  * The 'unsubscribe-from' command allows to unsubscribe from an IMAP-Mailbox.
  * Patterns are not supported.

gui/color.c

@@ -950,7 +950,7 @@ static enum CommandResult parse_uncolor(struct Buffer *buf, struct Buffer *s,
 
 #ifdef HAVE_COLOR
 /**
- * mutt_parse_uncolor - Parse the 'uncolor' command - Implements Command::parse()
+ * mutt_parse_uncolor - Parse the 'uncolor' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult mutt_parse_uncolor(struct Buffer *buf, struct Buffer *s,
                                       intptr_t data, struct Buffer *err)
@@ -965,7 +965,7 @@ enum CommandResult mutt_parse_uncolor(struct Buffer *buf, struct Buffer *s,
 #endif
 
 /**
- * mutt_parse_unmono - Parse the 'unmono' command - Implements Command::parse()
+ * mutt_parse_unmono - Parse the 'unmono' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult mutt_parse_unmono(struct Buffer *buf, struct Buffer *s,
                                      intptr_t data, struct Buffer *err)
@@ -1386,7 +1386,7 @@ static enum CommandResult parse_color(struct Buffer *buf, struct Buffer *s,
 
 #ifdef HAVE_COLOR
 /**
- * mutt_parse_color - Parse the 'color' command - Implements Command::parse()
+ * mutt_parse_color - Parse the 'color' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult mutt_parse_color(struct Buffer *buf, struct Buffer *s,
                                     intptr_t data, struct Buffer *err)
@@ -1401,7 +1401,7 @@ enum CommandResult mutt_parse_color(struct Buffer *buf, struct Buffer *s,
 #endif
 
 /**
- * mutt_parse_mono - Parse the 'mono' command - Implements Command::parse()
+ * mutt_parse_mono - Parse the 'mono' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult mutt_parse_mono(struct Buffer *buf, struct Buffer *s,
                                    intptr_t data, struct Buffer *err)

hook.c

@@ -75,7 +75,7 @@ static struct HashTable *IdxFmtHooks = NULL;
 static HookFlags current_hook_type = MUTT_HOOK_NO_FLAGS;
 
 /**
- * mutt_parse_hook - Parse the 'hook' family of commands - Implements Command::parse()
+ * mutt_parse_hook - Parse the 'hook' family of commands - Implements Command::parse() - @ingroup command_parse
  *
  * This is used by 'account-hook', 'append-hook' and many more.
  */
@@ -367,7 +367,7 @@ static void delete_idxfmt_hooks(void)
 }
 
 /**
- * mutt_parse_idxfmt_hook - Parse the 'index-format-hook' command - Implements Command::parse()
+ * mutt_parse_idxfmt_hook - Parse the 'index-format-hook' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult mutt_parse_idxfmt_hook(struct Buffer *buf, struct Buffer *s,
                                           intptr_t data, struct Buffer *err)
@@ -473,7 +473,7 @@ enum CommandResult mutt_parse_idxfmt_hook(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * mutt_parse_unhook - Parse the 'unhook' command - Implements Command::parse()
+ * mutt_parse_unhook - Parse the 'unhook' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult mutt_parse_unhook(struct Buffer *buf, struct Buffer *s,
                                      intptr_t data, struct Buffer *err)

keymap.c

@@ -1195,7 +1195,7 @@ void km_error_key(enum MenuType mtype)
 }
 
 /**
- * mutt_parse_push - Parse the 'push' command - Implements Command::parse()
+ * mutt_parse_push - Parse the 'push' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult mutt_parse_push(struct Buffer *buf, struct Buffer *s,
                                    intptr_t data, struct Buffer *err)
@@ -1356,7 +1356,7 @@ const struct Binding *km_get_table(enum MenuType mtype)
 }
 
 /**
- * mutt_parse_bind - Parse the 'bind' command - Implements Command::parse()
+ * mutt_parse_bind - Parse the 'bind' command - Implements Command::parse() - @ingroup command_parse
  *
  * bind menu-name `<key_sequence>` function-name
  */
@@ -1500,7 +1500,7 @@ static void km_unbind_all(struct KeymapList *km_list, unsigned long mode)
 }
 
 /**
- * mutt_parse_unbind - Parse the 'unbind' command - Implements Command::parse()
+ * mutt_parse_unbind - Parse the 'unbind' command - Implements Command::parse() - @ingroup command_parse
  *
  * Command unbinds:
  * - one binding in one menu-name
@@ -1588,7 +1588,7 @@ enum CommandResult mutt_parse_unbind(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * mutt_parse_macro - Parse the 'macro' command - Implements Command::parse()
+ * mutt_parse_macro - Parse the 'macro' command - Implements Command::parse() - @ingroup command_parse
  *
  * macro `<menu>` `<key>` `<macro>` `<description>`
  */
@@ -1665,7 +1665,7 @@ enum CommandResult mutt_parse_macro(struct Buffer *buf, struct Buffer *s,
 }
 
 /**
- * mutt_parse_exec - Parse the 'exec' command - Implements Command::parse()
+ * mutt_parse_exec - Parse the 'exec' command - Implements Command::parse() - @ingroup command_parse
  */
 enum CommandResult mutt_parse_exec(struct Buffer *buf, struct Buffer *s,
                                    intptr_t data, struct Buffer *err)