aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2016-02-06 15:34:47 -0500
committerNick Mathewson <nickm@torproject.org>2016-02-06 15:34:47 -0500
commit2d879bd39febfcce9ce39f13c897951fee7d8784 (patch)
tree7b4df5b3d06cf1d0105ad4e99e83ab293de49b88 /src
parent0f5f6b8a412615026603954b1760006723026da1 (diff)
downloadtor-2d879bd39febfcce9ce39f13c897951fee7d8784.tar.gz
tor-2d879bd39febfcce9ce39f13c897951fee7d8784.zip
Document port_out argument to tor_addr_from_sockaddr
Diffstat (limited to 'src')
-rw-r--r--src/common/address.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/common/address.c b/src/common/address.c
index 86c32efdd9..70675c0a7a 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)