[tor-commits] [tor/master] Document port_out argument to tor_addr_from_sockaddr

[nickm at torproject.org]

commit 2d879bd39febfcce9ce39f13c897951fee7d8784
Author: Nick Mathewson <nickm at torproject.org>
Date:   Sat Feb 6 15:34:47 2016 -0500

    Document port_out argument to tor_addr_from_sockaddr
---
 src/common/address.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/common/address.c b/src/common/address.c
index 86c32ef..70675c0 100644
--- a/src/common/address.c
+++ b/src/common/address.c
@@ -148,7 +148,9 @@ tor_addr_make_af_unix(tor_addr_t *a)
 }
 
 /** Set the tor_addr_t in <b>a</b> to contain the socket address contained in
- * <b>sa</b>. Return 0 on success and -1 on failure. */
+ * <b>sa</b>.  IF <b>port_out</b> is non-NULL and <b>sa</b> contains a port,
+ * set *<b>port_out</b> to that port. Return 0 on success and -1 on
+ * failure. */
 int
 tor_addr_from_sockaddr(tor_addr_t *a, const struct sockaddr *sa,
                        uint16_t *port_out)