From: Nick Mathewson <nickm@torproject.org>
Date: Thu, 15 Nov 2012 03:55:23 +0000 (-0500)
Subject: Add another missing function doc
X-Git-Tag: tor-0.2.4.7-alpha~35^2~5
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e3ceac38d9d7b731abe5605d13735ee051eff623;p=thirdparty%2Ftor.git

Add another missing function doc
---

diff --git a/src/or/relay.c b/src/or/relay.c
index 79eb919361..d862e58341 100644
--- a/src/or/relay.c
+++ b/src/or/relay.c
@@ -858,7 +858,11 @@ remap_event_helper(entry_connection_t *conn, const tor_addr_t *new_addr)
                               REMAP_STREAM_SOURCE_EXIT);
 }
 
-/**DOCDOC*/
+/** Extract the contents of a connected cell in <b>cell</b>, whose relay
+ * header has already been parsed into <b>rh</b>. On success, set
+ * <b>addr_out</b> to the address we're connected to, and <b>ttl_out</b> to
+ * the ttl of that address, in seconds, and return 0.  On failure, return
+ * -1. */
 int
 connected_cell_parse(const relay_header_t *rh, const cell_t *cell,
                      tor_addr_t *addr_out, int *ttl_out)