Document return value of channel_get_addr_if_possible

diff --git a/src/or/channel.c b/src/or/channel.c
index 49ce12958529a1ae1d16c79119c4bb2454950e05..10097ae47710b5926586246451080bee586e47ca 100644 (file)
--- 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)
 {