aboutsummaryrefslogtreecommitdiff
path: root/src/or/circuitlist.c
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2007-02-16 20:39:37 +0000
committerNick Mathewson <nickm@torproject.org>2007-02-16 20:39:37 +0000
commitd2893398f6c98f4ad82f05c41fb9ca40c5020015 (patch)
tree1600a6f6ab31cff26dd6a3c4710a3fd1cd5e530f /src/or/circuitlist.c
parenta3ec172e1ac0e1ae2b2a09c05edb4e7f2fef4a1e (diff)
downloadtor-d2893398f6c98f4ad82f05c41fb9ca40c5020015.tar.gz
tor-d2893398f6c98f4ad82f05c41fb9ca40c5020015.zip
r11832@catbus: nickm | 2007-02-16 15:31:59 -0500
Fix 35 remaining DOCDOC comments. Yowza. svn:r9596
Diffstat (limited to 'src/or/circuitlist.c')
-rw-r--r--src/or/circuitlist.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/or/circuitlist.c b/src/or/circuitlist.c
index 3c494be12f..3f00f2da7d 100644
--- a/src/or/circuitlist.c
+++ b/src/or/circuitlist.c
@@ -48,14 +48,15 @@ _orconn_circid_entries_eq(orconn_circid_circuit_map_t *a,
return a->or_conn == b->or_conn && a->circ_id == b->circ_id;
}
-/** DOCDOC */
+/** Helper: return a hash based on circuit ID and the pointer value of
+ * or_conn in <b>a</b>. */
static INLINE unsigned int
_orconn_circid_entry_hash(orconn_circid_circuit_map_t *a)
{
return (((unsigned)a->circ_id)<<16) ^ (unsigned)(uintptr_t)(a->or_conn);
}
-/** DOCDOC */
+/** Map from [orconn,circid] to circuit. */
static HT_HEAD(orconn_circid_map, orconn_circid_circuit_map_t)
orconn_circid_circuit_map = HT_INITIALIZER();
HT_PROTOTYPE(orconn_circid_map, orconn_circid_circuit_map_t, node,
@@ -319,7 +320,8 @@ origin_circuit_new(void)
return circ;
}
-/** DOCDOC */
+/** Allocate a new or_circuit_t, connected to <b>p_conn</b> as
+ * <b>p_circ_id</b>. If <b>p_conn</b> is NULL, the circuit is unattached. */
or_circuit_t *
or_circuit_new(uint16_t p_circ_id, or_connection_t *p_conn)
{