riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ipv6: fix typo in ipv6_addr_to_str documentation

Browse Source 
It doesn't make any sense that `result_len` should specify the length of
`result_len`. Instead, `result_len` should specify the length of the
`result` parameter.
This commit is contained in:
Sören Tempel 2021-09-09 03:56:39 +02:00
parent 4c6dc973c8
commit 71f933312d
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sys/include/net/ipv6/addr.h
View File

@ -699,7 +699,7 @@ static inline void ipv6_addr_set_solicited_nodes(ipv6_addr_t *out, const ipv6_ad
* @param[out] result The resulting string representation of at least * @param[out] result The resulting string representation of at least
* @ref IPV6_ADDR_MAX_STR_LEN * @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
* *
* @return @p result, on success * @return @p result, on success
* @return NULL, if @p result_len was lesser than IPV6_ADDR_MAX_STR_LEN * @return NULL, if @p result_len was lesser than IPV6_ADDR_MAX_STR_LEN