]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Add another missing function doc
authorNick Mathewson <nickm@torproject.org>
Thu, 15 Nov 2012 03:55:23 +0000 (22:55 -0500)
committerNick Mathewson <nickm@torproject.org>
Thu, 15 Nov 2012 04:16:58 +0000 (23:16 -0500)
src/or/relay.c

index 79eb919361b7e59453e923d8a430ec7561dcae7d..d862e58341ded83fdc326c302f8fc056509db8c3 100644 (file)
@@ -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)