Skip to content
Snippets Groups Projects
Commit 3ab2907a authored by Martine Lenders's avatar Martine Lenders
Browse files

Merge pull request #3656 from authmillenon/ipv6_addr/doc/fix

ipv6_addr: adapt doc to proposed changes in #3608
parents 6b22e15a 391522e1
No related branches found
No related tags found
No related merge requests found
...@@ -627,12 +627,13 @@ static inline void ipv6_addr_set_solicited_nodes(ipv6_addr_t *out, const ipv6_ad ...@@ -627,12 +627,13 @@ static inline void ipv6_addr_set_solicited_nodes(ipv6_addr_t *out, const ipv6_ad
* RFC 5952 * RFC 5952
* </a> * </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] addr An IPv6 address
* @param[in] result_len Length of @p result_len * @param[in] result_len Length of @p result_len
* *
* @return @p result, on success * @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 * @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); char *ipv6_addr_to_str(char *result, const ipv6_addr_t *addr, uint8_t result_len);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment