From: Nick Mathewson <nickm@torproject.org>
Date: Wed, 21 Aug 2013 16:17:20 +0000 (-0400)
Subject: Documentation for new cbt accessors
X-Git-Tag: tor-0.2.5.1-alpha~59^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=79cad08b4f9afd13a7151b8e15ae6481df82478f;p=thirdparty%2Ftor.git

Documentation for new cbt accessors
---

diff --git a/src/or/circuitstats.c b/src/or/circuitstats.c
index 0d60a1936f..e7b4b36bbd 100644
--- a/src/or/circuitstats.c
+++ b/src/or/circuitstats.c
@@ -36,24 +36,31 @@ static int unit_tests = 0;
 #define unit_tests 0
 #endif
 
+/** Return a pointer to the data structure describing our current circuit
+ * build time history and computations. */
 const circuit_build_times_t *
 get_circuit_build_times(void)
 {
   return &circ_times;
 }
 
+/** As get_circuit_build_times, but return a mutable pointer. */
 circuit_build_times_t *
 get_circuit_build_times_mutable(void)
 {
   return &circ_times;
 }
 
+/** Return the time to wait before actually closing an under-construction, in
+ * milliseconds. */
 double
 get_circuit_build_close_time_ms(void)
 {
   return circ_times.close_ms;
 }
 
+/** Return the time to wait before giving up on an under-construction circuit,
+ * in milliseconds. */
 double
 get_circuit_build_timeout_ms(void)
 {