1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

ipv6_addr: adapt doc to proposed changes in #3608

This commit is contained in:
Martine Lenders 2015-08-18 18:54:26 +02:00
parent 147bf75d5b
commit 391522e1a8

View File

@ -627,12 +627,13 @@ static inline void ipv6_addr_set_solicited_nodes(ipv6_addr_t *out, const ipv6_ad
* RFC 5952
* </a>
*
* @param[out] result The resulting string representation
* @param[out] result The resulting string representation of at least
* @ref IPV6_ADDR_MAX_STR_LEN
* @param[in] addr An IPv6 address
* @param[in] result_len Length of @p result_len
*
* @return @p result, on success
* @return NULL, if @p result_len was smaller than needed
* @return NULL, if @p result_len was lesser than IPV6_ADDR_MAX_STR_LEN
* @return NULL, if @p result or @p addr was NULL
*/
char *ipv6_addr_to_str(char *result, const ipv6_addr_t *addr, uint8_t result_len);