doc: describe parameters to suppress doxygen warnings
This commit is contained in:
@@ -22,11 +22,15 @@
|
|||||||
typedef struct _xmpp_rand_t xmpp_rand_t;
|
typedef struct _xmpp_rand_t xmpp_rand_t;
|
||||||
|
|
||||||
/** Create new xmpp_rand_t object.
|
/** Create new xmpp_rand_t object.
|
||||||
|
*
|
||||||
|
* @param ctx A Strophe context object
|
||||||
*
|
*
|
||||||
* @ingroup Random
|
* @ingroup Random
|
||||||
*/
|
*/
|
||||||
xmpp_rand_t *xmpp_rand_new(xmpp_ctx_t *ctx);
|
xmpp_rand_t *xmpp_rand_new(xmpp_ctx_t *ctx);
|
||||||
/** Destroy an xmpp_rand_t object.
|
/** Destroy an xmpp_rand_t object.
|
||||||
|
*
|
||||||
|
* @param ctx A Strophe context object
|
||||||
*
|
*
|
||||||
* @ingroup Random
|
* @ingroup Random
|
||||||
*/
|
*/
|
||||||
@@ -47,7 +51,10 @@ int xmpp_rand(xmpp_rand_t *rand);
|
|||||||
void xmpp_rand_bytes(xmpp_rand_t *rand, unsigned char *output, size_t len);
|
void xmpp_rand_bytes(xmpp_rand_t *rand, unsigned char *output, size_t len);
|
||||||
|
|
||||||
/** Generate a nonce that is printable randomized string.
|
/** Generate a nonce that is printable randomized string.
|
||||||
|
* This function doesn't allocate memory and doesn't fail.
|
||||||
*
|
*
|
||||||
|
* @param output A buffer where a NULL-terminated string will be placed.
|
||||||
|
* The string will contain len-1 printable symbols.
|
||||||
* @param len Number of bytes reserved for the output string, including
|
* @param len Number of bytes reserved for the output string, including
|
||||||
* end of line '\0'.
|
* end of line '\0'.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -36,6 +36,7 @@ typedef struct resolver_srv_rr_struc {
|
|||||||
/** Perform lookup for RFC1035 message format.
|
/** Perform lookup for RFC1035 message format.
|
||||||
* This function allocates all elements.
|
* This function allocates all elements.
|
||||||
*
|
*
|
||||||
|
* @param ctx a Strophe context object
|
||||||
* @param buf message in RFC1035 format
|
* @param buf message in RFC1035 format
|
||||||
* @param len length of the message
|
* @param len length of the message
|
||||||
* @param srv_rr_list is the result
|
* @param srv_rr_list is the result
|
||||||
@@ -46,6 +47,7 @@ int resolver_srv_lookup_buf(xmpp_ctx_t *ctx, const unsigned char *buf,
|
|||||||
size_t len, resolver_srv_rr_t **srv_rr_list);
|
size_t len, resolver_srv_rr_t **srv_rr_list);
|
||||||
/** Resolve SRV record.
|
/** Resolve SRV record.
|
||||||
*
|
*
|
||||||
|
* @param ctx a Strophe context object
|
||||||
* @param service service of the SRV record
|
* @param service service of the SRV record
|
||||||
* @param proto protocol of the SRV record
|
* @param proto protocol of the SRV record
|
||||||
* @param domain resolving domain
|
* @param domain resolving domain
|
||||||
@@ -59,6 +61,7 @@ int resolver_srv_lookup(xmpp_ctx_t *ctx, const char *service, const char *proto,
|
|||||||
/** Release a list returned by resolver_srv_lookup() or
|
/** Release a list returned by resolver_srv_lookup() or
|
||||||
* resolver_srv_lookup_buf().
|
* resolver_srv_lookup_buf().
|
||||||
*
|
*
|
||||||
|
* @param ctx a Strophe context object
|
||||||
* @param srv_rr_list a list allocated by lookup functions
|
* @param srv_rr_list a list allocated by lookup functions
|
||||||
*/
|
*/
|
||||||
void resolver_srv_free(xmpp_ctx_t *ctx, resolver_srv_rr_t *srv_rr_list);
|
void resolver_srv_free(xmpp_ctx_t *ctx, resolver_srv_rr_t *srv_rr_list);
|
||||||
|
|||||||
@@ -1101,6 +1101,7 @@ _stanza_new_with_attrs(xmpp_ctx_t *ctx, const char * const name,
|
|||||||
/** Create a <message/> stanza object with given attributes.
|
/** Create a <message/> stanza object with given attributes.
|
||||||
* Attributes are optional and may be NULL.
|
* Attributes are optional and may be NULL.
|
||||||
*
|
*
|
||||||
|
* @param ctx a Strophe context object
|
||||||
* @param type attribute 'type'
|
* @param type attribute 'type'
|
||||||
* @param to attribute 'to'
|
* @param to attribute 'to'
|
||||||
* @param id attribute 'id'
|
* @param id attribute 'id'
|
||||||
@@ -1187,6 +1188,7 @@ int xmpp_message_set_body(xmpp_stanza_t *msg, const char * const text)
|
|||||||
/** Create an <iq/> stanza object with given attributes.
|
/** Create an <iq/> stanza object with given attributes.
|
||||||
* Attributes are optional and may be NULL.
|
* Attributes are optional and may be NULL.
|
||||||
*
|
*
|
||||||
|
* @param ctx a Strophe context object
|
||||||
* @param type attribute 'type'
|
* @param type attribute 'type'
|
||||||
* @param id attribute 'id'
|
* @param id attribute 'id'
|
||||||
*
|
*
|
||||||
@@ -1201,6 +1203,8 @@ xmpp_stanza_t *xmpp_iq_new(xmpp_ctx_t *ctx, const char * const type,
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** Create a <presence/> stanza object.
|
/** Create a <presence/> stanza object.
|
||||||
|
*
|
||||||
|
* @param ctx a Strophe context object
|
||||||
*
|
*
|
||||||
* @return a new Strophe stanza object
|
* @return a new Strophe stanza object
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -24,6 +24,7 @@
|
|||||||
|
|
||||||
/** Generate UUID version 4 in pre-allocated buffer.
|
/** Generate UUID version 4 in pre-allocated buffer.
|
||||||
*
|
*
|
||||||
|
* @param ctx a Strophe context object
|
||||||
* @param uuid pre-allocated buffer of size (XMPP_UUID_LEN + 1)
|
* @param uuid pre-allocated buffer of size (XMPP_UUID_LEN + 1)
|
||||||
*/
|
*/
|
||||||
static void crypto_uuid_gen(xmpp_ctx_t *ctx, char *uuid)
|
static void crypto_uuid_gen(xmpp_ctx_t *ctx, char *uuid)
|
||||||
@@ -56,6 +57,8 @@ static void crypto_uuid_gen(xmpp_ctx_t *ctx, char *uuid)
|
|||||||
* This function allocates memory for the resulting string and must be freed
|
* This function allocates memory for the resulting string and must be freed
|
||||||
* with xmpp_free().
|
* with xmpp_free().
|
||||||
*
|
*
|
||||||
|
* @param ctx a Strophe context object
|
||||||
|
*
|
||||||
* @return ASCIIZ string
|
* @return ASCIIZ string
|
||||||
*/
|
*/
|
||||||
char *xmpp_uuid_gen(xmpp_ctx_t *ctx)
|
char *xmpp_uuid_gen(xmpp_ctx_t *ctx)
|
||||||
|
|||||||
Reference in New Issue
Block a user