Change in ...osmo-ggsn[master]: in46_addr: Improve in46a_ntop documentation

[laforge]

laforge has submitted this change and it was merged. ( https://gerrit.osmocom.org/c/osmo-ggsn/+/15247 )

Change subject: in46_addr: Improve in46a_ntop documentation
......................................................................

in46_addr: Improve in46a_ntop documentation

Change-Id: I27238c330f9b805ac9e734e735d2c7ae158fe524
---
M lib/in46_addr.c
1 file changed, 5 insertions(+), 1 deletion(-)

Approvals:
  Jenkins Builder: Verified
  osmith: Looks good to me, approved
  laforge: Looks good to me, approved



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 @@
 	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;

-- 
To view, visit https://gerrit.osmocom.org/c/osmo-ggsn/+/15247
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-ggsn
Gerrit-Branch: master
Gerrit-Change-Id: I27238c330f9b805ac9e734e735d2c7ae158fe524
Gerrit-Change-Number: 15247
Gerrit-PatchSet: 3
Gerrit-Owner: pespin <pespin at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: laforge <laforge at gnumonks.org>
Gerrit-Reviewer: osmith <osmith at sysmocom.de>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20190829/eb3c12f3/attachment.htm>