[tor-commits] [tor/master] Document new helper functions in socketpair.c

[nickm at torproject.org]

commit ff7229b32cb2f5a3c384200caac35e0626199087
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Aug 1 09:43:25 2018 -0400

    Document new helper functions in socketpair.c
---
 src/lib/net/socketpair.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/lib/net/socketpair.c b/src/lib/net/socketpair.c
index a12c25cc8..8dd04d048 100644
--- a/src/lib/net/socketpair.c
+++ b/src/lib/net/socketpair.c
@@ -32,6 +32,11 @@
 // Avoid warning about call to memcmp.
 #define raw_memcmp memcmp
 
+/**
+ * Return a new socket that is bound and listening on the loopback interface
+ * of family <b>family</b> for a socket of type <b>type</b>. On failure return
+ * TOR_INVALID_SOCKET.
+ */
 static tor_socket_t
 get_local_listener(int family, int type)
 {
@@ -72,6 +77,9 @@ get_local_listener(int family, int type)
   return TOR_INVALID_SOCKET;
 }
 
+/**
+ * Return true iff sa1 and sa2 are equivalent AF_INET or AF_INET6 addresses.
+ */
 static int
 sockaddr_eq(struct sockaddr *sa1, struct sockaddr *sa2)
 {