RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
Code Releases Activity

net/nanocoap: Fix return value doc for coap_opt_add_uqueryX()

Browse Source
This commit is contained in:
Ken Bannister 2020-03-06 08:44:40 -05:00
parent c55837d809
commit e6b20b4ce7
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
sys/include/net/nanocoap.h
View File

@ -979,14 +979,15 @@ ssize_t coap_opt_add_opaque(coap_pkt_t *pkt, uint16_t optnum, const uint8_t *val
* @note Use this only for null-terminated string. See @ref coap_opt_add_uquery2()
* for non null-terminated string.
*
* @param[in,out] pkt The package that is being build
* @param[in,out] pkt Packet being built
* @param[in] key Key to add to the query string
* @param[in] val Value to assign to @p key (may be NULL)
*
* @pre ((pkt != NULL) && (key != NULL))
*
* @return overall length of new query string
* @return -1 on error
* @return number of bytes written to pkt buffer
* @return <0 on error
* @return -ENOSPC if no available options or pkt full
*/
ssize_t coap_opt_add_uquery(coap_pkt_t *pkt, const char *key, const char *val);
@ -994,16 +995,18 @@ ssize_t coap_opt_add_uquery(coap_pkt_t *pkt, const char *key, const char *val);
* @brief Adds a single Uri-Query option in the form 'key=value' into pkt
*
*
* @param[in,out] pkt The package that is being build
* @param[in,out] pkt Packet being built
* @param[in] key Key to add to the query string
* @param[in] key_len Length of @p key
* @param[in] val Value to assign to @p key (may be NULL)
* @param[in] val_len Length of @p val. 0 if @p val is NULL
*
* @pre ((pkt != NULL) && (key != NULL) && (key_len > 0))
* @pre ((pkt != NULL) && (key != NULL) && (key_len > 0)
* && ((val_len == 0) || ((val != NULL) && (val_len > 0))))
*
* @return overall length of new query string
* @return -1 on error
* @return number of bytes written to pkt buffer
* @return <0 on error
* @return -ENOSPC if no available options or pkt full
*/
ssize_t coap_opt_add_uquery2(coap_pkt_t *pkt, const char *key, size_t key_len,
const char *val, size_t val_len);