diff options
author | Pau Espin Pedrol <pespin@sysmocom.de> | 2019-08-20 12:20:11 +0200 |
---|---|---|
committer | Pau Espin Pedrol <pespin@sysmocom.de> | 2019-08-28 11:14:51 +0200 |
commit | 95cd897c3fd3d43ee073a3aa8934a289a8ab545e (patch) | |
tree | be0f301dac5990def6bb143cc5cb1d6eaff60195 /lib | |
parent | f7884e880e827eaff2032210d25156d0d83851ca (diff) |
in46_addr: Improve in46a_ntop documentation
Change-Id: I27238c330f9b805ac9e734e735d2c7ae158fe524
Diffstat (limited to 'lib')
-rw-r--r-- | lib/in46_addr.c | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/lib/in46_addr.c b/lib/in46_addr.c index f4bb8a2..2562c71 100644 --- a/lib/in46_addr.c +++ b/lib/in46_addr.c @@ -60,7 +60,11 @@ int in46a_to_sas(struct sockaddr_storage *out, const struct in46_addr *in) return 0; } -/*! Convenience wrapper around inet_ntop() for \ref in46_addr */ +/*! Convenience wrapper around inet_ntop() for in46_addr. + * \param[in] in the in46_addr to print + * \param[out] dst destination buffer where string representation of the address is stored + * \param[out] dst_size size dst. Usually it should be at least INET6_ADDRSTRLEN. + * \return address of dst on success, NULL on error */ const char *in46a_ntop(const struct in46_addr *in, char *dst, socklen_t dst_size) { int af; |