From: Richard Russon Date: Mon, 4 Feb 2019 02:31:47 +0000 (+0000) Subject: doxy: mark all out-params X-Git-Tag: 2019-10-25~372^2~11 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=56c39e21cf267f7de887619c47b3ec80bea383ae;p=neomutt doxy: mark all out-params --- diff --git a/alias.c b/alias.c index 7066ebed1..f3adfac20 100644 --- a/alias.c +++ b/alias.c @@ -320,8 +320,8 @@ void mutt_expand_aliases_env(struct Envelope *env) /** * mutt_get_address - Get an Address from an Envelope - * @param env Envelope to examine - * @param pfxp Prefix for the Address, e.g. "To:" + * @param[in] env Envelope to examine + * @param[out] pfxp Prefix for the Address, e.g. "To:" * @retval ptr Address in the Envelope */ struct Address *mutt_get_address(struct Envelope *env, const char **pfxp) @@ -733,7 +733,7 @@ bool mutt_addr_is_user(struct Address *addr) /** * mutt_alias_free - Free an Alias - * @param p Alias to free + * @param[out] p Alias to free */ void mutt_alias_free(struct Alias **p) { diff --git a/bcache.c b/bcache.c index 6d7a5f043..84e945e9a 100644 --- a/bcache.c +++ b/bcache.c @@ -149,7 +149,7 @@ struct BodyCache *mutt_bcache_open(struct ConnAccount *account, const char *mail /** * mutt_bcache_close - Close an Email-Body Cache - * @param bcache Body cache + * @param[out] bcache Body cache * * Free all memory of bcache and finally FREE() it, too. */ diff --git a/compose.c b/compose.c index 3817f0872..b01ab5353 100644 --- a/compose.c +++ b/compose.c @@ -725,9 +725,9 @@ static void compose_custom_redraw(struct Menu *menu) /** * compose_attach_swap - Swap two adjacent entries in the attachment list - * @param msg Body of email - * @param idx Array of Attachments - * @param first Index of first attachment to swap + * @param[in] msg Body of email + * @param[out] idx Array of Attachments + * @param[in] first Index of first attachment to swap */ static void compose_attach_swap(struct Body *msg, struct AttachPtr **idx, short first) { diff --git a/config/address.c b/config/address.c index 6b8b3e592..fc3930bb2 100644 --- a/config/address.c +++ b/config/address.c @@ -267,7 +267,7 @@ struct Address *address_new(const char *addr) /** * address_free - Free an Address object - * @param addr Address to free + * @param[out] addr Address to free */ void address_free(struct Address **addr) { diff --git a/config/cfgaccount.c b/config/cfgaccount.c index 19a9c25a7..638a7df48 100644 --- a/config/cfgaccount.c +++ b/config/cfgaccount.c @@ -96,8 +96,8 @@ struct CfgAccount *ac_new(const struct ConfigSet *cs, const char *name, /** * ac_free - Free an CfgAccount object - * @param cs Config items - * @param ac CfgAccount to free + * @param[in] cs Config items + * @param[out] ac CfgAccount to free */ void ac_free(const struct ConfigSet *cs, struct CfgAccount **ac) { diff --git a/config/mbtable.c b/config/mbtable.c index f9c08cfd9..2fe548f5e 100644 --- a/config/mbtable.c +++ b/config/mbtable.c @@ -305,7 +305,7 @@ void mbtable_init(struct ConfigSet *cs) /** * mbtable_free - Free an MbTable object - * @param table MbTable to free + * @param[out] table MbTable to free */ void mbtable_free(struct MbTable **table) { diff --git a/config/regex.c b/config/regex.c index 98d547832..4402aeaf2 100644 --- a/config/regex.c +++ b/config/regex.c @@ -311,7 +311,7 @@ struct Regex *regex_new(const char *str, int flags, struct Buffer *err) /** * regex_free - Free a Regex object - * @param r Regex to free + * @param[out] r Regex to free */ void regex_free(struct Regex **r) { diff --git a/config/set.c b/config/set.c index f1e4c47a6..2b1200a6c 100644 --- a/config/set.c +++ b/config/set.c @@ -172,7 +172,7 @@ void cs_init(struct ConfigSet *cs, size_t size) /** * cs_free - Free a Config Set - * @param cs Config items + * @param[out] cs Config items */ void cs_free(struct ConfigSet **cs) { diff --git a/conn/sasl.c b/conn/sasl.c index 36fa9e31e..dc42e10d7 100644 --- a/conn/sasl.c +++ b/conn/sasl.c @@ -517,8 +517,8 @@ static int mutt_sasl_conn_poll(struct Connection *conn, time_t wait_secs) /** * mutt_sasl_client_new - wrapper for sasl_client_new - * @param conn Connection to a server - * @param saslconn SASL connection + * @param[in] conn Connection to a server + * @param[out] saslconn SASL connection * @retval 0 Success * @retval -1 Error * diff --git a/context.c b/context.c index c7488df51..176b6c245 100644 --- a/context.c +++ b/context.c @@ -42,7 +42,7 @@ /** * ctx_free - Free a Context - * @param ctx Context to free + * @param[out] ctx Context to free */ void ctx_free(struct Context **ctx) { diff --git a/copy.c b/copy.c index 32966b125..0830c04ca 100644 --- a/copy.c +++ b/copy.c @@ -967,8 +967,8 @@ static int copy_delete_attach(struct Body *b, FILE *fpin, FILE *fpout, char *dat /** * format_address_header - Write address headers to a buffer - * @param h Array of header strings - * @param a Email Address + * @param[out] h Array of header strings + * @param[in] a Email Address * * This function is the equivalent of mutt_write_address_list(), but writes to * a buffer instead of writing to a stream. mutt_write_address_list could be @@ -1039,7 +1039,7 @@ static void format_address_header(char **h, struct Address *a) /** * address_header_decode - Parse an email's headers - * @param h Array of header strings + * @param[out] h Array of header strings * @retval 0 Success * @retval 1 Failure */ diff --git a/edit.c b/edit.c index 68a97da23..b9d9e17ad 100644 --- a/edit.c +++ b/edit.c @@ -160,9 +160,9 @@ static char **be_snarf_file(const char *path, char **buf, int *max, int *len, bo /** * be_barf_file - Write a buffer to a file - * @param path Path to write to - * @param buf Buffer to read from - * @param buflen Length of buffer + * @param[in] path Path to write to + * @param[out] buf Buffer to read from + * @param[in] buflen Length of buffer * @retval 0 Success * @retval -1 Error */ @@ -185,8 +185,8 @@ static int be_barf_file(const char *path, char **buf, int buflen) /** * be_free_memory - Free an array of buffers - * @param buf Buffer to free - * @param buflen Number of buffers to free + * @param[out] buf Buffer to free + * @param[in] buflen Number of buffers to free */ static void be_free_memory(char **buf, int buflen) { diff --git a/email/address.c b/email/address.c index f88e442c5..a85380c31 100644 --- a/email/address.c +++ b/email/address.c @@ -66,7 +66,7 @@ const char *const AddressErrors[] = { /** * free_address - Free a single Address - * @param a Address to free + * @param[out] a Address to free * * @note This doesn't alter the links if the Address is in a list. */ @@ -367,8 +367,8 @@ static const char *parse_addr_spec(const char *s, char *comment, size_t *comment /** * add_addrspec - Parse an email address and add an Address to a list - * @param[in] top Top of Address list - * @param[in] last End of Address list + * @param[out] top Top of Address list + * @param[out] last End of Address list * @param[in] phrase String to parse * @param[out] comment Buffer for any comments * @param[out] commentlen Length of any comments @@ -405,8 +405,8 @@ struct Address *mutt_addr_new(void) /** * mutt_addr_remove_from_list - Remove an Address from a list - * @param a Address list - * @param mailbox Email address to match + * @param[out] a Address list + * @param[in] mailbox Email address to match * @retval 0 Success * @retval -1 Error, or email not found */ @@ -441,7 +441,7 @@ int mutt_addr_remove_from_list(struct Address **a, const char *mailbox) /** * mutt_addr_free - Free a list of Addresses - * @param p Top of the list + * @param[out] p Top of the list */ void mutt_addr_free(struct Address **p) { @@ -753,9 +753,9 @@ struct Address *mutt_addr_copy_list(struct Address *addr, bool prune) /** * mutt_addr_append - Append one list of addresses onto another - * @param a Destination Address list - * @param b Source Address list - * @param prune Skip groups if there are more addresses + * @param[out] a Destination Address list + * @param[in] b Source Address list + * @param[in] prune Skip groups if there are more addresses * @retval ptr Last Address in the combined list * * Append the Source onto the end of the Destination Address list. diff --git a/email/attach.c b/email/attach.c index 892710084..e2182d8d9 100644 --- a/email/attach.c +++ b/email/attach.c @@ -114,7 +114,7 @@ void mutt_actx_free_entries(struct AttachCtx *actx) /** * mutt_actx_free - Free an Attachment Context - * @param pactx Attachment context + * @param[out] pactx Attachment context */ void mutt_actx_free(struct AttachCtx **pactx) { diff --git a/email/body.c b/email/body.c index 1426809a8..1385907fe 100644 --- a/email/body.c +++ b/email/body.c @@ -52,7 +52,7 @@ struct Body *mutt_body_new(void) /** * mutt_body_free - Free a Body - * @param p Body to free + * @param[out] p Body to free */ void mutt_body_free(struct Body **p) { diff --git a/email/email.c b/email/email.c index eebfc371a..b9b952dce 100644 --- a/email/email.c +++ b/email/email.c @@ -36,7 +36,7 @@ /** * mutt_email_free - Free an Email - * @param e Email to free + * @param[out] e Email to free */ void mutt_email_free(struct Email **e) { diff --git a/email/envelope.c b/email/envelope.c index 5357de857..8faf81820 100644 --- a/email/envelope.c +++ b/email/envelope.c @@ -48,7 +48,7 @@ struct Envelope *mutt_env_new(void) /** * mutt_env_free - Free an Envelope - * @param p Envelope to free + * @param[out] p Envelope to free */ void mutt_env_free(struct Envelope **p) { @@ -90,8 +90,8 @@ void mutt_env_free(struct Envelope **p) /** * mutt_env_merge - Merge the headers of two Envelopes - * @param base Envelope destination for all the headers - * @param extra Envelope to copy from + * @param[in] base Envelope destination for all the headers + * @param[out] extra Envelope to copy from * * Any fields that are missing from base will be copied from extra. * extra will be freed afterwards. diff --git a/email/idna.c b/email/idna.c index d4eb70933..a94b7a861 100644 --- a/email/idna.c +++ b/email/idna.c @@ -94,9 +94,9 @@ static bool check_idn(char *domain) /** * mutt_idna_to_ascii_lz - Convert a domain to Punycode - * @param input Domain - * @param output Result - * @param flags Flags, e.g. IDNA_ALLOW_UNASSIGNED + * @param[in] input Domain + * @param[out] output Result + * @param[in] flags Flags, e.g. IDNA_ALLOW_UNASSIGNED * @retval 0 Success * @retval >0 Failure, error code * diff --git a/email/parameter.c b/email/parameter.c index 8f3bad466..1066324e3 100644 --- a/email/parameter.c +++ b/email/parameter.c @@ -43,7 +43,7 @@ struct Parameter *mutt_param_new(void) /** * mutt_param_free_one - Free a Parameter - * @param p Parameter to free + * @param[out] p Parameter to free */ void mutt_param_free_one(struct Parameter **p) { diff --git a/email/parse.c b/email/parse.c index 1f56f6624..f3d308339 100644 --- a/email/parse.c +++ b/email/parse.c @@ -324,8 +324,8 @@ int mutt_check_mime_type(const char *s) /** * mutt_extract_message_id - Find a message-id - * @param s String to parse - * @param saveptr Save result here + * @param[in] s String to parse + * @param[out] saveptr Save result here * @retval ptr First character after message-id * @retval NULL No more message ids * diff --git a/email/rfc2047.c b/email/rfc2047.c index 45cc4c976..d4922a0d5 100644 --- a/email/rfc2047.c +++ b/email/rfc2047.c @@ -414,14 +414,14 @@ static char *decode_word(const char *s, size_t len, enum ContentEncoding enc) /** * encode - RFC2047-encode a string - * @param d String to convert - * @param dlen Length of string - * @param col Starting column to convert - * @param fromcode Original encoding - * @param charsets List of allowable encodings (colon separated) - * @param e Encoded string - * @param elen Length of encoded string - * @param specials Special characters to be encoded + * @param[in] d String to convert + * @param[in] dlen Length of string + * @param[in] col Starting column to convert + * @param[in] fromcode Original encoding + * @param[in] charsets List of allowable encodings (colon separated) + * @param[out] e Encoded string + * @param[out] elen Length of encoded string + * @param[in] specials Special characters to be encoded * @retval 0 Success */ static int encode(const char *d, size_t dlen, int col, const char *fromcode, diff --git a/email/rfc2231.c b/email/rfc2231.c index 4bd19cfa9..48c133770 100644 --- a/email/rfc2231.c +++ b/email/rfc2231.c @@ -138,8 +138,8 @@ static struct Rfc2231Parameter *new_parameter(void) /** * list_insert - Insert parameter into an ordered list - * @param list List to insert into - * @param par Parameter to insert + * @param[out] list List to insert into + * @param[in] par Parameter to insert * * Primary sorting key: attribute * Secondary sorting key: index @@ -165,7 +165,7 @@ static void list_insert(struct Rfc2231Parameter **list, struct Rfc2231Parameter /** * free_parameter - Free an Rfc2231Parameter - * @param p Rfc2231Parameter to free + * @param[out] p Rfc2231Parameter to free */ static void free_parameter(struct Rfc2231Parameter **p) { @@ -314,7 +314,7 @@ void rfc2231_decode_parameters(struct ParameterList *p) /** * rfc2231_encode_string - Encode a string to be suitable for an RFC2231 header - * @param pd String to encode + * @param[out] pd String to encode * @retval 1 If string was encoded * @retval 0 If no * diff --git a/email/url.c b/email/url.c index e06a0bc3d..069ca7062 100644 --- a/email/url.c +++ b/email/url.c @@ -283,7 +283,7 @@ err: /** * url_free - Free the contents of a URL - * @param u Url to empty + * @param[out] u Url to empty * * @note The Url itself is not freed */ diff --git a/enter.c b/enter.c index ae044c7c7..89879de27 100644 --- a/enter.c +++ b/enter.c @@ -808,7 +808,7 @@ bye: /** * mutt_enter_state_free - Free an EnterState - * @param esp EnterState to free + * @param[out] esp EnterState to free */ void mutt_enter_state_free(struct EnterState **esp) { diff --git a/filter.c b/filter.c index 267d7dccf..1e4d085e6 100644 --- a/filter.c +++ b/filter.c @@ -40,13 +40,13 @@ /** * mutt_create_filter_fd - Run a command on a pipe (optionally connect stdin/stdout) - * @param cmd Command line to invoke using `sh -c` - * @param in File stream pointing to stdin for the command process, can be NULL - * @param out File stream pointing to stdout for the command process, can be NULL - * @param err File stream pointing to stderr for the command process, can be NULL - * @param fdin If `in` is NULL and fdin is not -1 then fdin will be used as stdin for the command process - * @param fdout If `out` is NULL and fdout is not -1 then fdout will be used as stdout for the command process - * @param fderr If `error` is NULL and fderr is not -1 then fderr will be used as stderr for the command process + * @param[in] cmd Command line to invoke using `sh -c` + * @param[out] in File stream pointing to stdin for the command process, can be NULL + * @param[out] out File stream pointing to stdout for the command process, can be NULL + * @param[out] err File stream pointing to stderr for the command process, can be NULL + * @param[in] fdin If `in` is NULL and fdin is not -1 then fdin will be used as stdin for the command process + * @param[in] fdout If `out` is NULL and fdout is not -1 then fdout will be used as stdout for the command process + * @param[in] fderr If `error` is NULL and fderr is not -1 then fderr will be used as stderr for the command process * @retval num PID of the created process * @retval -1 Error creating pipes or forking * diff --git a/hcache/backend.h b/hcache/backend.h index ce1d87c3d..4ba9fcc29 100644 --- a/hcache/backend.h +++ b/hcache/backend.h @@ -61,8 +61,8 @@ struct HcacheOps void *(*fetch)(void *ctx, const char *key, size_t keylen); /** * free - backend-specific routine to free fetched data - * @param ctx The backend-specific context retrieved via open() - * @param data A pointer to the data got with fetch() or fetch_raw() + * @param[in] ctx The backend-specific context retrieved via open() + * @param[out] data A pointer to the data got with fetch() or fetch_raw() */ void (*free)(void *ctx, void **data); /** @@ -87,7 +87,7 @@ struct HcacheOps int (*delete)(void *ctx, const char *key, size_t keylen); /** * close - backend-specific routine to close a context - * @param ctx The backend-specific context retrieved via open() + * @param[out] ctx The backend-specific context retrieved via open() * * Backend code is responsible for freeing any resources associated with the * @a ctx parameter. For this reason, backend code is passed a pointer-to-pointer diff --git a/hcache/serialize.c b/hcache/serialize.c index e3bef9bdc..335ed2bd4 100644 --- a/hcache/serialize.c +++ b/hcache/serialize.c @@ -158,10 +158,10 @@ unsigned char *serial_dump_char(char *c, unsigned char *d, int *off, bool conver /** * serial_restore_char - Unpack a variable-length string from a binary blob - * @param c Store the unpacked string here - * @param d Binary blob to read from - * @param off Offset into the blob - * @param convert If true, the strings will be converted to utf-8 + * @param[out] c Store the unpacked string here + * @param[in] d Binary blob to read from + * @param[out] off Offset into the blob + * @param[in] convert If true, the strings will be converted to utf-8 */ void serial_restore_char(char **c, const unsigned char *d, int *off, bool convert) { @@ -223,10 +223,10 @@ unsigned char *serial_dump_address(struct Address *a, unsigned char *d, int *off /** * serial_restore_address - Unpack an Address from a binary blob - * @param a Store the unpacked Address here - * @param d Binary blob to read from - * @param off Offset into the blob - * @param convert If true, the strings will be converted from utf-8 + * @param[out] a Store the unpacked Address here + * @param[in] d Binary blob to read from + * @param[out] off Offset into the blob + * @param[in] convert If true, the strings will be converted from utf-8 */ void serial_restore_address(struct Address **a, const unsigned char *d, int *off, bool convert) { @@ -326,10 +326,10 @@ unsigned char *serial_dump_buffer(struct Buffer *b, unsigned char *d, int *off, /** * serial_restore_buffer - Unpack a Buffer from a binary blob - * @param b Store the unpacked Buffer here - * @param d Binary blob to read from - * @param off Offset into the blob - * @param convert If true, the strings will be converted from utf-8 + * @param[out] b Store the unpacked Buffer here + * @param[in] d Binary blob to read from + * @param[out] off Offset into the blob + * @param[in] convert If true, the strings will be converted from utf-8 */ void serial_restore_buffer(struct Buffer **b, const unsigned char *d, int *off, bool convert) { diff --git a/imap/message.c b/imap/message.c index 6ea048d62..45c8c2e34 100644 --- a/imap/message.c +++ b/imap/message.c @@ -70,7 +70,7 @@ char *ImapHeaders; ///< Config: (imap) Additional email headers to download when /** * imap_edata_free - free ImapHeader structure - * @retval ptr Private Email data + * @param[out] ptr Private Email data */ void imap_edata_free(void **ptr) { diff --git a/imap/utf7.c b/imap/utf7.c index ca6fd047a..66d9b352a 100644 --- a/imap/utf7.c +++ b/imap/utf7.c @@ -311,8 +311,8 @@ bail: /** * imap_utf_encode - Encode email from local charset to UTF-8 - * @param unicode true if Unicode is allowed - * @param s Email to convert + * @param[in] unicode true if Unicode is allowed + * @param[out] s Email to convert */ void imap_utf_encode(bool unicode, char **s) { diff --git a/imap/util.c b/imap/util.c index bad357482..bd6c9a521 100644 --- a/imap/util.c +++ b/imap/util.c @@ -68,7 +68,7 @@ short ImapPipelineDepth; ///< Config: (imap) Number of IMAP commands that may be /** * imap_adata_free - Release and clear storage in an ImapAccountData structure - * @param ptr Imap Account data + * @param[out] ptr Imap Account data */ void imap_adata_free(void **ptr) { @@ -216,7 +216,7 @@ void imap_mdata_cache_reset(struct ImapMboxData *mdata) /** * imap_mdata_free - Release and clear storage in an ImapMboxData structure - * @param ptr Imap Mailbox data + * @param[out] ptr Imap Mailbox data */ void imap_mdata_free(void **ptr) { @@ -1260,7 +1260,7 @@ int mutt_seqset_iterator_next(struct SeqsetIterator *iter, unsigned int *next) /** * mutt_seqset_iterator_free - Free a Sequence Set Iterator - * @param p_iter Iterator to free + * @param[out] p_iter Iterator to free */ void mutt_seqset_iterator_free(struct SeqsetIterator **p_iter) { diff --git a/mailbox.c b/mailbox.c index df245bea6..dc4b16539 100644 --- a/mailbox.c +++ b/mailbox.c @@ -98,7 +98,7 @@ struct Mailbox *mailbox_new(void) /** * mailbox_free - Free a Mailbox - * @param ptr Mailbox to free + * @param[out] ptr Mailbox to free */ void mailbox_free(struct Mailbox **ptr) { diff --git a/maildir/shared.c b/maildir/shared.c index bb288a42a..dba0218b8 100644 --- a/maildir/shared.c +++ b/maildir/shared.c @@ -81,7 +81,7 @@ char *MhSeqUnseen; ///< Config: MH sequence for unseen messages /** * maildir_mdata_free - Free data attached to the Mailbox - * @param ptr Maildir data + * @param[out] ptr Maildir data */ void maildir_mdata_free(void **ptr) { @@ -263,7 +263,7 @@ static void mh_sequences_add_one(struct Mailbox *m, int n, bool unseen, bool fla /** * maildir_free_entry - Free a Maildir object - * @param md Maildir to free + * @param[out] md Maildir to free */ static void maildir_free_entry(struct Maildir **md) { @@ -279,7 +279,7 @@ static void maildir_free_entry(struct Maildir **md) /** * maildir_free_maildir - Free a Maildir list - * @param md Maildir list to free + * @param[out] md Maildir list to free */ static void maildir_free_maildir(struct Maildir **md) { @@ -327,11 +327,11 @@ static void maildir_update_mtime(struct Mailbox *m) /** * maildir_parse_dir - Read a Maildir mailbox - * @param m Mailbox - * @param last Last Maildir - * @param subdir Subdirectory, e.g. 'new' - * @param count Counter for the progress bar - * @param progress Progress bar + * @param[in] m Mailbox + * @param[out] last Last Maildir + * @param[in] subdir Subdirectory, e.g. 'new' + * @param[out] count Counter for the progress bar + * @param[in] progress Progress bar * @retval 0 Success * @retval -1 Error * @retval -2 Aborted @@ -468,8 +468,8 @@ static int maildir_add_to_context(struct Mailbox *m, struct Maildir *md) /** * maildir_move_to_context - Copy the Maildir list to the Mailbox - * @param m Mailbox - * @param md Maildir list to copy, then free + * @param[in] m Mailbox + * @param[out] md Maildir list to copy, then free * @retval num Number of new emails * @retval 0 Error */ @@ -659,8 +659,8 @@ static struct Maildir *maildir_sort(struct Maildir *list, size_t len, /** * mh_sort_natural - Sort a Maildir list into its natural order - * @param m Mailbox - * @param md Maildir list to sort + * @param[in] m Mailbox + * @param[out] md Maildir list to sort * * Currently only defined for MH where files are numbered. */ @@ -699,9 +699,9 @@ static struct Maildir *skip_duplicates(struct Maildir *p, struct Maildir **last) /** * maildir_delayed_parsing - This function does the second parsing pass - * @param m Mailbox - * @param md Maildir to parse - * @param progress Progress bar + * @param[in] m Mailbox + * @param[out] md Maildir to parse + * @param[in] progress Progress bar */ void maildir_delayed_parsing(struct Mailbox *m, struct Maildir **md, struct Progress *progress) { @@ -1240,10 +1240,10 @@ void maildir_update_tables(struct Context *ctx, int *index_hint) /** * md_open_find_message - Find a message in a maildir folder - * @param folder Base folder - * @param unique Unique part of filename - * @param subfolder Subfolder to search, e.g. 'cur' - * @param newname File's new name + * @param[in] folder Base folder + * @param[in] unique Unique part of filename + * @param[in] subfolder Subfolder to search, e.g. 'cur' + * @param[out] newname File's new name * @retval ptr File handle * * These functions try to find a message in a maildir folder when it @@ -1570,9 +1570,9 @@ bool maildir_update_flags(struct Mailbox *m, struct Email *o, struct Email *n) /** * maildir_open_find_message - Find a new - * @param folder Maildir path - * @param msg Email path - * @param newname New name, if it has moved + * @param[in] folder Maildir path + * @param[in] msg Email path + * @param[out] newname New name, if it has moved * @retval ptr File handle */ FILE *maildir_open_find_message(const char *folder, const char *msg, char **newname) diff --git a/mbox/mbox.c b/mbox/mbox.c index 5b7f821e4..1a7adef03 100644 --- a/mbox/mbox.c +++ b/mbox/mbox.c @@ -71,7 +71,7 @@ struct MUpdate /** * mbox_adata_free - Free data attached to the Mailbox - * @param ptr Private mailbox data + * @param[out] ptr Private mailbox data */ static void mbox_adata_free(void **ptr) { diff --git a/menu.c b/menu.c index 3e5430e58..1860e1920 100644 --- a/menu.c +++ b/menu.c @@ -997,7 +997,7 @@ struct Menu *mutt_menu_new(int menu) /** * mutt_menu_destroy - Destroy a menu - * @param p Menu to destroy + * @param[out] p Menu to destroy */ void mutt_menu_destroy(struct Menu **p) { diff --git a/mutt/buffer.c b/mutt/buffer.c index 451e3fbc9..43670316b 100644 --- a/mutt/buffer.c +++ b/mutt/buffer.c @@ -133,7 +133,7 @@ size_t mutt_buffer_addstr_n(struct Buffer *buf, const char *s, size_t len) /** * mutt_buffer_free - Release a Buffer and its contents - * @param p Buffer pointer to free and NULL + * @param[out] p Buffer pointer to free and NULL */ void mutt_buffer_free(struct Buffer **p) { @@ -391,7 +391,7 @@ struct Buffer *mutt_buffer_pool_get(void) /** * mutt_buffer_pool_release - Free a Buffer from the pool - * @param pbuf Buffer to free + * @param[out] pbuf Buffer to free */ void mutt_buffer_pool_release(struct Buffer **pbuf) { diff --git a/mutt/charset.c b/mutt/charset.c index b45265046..171d08e10 100644 --- a/mutt/charset.c +++ b/mutt/charset.c @@ -842,7 +842,7 @@ struct FgetConv *mutt_ch_fgetconv_open(FILE *file, const char *from, const char /** * mutt_ch_fgetconv_close - Close an fgetconv handle - * @param fc fgetconv handle + * @param[out] fc fgetconv handle */ void mutt_ch_fgetconv_close(struct FgetConv **fc) { diff --git a/mutt/file.c b/mutt/file.c index 7e2060469..ea1e53cf7 100644 --- a/mutt/file.c +++ b/mutt/file.c @@ -142,7 +142,7 @@ static int put_file_in_place(const char *path, const char *safe_file, const char /** * mutt_file_fclose - Close a FILE handle (and NULL the pointer) - * @param f FILE handle to close + * @param[out] f FILE handle to close * @retval 0 Success * @retval EOF Error, see errno */ @@ -158,7 +158,7 @@ int mutt_file_fclose(FILE **f) /** * mutt_file_fsync_close - Flush the data, before closing a file (and NULL the pointer) - * @param f FILE handle to close + * @param[out] f FILE handle to close * @retval 0 Success * @retval EOF Error, see errno */ diff --git a/mutt/hash.c b/mutt/hash.c index c47885462..f9cc89425 100644 --- a/mutt/hash.c +++ b/mutt/hash.c @@ -453,7 +453,7 @@ void mutt_hash_int_delete(struct Hash *table, unsigned int intkey, const void *d /** * mutt_hash_free - elem_free a hash table - * @param ptr Hash Table to be freed + * @param[out] ptr Hash Table to be freed */ void mutt_hash_free(struct Hash **ptr) { diff --git a/mutt/list.h b/mutt/list.h index 87c1368a2..06a2b4003 100644 --- a/mutt/list.h +++ b/mutt/list.h @@ -46,7 +46,7 @@ STAILQ_HEAD(ListHead, ListNode); /** * typedef list_free_t - Prototype for a function to free List data - * @param ptr Data to free + * @param[out] ptr Data to free */ typedef void (*list_free_t)(void **ptr); diff --git a/mutt/mbyte.c b/mutt/mbyte.c index 620c1812a..5310effaf 100644 --- a/mutt/mbyte.c +++ b/mutt/mbyte.c @@ -277,10 +277,10 @@ void mutt_mb_wcstombs(char *dest, size_t dlen, const wchar_t *src, size_t slen) /** * mutt_mb_mbstowcs - Convert a string from multibyte to wide characters - * @param pwbuf Buffer for the result - * @param pwbuflen Length of the result buffer - * @param i Starting index into the result buffer - * @param buf String to convert + * @param[out] pwbuf Buffer for the result + * @param[out] pwbuflen Length of the result buffer + * @param[in] i Starting index into the result buffer + * @param[in] buf String to convert * @retval num First character after the result */ size_t mutt_mb_mbstowcs(wchar_t **pwbuf, size_t *pwbuflen, size_t i, char *buf) diff --git a/mutt/regex.c b/mutt/regex.c index 55b52b66d..f3630bca8 100644 --- a/mutt/regex.c +++ b/mutt/regex.c @@ -102,7 +102,7 @@ struct Regex *mutt_regex_new(const char *str, int flags, struct Buffer *err) /** * mutt_regex_free - Free a Regex object - * @param r Regex to free + * @param[out] r Regex to free */ void mutt_regex_free(struct Regex **r) { diff --git a/mutt/string.c b/mutt/string.c index 0bc3e3b8c..d3d9618d0 100644 --- a/mutt/string.c +++ b/mutt/string.c @@ -449,8 +449,8 @@ char *mutt_str_strncat(char *d, size_t l, const char *s, size_t sl) /** * mutt_str_replace - Replace one string with another - * @param p String to replace - * @param s New string + * @param[out] p String to replace + * @param[in] s New string * * This function free()s the original string, strdup()s the new string and * overwrites the pointer to the first string. @@ -465,9 +465,9 @@ void mutt_str_replace(char **p, const char *s) /** * mutt_str_append_item - Add string to another separated by sep - * @param str String appended - * @param item String to append - * @param sep separator between string item + * @param[out] str String appended + * @param[in] item String to append + * @param[in] sep separator between string item * * This function appends a string to another separate them by sep * if needed @@ -489,7 +489,7 @@ void mutt_str_append_item(char **str, const char *item, int sep) /** * mutt_str_adjust - Shrink-to-fit a string - * @param p String to alter + * @param[out] p String to alter * * Take a string which is allocated on the heap, find its length and reallocate * the memory to be exactly the right size. diff --git a/mutt_history.c b/mutt_history.c index 0365e6c0e..41e30c1ca 100644 --- a/mutt_history.c +++ b/mutt_history.c @@ -83,10 +83,10 @@ static void history_make_entry(char *buf, size_t buflen, struct Menu *menu, int /** * history_menu - Select an item from a history list - * @param buf Buffer in which to save string - * @param buflen Buffer length - * @param matches Items to choose from - * @param match_count Number of items + * @param[in] buf Buffer in which to save string + * @param[in] buflen Buffer length + * @param[out] matches Items to choose from + * @param[in] match_count Number of items */ static void history_menu(char *buf, size_t buflen, char **matches, int match_count) { diff --git a/mutt_lua.c b/mutt_lua.c index f1e17cb05..577bead1b 100644 --- a/mutt_lua.c +++ b/mutt_lua.c @@ -409,7 +409,7 @@ static void luaopen_mutt(lua_State *l) /** * lua_init - Initialise a Lua State - * @param l Lua State + * @param[out] l Lua State * @retval true If successful */ static bool lua_init(lua_State **l) diff --git a/mx.c b/mx.c index 8a50d1a30..514b3821b 100644 --- a/mx.c +++ b/mx.c @@ -528,7 +528,7 @@ static int trash_append(struct Mailbox *m) /** * mx_mbox_close - Save changes and close mailbox - * @param ptr Mailbox + * @param[out] ptr Mailbox * @retval 0 Success * @retval -1 Failure * @@ -1056,8 +1056,8 @@ int mx_msg_commit(struct Mailbox *m, struct Message *msg) /** * mx_msg_close - Close a message - * @param m Mailbox - * @param msg Message to close + * @param[in] m Mailbox + * @param[out] msg Message to close * @retval 0 Success * @retval -1 Failure */ diff --git a/ncrypt/crypt.c b/ncrypt/crypt.c index 9acdfeb38..1738d3d8f 100644 --- a/ncrypt/crypt.c +++ b/ncrypt/crypt.c @@ -1208,10 +1208,10 @@ int mutt_signed_handler(struct Body *a, struct State *s) /** * crypt_get_fingerprint_or_id - Get the fingerprint or long key ID - * @param p String to examine - * @param pphint Start of string to be passed to pgp_add_string_to_hints() or crypt_add_string_to_hints() - * @param ppl Start of long key ID if detected, else NULL - * @param pps Start of short key ID if detected, else NULL + * @param[in] p String to examine + * @param[out] pphint Start of string to be passed to pgp_add_string_to_hints() or crypt_add_string_to_hints() + * @param[out] ppl Start of long key ID if detected, else NULL + * @param[out] pps Start of short key ID if detected, else NULL * @retval ptr Copy of fingerprint, if any, stripped of all spaces. Must be FREE'd by caller * @retval NULL Otherwise * diff --git a/ncrypt/crypt_gpgme.c b/ncrypt/crypt_gpgme.c index d539ee004..578d4f954 100644 --- a/ncrypt/crypt_gpgme.c +++ b/ncrypt/crypt_gpgme.c @@ -553,7 +553,7 @@ static struct CryptKeyInfo *crypt_copy_key(struct CryptKeyInfo *key) /** * crypt_free_key - Release all the keys in a list - * @param keylist List of keys + * @param[out] keylist List of keys */ static void crypt_free_key(struct CryptKeyInfo **keylist) { diff --git a/ncrypt/pgpinvoke.c b/ncrypt/pgpinvoke.c index 1901ef6b1..3b541be05 100644 --- a/ncrypt/pgpinvoke.c +++ b/ncrypt/pgpinvoke.c @@ -189,17 +189,17 @@ static void mutt_pgp_command(char *buf, size_t buflen, /** * pgp_invoke - Run a PGP command - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param need_passphrase Is a passphrase needed? - * @param fname Filename to pass to the command - * @param sig_fname Signature filename to pass to the command - * @param ids List of IDs/fingerprints, space separated - * @param format printf-like format string + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] need_passphrase Is a passphrase needed? + * @param[in] fname Filename to pass to the command + * @param[in] sig_fname Signature filename to pass to the command + * @param[in] ids List of IDs/fingerprints, space separated + * @param[in] format printf-like format string * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -238,14 +238,14 @@ static pid_t pgp_invoke(FILE **pgpin, FILE **pgpout, FILE **pgperr, int pgpinfd, /** * pgp_invoke_decode - Use PGP to decode a message - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command - * @param need_passphrase Is a passphrase needed? + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command + * @param[in] need_passphrase Is a passphrase needed? * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -261,14 +261,14 @@ pid_t pgp_invoke_decode(FILE **pgpin, FILE **pgpout, FILE **pgperr, int pgpinfd, /** * pgp_invoke_verify - Use PGP to verify a message - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command - * @param sig_fname Signature filename to pass to the command + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command + * @param[in] sig_fname Signature filename to pass to the command * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -284,13 +284,13 @@ pid_t pgp_invoke_verify(FILE **pgpin, FILE **pgpout, FILE **pgperr, int pgpinfd, /** * pgp_invoke_decrypt - Use PGP to decrypt a file - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -306,13 +306,13 @@ pid_t pgp_invoke_decrypt(FILE **pgpin, FILE **pgpout, FILE **pgperr, int pgpinfd /** * pgp_invoke_sign - Use PGP to sign a file - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -328,15 +328,15 @@ pid_t pgp_invoke_sign(FILE **pgpin, FILE **pgpout, FILE **pgperr, int pgpinfd, /** * pgp_invoke_encrypt - Use PGP to encrypt a file - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command - * @param uids List of IDs/fingerprints, space separated - * @param sign If true, also sign the file + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command + * @param[in] uids List of IDs/fingerprints, space separated + * @param[in] sign If true, also sign the file * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -361,15 +361,15 @@ pid_t pgp_invoke_encrypt(FILE **pgpin, FILE **pgpout, FILE **pgperr, /** * pgp_invoke_traditional - Use PGP to create in inline-signed message - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command - * @param uids List of IDs/fingerprints, space separated - * @param flags Flags, e.g. #SIGN, #ENCRYPT + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command + * @param[in] uids List of IDs/fingerprints, space separated + * @param[in] flags Flags, e.g. #SIGN, #ENCRYPT * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -462,13 +462,13 @@ void pgp_class_invoke_getkeys(struct Address *addr) /** * pgp_invoke_export - Use PGP to export a key from the user's keyring - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param uids List of IDs/fingerprints, space separated + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] uids List of IDs/fingerprints, space separated * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -484,13 +484,13 @@ pid_t pgp_invoke_export(FILE **pgpin, FILE **pgpout, FILE **pgperr, int pgpinfd, /** * pgp_invoke_verify_key - Use PGP to verify a key - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param uids List of IDs/fingerprints, space separated + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] uids List of IDs/fingerprints, space separated * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -506,14 +506,14 @@ pid_t pgp_invoke_verify_key(FILE **pgpin, FILE **pgpout, FILE **pgperr, int pgpi /** * pgp_invoke_list_keys - Find matching PGP Keys - * @param pgpin stdin for the command, or NULL (OPTIONAL) - * @param pgpout stdout for the command, or NULL (OPTIONAL) - * @param pgperr stderr for the command, or NULL (OPTIONAL) - * @param pgpinfd stdin for the command, or -1 (OPTIONAL) - * @param pgpoutfd stdout for the command, or -1 (OPTIONAL) - * @param pgperrfd stderr for the command, or -1 (OPTIONAL) - * @param keyring Keyring type, e.g. #PGP_SECRING - * @param hints Match keys to these strings + * @param[out] pgpin stdin for the command, or NULL (OPTIONAL) + * @param[out] pgpout stdout for the command, or NULL (OPTIONAL) + * @param[out] pgperr stderr for the command, or NULL (OPTIONAL) + * @param[in] pgpinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] pgpoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] pgperrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] keyring Keyring type, e.g. #PGP_SECRING + * @param[in] hints Match keys to these strings * @retval num PID of the created process * @retval -1 Error creating pipes or forking * diff --git a/ncrypt/pgplib.c b/ncrypt/pgplib.c index be774c111..01e34f995 100644 --- a/ncrypt/pgplib.c +++ b/ncrypt/pgplib.c @@ -113,7 +113,7 @@ short pgp_get_abilities(unsigned char type) /** * pgp_free_uid - Free a PGP UID - * @param upp PGP UID to free + * @param[out] upp PGP UID to free */ static void pgp_free_uid(struct PgpUid **upp) { @@ -157,7 +157,7 @@ struct PgpUid *pgp_copy_uids(struct PgpUid *up, struct PgpKeyInfo *parent) /** * free_key - Free a PGP Key info - * @param kpp PGP Key info to free + * @param[out] kpp PGP Key info to free */ static void free_key(struct PgpKeyInfo **kpp) { @@ -174,8 +174,8 @@ static void free_key(struct PgpKeyInfo **kpp) /** * pgp_remove_key - Remove a PGP key from a list - * @param klist List of PGP Keys - * @param key Key to remove + * @param[out] klist List of PGP Keys + * @param[in] key Key to remove * @retval ptr Updated list of PGP Keys */ struct PgpKeyInfo *pgp_remove_key(struct PgpKeyInfo **klist, struct PgpKeyInfo *key) @@ -208,7 +208,7 @@ struct PgpKeyInfo *pgp_remove_key(struct PgpKeyInfo **klist, struct PgpKeyInfo * /** * pgp_free_key - Free a PGP key info - * @param kpp PGP key info to free + * @param[out] kpp PGP key info to free */ void pgp_free_key(struct PgpKeyInfo **kpp) { diff --git a/ncrypt/smime.c b/ncrypt/smime.c index 5ab158a6b..b258eb2aa 100644 --- a/ncrypt/smime.c +++ b/ncrypt/smime.c @@ -107,7 +107,7 @@ static char SmimeIntermediateToUse[PATH_MAX]; /** * smime_free_key - Free a list of SMIME keys - * @param keylist List of keys to free + * @param[out] keylist List of keys to free */ static void smime_free_key(struct SmimeKey **keylist) { @@ -359,20 +359,20 @@ static void smime_command(char *buf, size_t buflen, /** * smime_invoke - Run an SMIME command - * @param smimein stdin for the command, or NULL (OPTIONAL) - * @param smimeout stdout for the command, or NULL (OPTIONAL) - * @param smimeerr stderr for the command, or NULL (OPTIONAL) - * @param smimeinfd stdin for the command, or -1 (OPTIONAL) - * @param smimeoutfd stdout for the command, or -1 (OPTIONAL) - * @param smimeerrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command - * @param sig_fname Signature filename to pass to the command - * @param cryptalg Encryption algorithm - * @param digestalg Hashing algorithm - * @param key SMIME key - * @param certificates Public certificates - * @param intermediates Intermediate certificates - * @param format printf-like format string + * @param[out] smimein stdin for the command, or NULL (OPTIONAL) + * @param[out] smimeout stdout for the command, or NULL (OPTIONAL) + * @param[out] smimeerr stderr for the command, or NULL (OPTIONAL) + * @param[in] smimeinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] smimeoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] smimeerrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command + * @param[in] sig_fname Signature filename to pass to the command + * @param[in] cryptalg Encryption algorithm + * @param[in] digestalg Hashing algorithm + * @param[in] key SMIME key + * @param[in] certificates Public certificates + * @param[in] intermediates Intermediate certificates + * @param[in] format printf-like format string * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -1491,14 +1491,14 @@ int smime_class_verify_sender(struct Email *e) /** * smime_invoke_encrypt - Use SMIME to encrypt a file - * @param smimein stdin for the command, or NULL (OPTIONAL) - * @param smimeout stdout for the command, or NULL (OPTIONAL) - * @param smimeerr stderr for the command, or NULL (OPTIONAL) - * @param smimeinfd stdin for the command, or -1 (OPTIONAL) - * @param smimeoutfd stdout for the command, or -1 (OPTIONAL) - * @param smimeerrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command - * @param uids List of IDs/fingerprints, space separated + * @param[out] smimein stdin for the command, or NULL (OPTIONAL) + * @param[out] smimeout stdout for the command, or NULL (OPTIONAL) + * @param[out] smimeerr stderr for the command, or NULL (OPTIONAL) + * @param[in] smimeinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] smimeoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] smimeerrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command + * @param[in] uids List of IDs/fingerprints, space separated * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -1516,13 +1516,13 @@ static pid_t smime_invoke_encrypt(FILE **smimein, FILE **smimeout, FILE **smimee /** * smime_invoke_sign - Use SMIME to sign a file - * @param smimein stdin for the command, or NULL (OPTIONAL) - * @param smimeout stdout for the command, or NULL (OPTIONAL) - * @param smimeerr stderr for the command, or NULL (OPTIONAL) - * @param smimeinfd stdin for the command, or -1 (OPTIONAL) - * @param smimeoutfd stdout for the command, or -1 (OPTIONAL) - * @param smimeerrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command + * @param[out] smimein stdin for the command, or NULL (OPTIONAL) + * @param[out] smimeout stdout for the command, or NULL (OPTIONAL) + * @param[out] smimeerr stderr for the command, or NULL (OPTIONAL) + * @param[in] smimeinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] smimeoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] smimeerrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -1834,15 +1834,15 @@ struct Body *smime_class_sign_message(struct Body *a) /** * smime_invoke_verify - Use SMIME to verify a file - * @param smimein stdin for the command, or NULL (OPTIONAL) - * @param smimeout stdout for the command, or NULL (OPTIONAL) - * @param smimeerr stderr for the command, or NULL (OPTIONAL) - * @param smimeinfd stdin for the command, or -1 (OPTIONAL) - * @param smimeoutfd stdout for the command, or -1 (OPTIONAL) - * @param smimeerrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command - * @param sig_fname Signature filename to pass to the command - * @param opaque If true, use `$smime_verify_opaque_command` else `$smime_verify_command` + * @param[out] smimein stdin for the command, or NULL (OPTIONAL) + * @param[out] smimeout stdout for the command, or NULL (OPTIONAL) + * @param[out] smimeerr stderr for the command, or NULL (OPTIONAL) + * @param[in] smimeinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] smimeoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] smimeerrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command + * @param[in] sig_fname Signature filename to pass to the command + * @param[in] opaque If true, use `$smime_verify_opaque_command` else `$smime_verify_command` * @retval num PID of the created process * @retval -1 Error creating pipes or forking * @@ -1860,13 +1860,13 @@ static pid_t smime_invoke_verify(FILE **smimein, FILE **smimeout, FILE **smimeer /** * smime_invoke_decrypt - Use SMIME to decrypt a file - * @param smimein stdin for the command, or NULL (OPTIONAL) - * @param smimeout stdout for the command, or NULL (OPTIONAL) - * @param smimeerr stderr for the command, or NULL (OPTIONAL) - * @param smimeinfd stdin for the command, or -1 (OPTIONAL) - * @param smimeoutfd stdout for the command, or -1 (OPTIONAL) - * @param smimeerrfd stderr for the command, or -1 (OPTIONAL) - * @param fname Filename to pass to the command + * @param[out] smimein stdin for the command, or NULL (OPTIONAL) + * @param[out] smimeout stdout for the command, or NULL (OPTIONAL) + * @param[out] smimeerr stderr for the command, or NULL (OPTIONAL) + * @param[in] smimeinfd stdin for the command, or -1 (OPTIONAL) + * @param[in] smimeoutfd stdout for the command, or -1 (OPTIONAL) + * @param[in] smimeerrfd stderr for the command, or -1 (OPTIONAL) + * @param[in] fname Filename to pass to the command * @retval num PID of the created process * @retval -1 Error creating pipes or forking * diff --git a/nntp/nntp.c b/nntp/nntp.c index b7720cb77..0bb8d7a76 100644 --- a/nntp/nntp.c +++ b/nntp/nntp.c @@ -117,7 +117,7 @@ struct ChildCtx /** * nntp_adata_free - Free data attached to the Mailbox - * @param ptr NNTP data + * @param[out] ptr NNTP data * * The NntpAccountData struct stores global NNTP data, such as the connection to * the database. This function will close the database, free the resources and @@ -173,7 +173,7 @@ struct NntpAccountData *nntp_adata_get(struct Mailbox *m) /** * nntp_mdata_free - Free NntpMboxData, used to destroy hash elements - * @param ptr NNTP data + * @param[out] ptr NNTP data */ void nntp_mdata_free(void **ptr) { @@ -191,7 +191,7 @@ void nntp_mdata_free(void **ptr) /** * nntp_edata_free - Free data attached to an Email - * @param data Email data + * @param[out] data Email data */ static void nntp_edata_free(void **data) { diff --git a/notmuch/mutt_notmuch.c b/notmuch/mutt_notmuch.c index 6750a995d..7a3f242d1 100644 --- a/notmuch/mutt_notmuch.c +++ b/notmuch/mutt_notmuch.c @@ -106,7 +106,7 @@ static enum NmQueryType string_to_query_type(const char *str) /** * nm_adata_free - Release and clear storage in an NmAccountData structure - * @param ptr Nm Account data + * @param[out] ptr Nm Account data */ void nm_adata_free(void **ptr) { @@ -154,7 +154,7 @@ struct NmAccountData *nm_adata_get(struct Mailbox *m) /** * nm_mdata_free - Free data attached to the Mailbox - * @param ptr Notmuch data + * @param[out] ptr Notmuch data * * The NmMboxData struct stores global Notmuch data, such as the connection to * the database. This function will close the database, free the resources and @@ -218,7 +218,7 @@ struct NmMboxData *nm_mdata_get(struct Mailbox *m) /** * nm_edata_free - Free data attached to an Email - * @param ptr Email data + * @param[out] ptr Email data * * Each email has an attached NmEmailData, which contains things like the tags * (labels). @@ -2027,9 +2027,9 @@ done: /** * nm_get_all_tags - Fill a list with all notmuch tags - * @param m Mailbox - * @param tag_list List of tags - * @param tag_count Number of tags + * @param[in] m Mailbox + * @param[out] tag_list List of tags + * @param[out] tag_count Number of tags * @retval 0 Success * @retval -1 Failure * diff --git a/pager.c b/pager.c index cedf8b72d..4b2dfde5a 100644 --- a/pager.c +++ b/pager.c @@ -487,7 +487,7 @@ static void shift_class_colors(struct QClass *quote_list, /** * cleanup_quote - Free a quote list - * @param quote_list Quote list to free + * @param[out] quote_list Quote list to free */ static void cleanup_quote(struct QClass **quote_list) { @@ -507,7 +507,7 @@ static void cleanup_quote(struct QClass **quote_list) /** * classify_quote - Find a style for a string - * @param[in] quote_list List of quote colours + * @param[out] quote_list List of quote colours * @param[in] qptr String to classify * @param[in] length Length of string * @param[out] force_redraw Set to true if a screen redraw is needed @@ -898,15 +898,15 @@ int mutt_is_quote_line(char *line, regmatch_t *pmatch) /** * resolve_types - Determine the style for a line of text - * @param buf Formatted text - * @param raw Raw text - * @param line_info Line info array - * @param n Line number (index into line_info) - * @param last Last line - * @param quote_list List of quote colours - * @param q_level Quote level - * @param force_redraw Set to true if a screen redraw is needed - * @param q_classify If true, style the text + * @param[in] buf Formatted text + * @param[in] raw Raw text + * @param[in] line_info Line info array + * @param[in] n Line number (index into line_info) + * @param[in] last Last line + * @param[out] quote_list List of quote colours + * @param[out] q_level Quote level + * @param[out] force_redraw Set to true if a screen redraw is needed + * @param[in] q_classify If true, style the text */ static void resolve_types(char *buf, char *raw, struct Line *line_info, int n, int last, struct QClass **quote_list, int *q_level, @@ -1347,7 +1347,7 @@ static int fill_buffer(FILE *f, LOFF_T *last_pos, LOFF_T offset, unsigned char * /** * format_line - Display a line of text in the pager - * @param[in] line_info Line info + * @param[out] line_info Line info * @param[in] n Line number (index into line_info) * @param[in] buf Text to display * @param[in] flags Flags, e.g. #MUTT_PAGER_NOWRAP @@ -1535,18 +1535,18 @@ static int format_line(struct Line **line_info, int n, unsigned char *buf, int f /** * display_line - Print a line on screen - * @param f File to read from - * @param last_pos Offset into file - * @param line_info Line attributes - * @param n Line number - * @param last Last line - * @param max Maximum number of lines - * @param flags See below - * @param quote_list Email quoting style - * @param q_level Level of quoting - * @param force_redraw Force a repaint - * @param search_re Regex to highlight - * @param pager_window Window to draw into + * @param[in] f File to read from + * @param[out] last_pos Offset into file + * @param[out] line_info Line attributes + * @param[in] n Line number + * @param[out] last Last line + * @param[out] max Maximum number of lines + * @param[in] flags See below + * @param[out] quote_list Email quoting style + * @param[out] q_level Level of quoting + * @param[out] force_redraw Force a repaint + * @param[out] search_re Regex to highlight + * @param[in] pager_window Window to draw into * @retval -1 EOF was reached * @retval 0 normal exit, line was not displayed * @retval >0 normal exit, line was displayed diff --git a/pattern.c b/pattern.c index 5ba304fdb..84592fca8 100644 --- a/pattern.c +++ b/pattern.c @@ -1332,7 +1332,7 @@ static /* const */ char *find_matching_paren(/* const */ char *s) /** * mutt_pattern_free - Free a Pattern - * @param pat Pattern to free + * @param[out] pat Pattern to free */ void mutt_pattern_free(struct Pattern **pat) { diff --git a/pop/pop.c b/pop/pop.c index a1d35e05e..bce26a1f3 100644 --- a/pop/pop.c +++ b/pop/pop.c @@ -97,7 +97,7 @@ static const char *cache_id(const char *id) /** * pop_adata_free - Free data attached to the Mailbox - * @param ptr POP data + * @param[out] ptr POP data * * The PopAccountData struct stores global POP data, such as the connection to * the database. This function will close the database, free the resources and @@ -124,7 +124,7 @@ static struct PopAccountData *pop_adata_new(void) /** * pop_edata_free - Free data attached to an Email - * @param ptr Email data + * @param[out] ptr Email data * * Each email has an attached PopEmailData, which contains things like the tags * (labels). diff --git a/postpone.c b/postpone.c index 7693a631e..d43629a48 100644 --- a/postpone.c +++ b/postpone.c @@ -278,11 +278,11 @@ static struct Email *select_msg(struct Context *ctx) /** * mutt_get_postponed - Recall a postponed message - * @param ctx Context info, used when recalling a message to which we reply - * @param hdr envelope/attachment info for recalled message - * @param cur if message was a reply, `cur' is set to the message which `hdr' is in reply to - * @param fcc fcc for the recalled message - * @param fcclen max length of fcc + * @param[in] ctx Context info, used when recalling a message to which we reply + * @param[in] hdr envelope/attachment info for recalled message + * @param[out] cur if message was a reply, `cur' is set to the message which `hdr' is in reply to + * @param[in] fcc fcc for the recalled message + * @param[in] fcclen max length of fcc * @retval -1 Error/no messages * @retval 0 Normal exit * @retval #SEND_REPLY Recalled message is a reply diff --git a/query.c b/query.c index 68143d5d5..1ea82ab22 100644 --- a/query.c +++ b/query.c @@ -105,7 +105,7 @@ static struct Address *result_to_addr(struct Query *r) /** * free_query - Free a Query - * @param query Query to free + * @param[out] query Query to free */ static void free_query(struct Query **query) { diff --git a/remailer.c b/remailer.c index fd87c62c9..0d8d497c3 100644 --- a/remailer.c +++ b/remailer.c @@ -115,7 +115,7 @@ static int mix_get_caps(const char *capstr) /** * mix_add_entry - Add an entry to the Remailer list - * @param[in] type2_list Remailer list to add to + * @param[out] type2_list Remailer list to add to * @param[in] entry Remailer to add * @param[out] slots Total number of slots * @param[out] used Number of slots used @@ -145,7 +145,7 @@ static struct Remailer *mix_new_remailer(void) /** * mix_free_remailer - Free a Remailer - * @param r Remailer to free + * @param[out] r Remailer to free */ static void mix_free_remailer(struct Remailer **r) { @@ -247,7 +247,7 @@ static struct Remailer **mix_type2_list(size_t *l) /** * mix_free_type2_list - Free a Remailer List - * @param ttlp Remailer List to free + * @param[out] ttlp Remailer List to free */ static void mix_free_type2_list(struct Remailer ***ttlp) { @@ -265,10 +265,10 @@ static void mix_free_type2_list(struct Remailer ***ttlp) /** * mix_screen_coordinates - Get the screen coordinates to place a chain - * @param type2_list Remailer List - * @param coordsp On screen coordinates - * @param chain Chain - * @param i Index in chain + * @param[out] type2_list Remailer List + * @param[out] coordsp On screen coordinates + * @param[in] chain Chain + * @param[in] i Index in chain */ static void mix_screen_coordinates(struct Remailer **type2_list, struct Coord **coordsp, struct MixChain *chain, int i) @@ -312,11 +312,11 @@ static void mix_screen_coordinates(struct Remailer **type2_list, struct Coord ** /** * mix_redraw_ce - Redraw the Remailer chain - * @param type2_list Remailer List - * @param coords Screen Coordinates - * @param chain Chain - * @param i Index in chain - * @param selected true, if this item is selected + * @param[out] type2_list Remailer List + * @param[in] coords Screen Coordinates + * @param[in] chain Chain + * @param[in] i Index in chain + * @param[in] selected true, if this item is selected */ static void mix_redraw_ce(struct Remailer **type2_list, struct Coord *coords, struct MixChain *chain, int i, bool selected) @@ -342,10 +342,10 @@ static void mix_redraw_ce(struct Remailer **type2_list, struct Coord *coords, /** * mix_redraw_chain - Redraw the chain on screen - * @param type2_list Remailer List - * @param coords Where to draw the list on screen - * @param chain Chain to display - * @param cur Chain index of current selection + * @param[out] type2_list Remailer List + * @param[in] coords Where to draw the list on screen + * @param[in] chain Chain to display + * @param[in] cur Chain index of current selection */ static void mix_redraw_chain(struct Remailer **type2_list, struct Coord *coords, struct MixChain *chain, int cur) @@ -507,9 +507,9 @@ static void mix_entry(char *buf, size_t buflen, struct Menu *menu, int num) /** * mix_chain_add - Add a host to the chain - * @param chain Chain to add to - * @param s Hostname - * @param type2_list Remailer List + * @param[in] chain Chain to add to + * @param[in] s Hostname + * @param[out] type2_list Remailer List * @retval 0 Success * @retval -1 Error */ diff --git a/rfc1524.c b/rfc1524.c index eeeaf43a2..08722205c 100644 --- a/rfc1524.c +++ b/rfc1524.c @@ -406,7 +406,7 @@ struct Rfc1524MailcapEntry *rfc1524_new_entry(void) /** * rfc1524_free_entry - Deallocate an struct Rfc1524MailcapEntry - * @param entry Rfc1524MailcapEntry to deallocate + * @param[out] entry Rfc1524MailcapEntry to deallocate */ void rfc1524_free_entry(struct Rfc1524MailcapEntry **entry) { diff --git a/safe_asprintf.c b/safe_asprintf.c index 543a6499f..c8dd30b7c 100644 --- a/safe_asprintf.c +++ b/safe_asprintf.c @@ -38,9 +38,9 @@ #ifdef HAVE_VASPRINTF /** * safe_asprintf - Format a string, allocating space as necessary - * @param strp New string saved here - * @param fmt Format string - * @param ... Format arguments + * @param[out] strp New string saved here + * @param[in] fmt Format string + * @param[in] ... Format arguments * @retval num Characters written * @retval -1 Error */ diff --git a/send.c b/send.c index 1b048e9f5..a2b0baf4e 100644 --- a/send.c +++ b/send.c @@ -228,8 +228,8 @@ static struct Address *find_mailing_lists(struct Address *t, struct Address *c) /** * edit_address - Edit an email address - * @param a Address to edit - * @param field Prompt for user + * @param[out] a Address to edit + * @param[in] field Prompt for user * @retval 0 Success * @retval -1 Failure */ @@ -608,10 +608,10 @@ static int include_reply(struct Mailbox *m, struct Email *e, FILE *out) /** * default_to - Generate default email addresses - * @param to 'To' address - * @param env Envelope to populate - * @param flags Flags, e.g. #SEND_LIST_REPLY - * @param hmfupto If true, add 'followup-to' address to 'to' address + * @param[out] to 'To' address + * @param[in] env Envelope to populate + * @param[in] flags Flags, e.g. #SEND_LIST_REPLY + * @param[in] hmfupto If true, add 'followup-to' address to 'to' address * @retval 0 Success * @retval -1 Aborted */ diff --git a/sendlib.c b/sendlib.c index caaa21bf8..9d7206aa1 100644 --- a/sendlib.c +++ b/sendlib.c @@ -2664,10 +2664,10 @@ static int send_msg(const char *path, char **args, const char *msg, char **tempf /** * add_args - Add an Address to a dynamic array - * @param args Array to add to - * @param argslen Number of entries in array - * @param argsmax Allocated size of the array - * @param addr Address to add + * @param[out] args Array to add to + * @param[out] argslen Number of entries in array + * @param[out] argsmax Allocated size of the array + * @param[in] addr Address to add * @retval ptr Updated array */ static char **add_args(char **args, size_t *argslen, size_t *argsmax, struct Address *addr) @@ -2687,10 +2687,10 @@ static char **add_args(char **args, size_t *argslen, size_t *argsmax, struct Add /** * add_option - Add a string to a dynamic array - * @param args Array to add to - * @param argslen Number of entries in array - * @param argsmax Allocated size of the array - * @param s string to add + * @param[out] args Array to add to + * @param[out] argslen Number of entries in array + * @param[out] argsmax Allocated size of the array + * @param[in] s string to add * @retval ptr Updated array * * @note The array may be realloc()'d