[tor-commits] [tor/master] Clarify function documentation.

[nickm at torproject.org]

commit 7b02d1a73ea4b7b3d780116055bbedaa43d67809
Author: Linus Nordberg <linus at nordberg.se>
Date:   Thu Nov 24 18:39:27 2011 +0100

    Clarify function documentation.
---
 src/or/connection_or.c |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/src/or/connection_or.c b/src/or/connection_or.c
index e178f3a..6990952 100644
--- a/src/or/connection_or.c
+++ b/src/or/connection_or.c
@@ -630,7 +630,9 @@ connection_or_update_token_buckets(smartlist_t *conns,
 
 /** If we don't necessarily know the router we're connecting to, but we
  * have an addr/port/id_digest, then fill in as much as we can. Start
- * by checking to see if this describes a router we know. */
+ * by checking to see if this describes a router we know.
+ * <b>started_here</b> is 1 if we are the initiator of <b>conn</b> and
+ * 0 if it's an incoming connection.  */
 void
 connection_or_init_conn_from_address(or_connection_t *conn,
                                      const tor_addr_t *addr, uint16_t port,