[tor-commits] [tor/master] Document return value of channel_get_addr_if_possible

[nickm at torproject.org]

commit f633184af1f0dd4a0d2a4c3490d95a8aa6e964d1
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Oct 17 10:34:23 2012 -0400

    Document return value of channel_get_addr_if_possible
---
 src/or/channel.c |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/or/channel.c b/src/or/channel.c
index 49ce129..10097ae 100644
--- a/src/or/channel.c
+++ b/src/or/channel.c
@@ -3506,12 +3506,12 @@ channel_get_canonical_remote_descr(channel_t *chan)
 }
 
 /**
- * Get remote address if possible
+ * Get remote address if possible.
  *
  * Write the remote address out to a tor_addr_t if the underlying transport
- * supports this operation.
+ * supports this operation, and return 1.  Return 0 if the underlying transport
+ * doesn't let us do this.
  */
-
 int
 channel_get_addr_if_possible(channel_t *chan, tor_addr_t *addr_out)
 {