static struct Hash *Groups = NULL;
/**
- * mutt_grouplist_init - Initialize the GroupList singleton.
+ * mutt_grouplist_init - Initialize the GroupList singleton
*
* This is called once from init.c when initializing the global structures.
*/
}
/**
- * mutt_grouplist_free - Free GroupList singleton resource.
+ * mutt_grouplist_free - Free GroupList singleton resource
*
* This is called once from init.c when deinitializing the global resources.
*/
/**
* mutt_idna_print_version - Create an IDN version string
- * @retval str Version string
+ * @retval ptr Version string
*
* @note This is a static string and must not be freed.
*/
* @param data Flags associated with the command
* @param err Buffer for error messages
* @param parse_uncolor If true, 'uncolor', else 'unmono'
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*
* usage:
* * uncolor index pattern [pattern...]
* @param err Buffer for error messages
* @param is_index true of this is for the index
* @param match Number of regex subexpression to match (0 for entire pattern)
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
static enum CommandResult add_pattern(struct ColorLineHead *top, const char *s,
bool sensitive, uint32_t fg, uint32_t bg, int attr,
* @param callback Function to handle command - Implements ::parser_callback_t
* @param dry_run If true, test the command, but don't apply it
* @param color If true "color", else "mono"
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*
* usage: color OBJECT FG BG [ REGEX ]
* mono OBJECT ATTR [ REGEX ]
* @param cs Config items
* @param he HashElem representing config item
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int bool_he_toggle(struct ConfigSet *cs, struct HashElem *he, struct Buffer *err)
{
* @param cs Config items
* @param name Name of config item
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int bool_str_toggle(struct ConfigSet *cs, const char *name, struct Buffer *err)
{
* @param vid Value ID (index into CfgAccount's HashElem's)
* @param value Native pointer/value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int ac_set_value(const struct CfgAccount *ac, size_t vid, intptr_t value, struct Buffer *err)
{
* @param ac Account-specific config items
* @param vid Value ID (index into CfgAccount's HashElem's)
* @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int ac_get_value(const struct CfgAccount *ac, size_t vid, struct Buffer *result)
{
* @param cdef Variable definition
* @param value Value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*
* If var is NULL, then the config item's initial value will be set.
*/
* @param var Variable to get
* @param cdef Variable definition
* @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*
* If var is NULL, then the config item's initial value will be returned.
*/
* @param cdef Variable definition
* @param value Native pointer/value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
static int command_native_set(const struct ConfigSet *cs, void *var,
const struct ConfigDef *cdef, intptr_t value,
* @param cdef Variable definition
* @param err Buffer for error messages
* @retval intptr_t Command string
+ * @retval INT_MIN Error
*/
static intptr_t command_native_get(const struct ConfigSet *cs, void *var,
const struct ConfigDef *cdef, struct Buffer *err)
* @param var Variable to reset
* @param cdef Variable definition
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
static int command_reset(const struct ConfigSet *cs, void *var,
const struct ConfigDef *cdef, struct Buffer *err)
* @param cs Config items
* @param he HashElem representing config item
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*
* @sa quad_toggle()
*/
* @param cs Config items
* @param he HashElem representing config item
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_he_reset(const struct ConfigSet *cs, struct HashElem *he, struct Buffer *err)
{
* @param cs Config items
* @param name Name of config item
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_str_reset(const struct ConfigSet *cs, const char *name, struct Buffer *err)
{
* @param he HashElem representing config item
* @param value Value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_he_initial_set(const struct ConfigSet *cs, struct HashElem *he,
const char *value, struct Buffer *err)
* @param name Name of config item
* @param value Value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_str_initial_set(const struct ConfigSet *cs, const char *name,
const char *value, struct Buffer *err)
* @param cs Config items
* @param he HashElem representing config item
* @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*
* If a config item is inherited from another, then this will get the parent's
* value. Otherwise, it will get the config item's initial value.
* @param cs Config items
* @param name Name of config item
* @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*
* If a config item is inherited from another, then this will get the parent's
* value. Otherwise, it will get the config item's initial value.
* @param he HashElem representing config item
* @param value Value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_he_string_set(const struct ConfigSet *cs, struct HashElem *he,
const char *value, struct Buffer *err)
* @param name Name of config item
* @param value Value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_str_string_set(const struct ConfigSet *cs, const char *name,
const char *value, struct Buffer *err)
* @param cs Config items
* @param he HashElem representing config item
* @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_he_string_get(const struct ConfigSet *cs, struct HashElem *he, struct Buffer *result)
{
* @param cs Config items
* @param name Name of config item
* @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_str_string_get(const struct ConfigSet *cs, const char *name, struct Buffer *result)
{
* @param he HashElem representing config item
* @param value Native pointer/value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_he_native_set(const struct ConfigSet *cs, struct HashElem *he,
intptr_t value, struct Buffer *err)
* @param name Name of config item
* @param value Native pointer/value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
int cs_str_native_set(const struct ConfigSet *cs, const char *name,
intptr_t value, struct Buffer *err)
* @param he HashElem representing config item
* @param err Buffer for results or error messages
* @retval intptr_t Native pointer/value
+ * @retval INT_MIN Error
*/
intptr_t cs_he_native_get(const struct ConfigSet *cs, struct HashElem *he, struct Buffer *err)
{
* @param name Name of config item
* @param err Buffer for error messages
* @retval intptr_t Native pointer/value
+ * @retval INT_MIN Error
*/
intptr_t cs_str_native_get(const struct ConfigSet *cs, const char *name, struct Buffer *err)
{
* @param cdef Variable definition
* @param value Value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*
* If var is NULL, then the config item's initial value will be set.
*/
* @param var Variable to get
* @param cdef Variable definition
* @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*
* If var is NULL, then the config item's initial value will be returned.
*/
* @param cdef Variable definition
* @param value Native pointer/value to set
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
typedef int (*cst_native_set)(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err);
/**
* @param cdef Variable definition
* @param err Buffer for error messages
* @retval intptr_t Config item string
+ * @retval INT_MIN Error
*/
typedef intptr_t(*cst_native_get)(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err);
* @param var Variable to reset
* @param cdef Variable definition
* @param err Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * @retval num Result, e.g. #CSR_SUCCESS
*/
typedef int (*cst_reset) (const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err);
/**
* @param[in] else_str Otherwise, display this string
* @param[in] data Pointer to the mailbox Context
* @param[in] flags Flags, see #MuttFormatFlags
- * @retval src (unchanged)
+ * @retval ptr src (unchanged)
*
* Each callback function implements some expandos, e.g.
*
* @param fp File to write to
* @param col Current screen column
* @param i Screen column to pad until
- * @retval col Padding was added
- * @retval i Content was already wider than col
+ * @retval i Padding was added
+ * @retval col Content was already wider than col
*/
static int pad(FILE *fp, int col, int i)
{
* @param s Entire command line
* @param data Private data to pass to parse function
* @param err Buffer for error messages
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result, e.g. #MUTT_CMD_SUCCESS
*/
typedef enum CommandResult icommand_t(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);
* imap_auth_anon - Authenticate anonymously
* @param adata Imap Account data
* @param method Name of this authentication method
- * @retval enum Result, e.g. #IMAP_AUTH_SUCCESS
+ * @retval #ImapAuthRes Result, e.g. #IMAP_AUTH_SUCCESS
*
* this is basically a stripped-down version of the cram-md5 method.
*/
* imap_auth_cram_md5 - Authenticate using CRAM-MD5
* @param adata Imap Account data
* @param method Name of this authentication method
- * @retval enum Result, e.g. #IMAP_AUTH_SUCCESS
+ * @retval #ImapAuthRes Result, e.g. #IMAP_AUTH_SUCCESS
*/
enum ImapAuthRes imap_auth_cram_md5(struct ImapAccountData *adata, const char *method)
{
* imap_auth_gss - GSS Authentication support
* @param adata Imap Account data
* @param method Name of this authentication method
- * @retval enum Result, e.g. #IMAP_AUTH_SUCCESS
+ * @retval #ImapAuthRes Result, e.g. #IMAP_AUTH_SUCCESS
*/
enum ImapAuthRes imap_auth_gss(struct ImapAccountData *adata, const char *method)
{
* imap_auth_login - Plain LOGIN support
* @param adata Imap Account data
* @param method Name of this authentication method
- * @retval enum Result, e.g. #IMAP_AUTH_SUCCESS
+ * @retval #ImapAuthRes Result, e.g. #IMAP_AUTH_SUCCESS
*/
enum ImapAuthRes imap_auth_login(struct ImapAccountData *adata, const char *method)
{
* imap_auth_plain - SASL PLAIN support
* @param adata Imap Account data
* @param method Name of this authentication method
- * @retval enum Result, e.g. #IMAP_AUTH_SUCCESS
+ * @retval #ImapAuthRes Result, e.g. #IMAP_AUTH_SUCCESS
*/
enum ImapAuthRes imap_auth_plain(struct ImapAccountData *adata, const char *method)
{
* imap_auth_sasl - Default authenticator if available
* @param adata Imap Account data
* @param method Name of this authentication method
- * @retval enum Result, e.g. #IMAP_AUTH_SUCCESS
+ * @retval #ImapAuthRes Result, e.g. #IMAP_AUTH_SUCCESS
*/
enum ImapAuthRes imap_auth_sasl(struct ImapAccountData *adata, const char *method)
{
* imap_continue - display a message and ask the user if they want to go on
* @param msg Location of the error
* @param resp Message for user
- * @retval enum Result, See #QuadOption
+ * @retval #QuadOption Result, e.g. #MUTT_NO
*/
enum QuadOption imap_continue(const char *msg, const char *resp)
{
* @param s Buffer containing the attachments command
* @param head List of AttachMatch to add to
* @param err Buffer for error messages
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
static enum CommandResult parse_attach_list(struct Buffer *buf, struct Buffer *s,
struct ListHead *head, struct Buffer *err)
* @param line config line to read
* @param token scratch buffer to be used by parser
* @param err where to write error messages
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*
* Caller should free token->data when finished. the reason for this variable
* is to avoid having to allocate and deallocate a lot of memory if we are
* query_quadoption - Ask the user a quad-question
* @param opt Option to use
* @param prompt Message to show to the user
- * @retval enum Result, see #QuadOption
+ * @retval #QuadOption Result, e.g. #MUTT_NO
*/
enum QuadOption query_quadoption(enum QuadOption opt, const char *prompt)
{
* @param macro Macro string
* @param desc Description of macro (OPTIONAL)
* @param err Buffer for error message
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*
* Insert a key sequence into the specified map.
* The map is sorted by ASCII value (lowest to highest)
* @param op Operation, e.g. OP_DELETE
* @param macro Macro string
* @param desc Description of macro (OPTIONAL)
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
enum CommandResult km_bind(char *s, int menu, int op, char *macro, char *desc)
{
* @param menu Menu id, e.g. #MENU_PAGER
* @param op Operation, e.g. OP_DELETE
* @param err Buffer for error message
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
static enum CommandResult km_bindkey_err(const char *s, int menu, int op, struct Buffer *err)
{
* @param s Key string
* @param menu Menu id, e.g. #MENU_PAGER
* @param op Operation, e.g. OP_DELETE
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
static enum CommandResult km_bindkey(const char *s, int menu, int op)
{
* @param func Function name
* @param bindings Key bindings table
* @param err Buffer for error message
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
static enum CommandResult try_bind(char *key, int menu, char *func,
const struct Binding *bindings, struct Buffer *err)
/**
* maildir_hcache_keylen - Calculate the length of the Maildir path
* @param fn File name
- * @retval size_t Length in bytes
+ * @retval num Length in bytes
*
* @note This length excludes the flags, which will vary
*/
}
/**
- * mutt_date_localtime - Converts calendar time to a broken-down time structure expressed in user timezone.
+ * mutt_date_localtime - Converts calendar time to a broken-down time structure expressed in user timezone
* @param t Time
- * @retval tm Broken-down time representation
+ * @retval obj Broken-down time representation
*
* Uses current time if t is #MUTT_DATE_NOW
*/
}
/**
- * mutt_date_gmtime - Converts calendar time to a broken-down time structure expressed in UTC timezone.
+ * mutt_date_gmtime - Converts calendar time to a broken-down time structure expressed in UTC timezone
* @param t Time
- * @retval tm Broken-down time representation
+ * @retval obj Broken-down time representation
*
* Uses current time if t is #MUTT_DATE_NOW
*/
* @param[in] flags Flags, e.g. #MUTT_CONT
* @retval ptr The allocated string
*
- * Read a line from "fp" into the dynamically allocated "s", increasing
- * "s" if necessary. The ending "\n" or "\r\n" is removed. If a line ends
+ * Read a line from "fp" into the dynamically allocated "line", increasing
+ * "line" if necessary. The ending "\n" or "\r\n" is removed. If a line ends
* with "\", this char and the linefeed is removed, and the next line is read
* too.
*/
* char_cmp_identity - Compare two characters
* @param a First character to compare
* @param b Second character to compare
- * @retval a == b
+ * @retval true If (a == b)
*/
static inline bool char_cmp_identity(char a, char b)
{
* char_cmp_lower - Compare two characters ignoring case
* @param a First character to compare
* @param b Second character to compare
- * @retval a == b, ignoring case
+ * @retval true If (a == b), ignoring case
*/
static inline bool char_cmp_lower(char a, char b)
{
typedef bool (*char_cmp)(char, char);
/**
- * get_char_cmp - Retrieve the correct function to compare characters according to a case sensitivity setting.
+ * get_char_cmp - Retrieve the correct function to compare characters according to a case sensitivity setting
* @param cs Case sensitivity setting
- * @retval A char_cmp function pointer
+ * @retval ptr char_cmp function pointer
*/
static char_cmp get_char_cmp(enum CaseSensitivity cs)
{
}
/**
- * mutt_str_startswith - Check whether a string starts with a prefix.
+ * mutt_str_startswith - Check whether a string starts with a prefix
* @param str String to check
* @param prefix Prefix to match
* @param cs Case sensitivity setting
- * @retval Length of prefix if str starts with prefix
+ * @retval num Length of prefix if str starts with prefix
* @retval 0 if str does not start with prefix
*/
size_t mutt_str_startswith(const char *str, const char *prefix, enum CaseSensitivity cs)
* @param s Buffer containing string to be parsed
* @param data Flags associated with the command
* @param err Buffer for error messages
- * @retval enum e.g. #MUTT_CMD_SUCCESS
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
typedef enum CommandResult (*command_t)(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);
* @param major Version MAJOR.x.x
* @param minor Version x.MINOR.x
* @param micro Version x.x.MICRO
- * @retval str Patch level
+ * @retval ptr Patch level string
* @retval NULL If there are fewer parts
*
* Break up the complete string-representation of the version number S, which
/**
* have_gpg_version - Do we have a sufficent GPG version
* @param version Minimum version
- * @retval bool ZZZ
+ * @retval true If minimum version is available
*
* Return true if the OpenPGP engine's version is at least VERSION.
*/
* @param s State to use
* @param sig GPGME signature
* @retval 0 Success
- * @retval 1 There is is a severe warning
+ * @retval 1 There is a severe warning
*
* Display the common attributes of the signature summary SUM.
*/
* - trust info
* - key length
* - pubkey algo
- * - 16 hex digits with the long keyid.
+ * - 16 hex digits with the long keyid
* - timestamp (1998-02-28)
* - Local id
* - ownertrust
return rc;
}
-/*
- * Creating S/MIME - bodies.
- */
+/* Creating S/MIME - bodies */
/**
* smime_invoke_encrypt - Use SMIME to encrypt a file
return a;
}
-/*
- * Handling S/MIME - bodies.
- */
+/* Handling S/MIME - bodies */
/**
* smime_invoke_verify - Use SMIME to verify a file
/**
* get_messages - load messages for a query
* @param query Notmuch query
- * @retval msgs Messages matching query
+ * @retval ptr Messages matching query
* @retval NULL Error occurred
*
* This helper method is to be the single point for retrieving messages. It
/**
* get_threads - load threads for a query
* @param query Notmuch query
- * @retval msgs Threads matching query
+ * @retval ptr Threads matching query
* @retval NULL Error occurred
*
* This helper method is to be the single point for retrieving messages. It
* quote_width - Calculate the paragraph width based upon the quote level
* @param s State to use
* @param ql Quote level
- * @retval int Paragraph width
+ * @retval num Paragraph width
*
* The start of a quoted line will be ">>> ", so we need to subtract the space
* required for the prefix from the terminal width.
projects / neomutt / commitdiff