[tor-commits] [tor/master] Add comments for new functions

[nickm at torproject.org]

commit ddb1889eb8bc128ec0fca35f15b1bf90d2b629ac
Author: Nick Mathewson <nickm at torproject.org>
Date:   Sat Mar 14 14:27:33 2015 -0400

    Add comments for new functions
---
 src/or/main.c |    9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/or/main.c b/src/or/main.c
index 888dabe..dd21b1a 100644
--- a/src/or/main.c
+++ b/src/or/main.c
@@ -2087,6 +2087,10 @@ do_main_loop(void)
   return run_main_loop_until_done();
 }
 
+/**
+ * Run the main loop a single time. Return 0 for "exit"; -1 for "exit with
+ * error", and 1 for "run this again."
+ */
 static int
 run_main_loop_once(void)
 {
@@ -2139,6 +2143,11 @@ run_main_loop_once(void)
   return 1;
 }
 
+/** Run the run_main_loop_once() function until it declares itself done,
+ * and return its final return value.
+ *
+ * Shadow won't invoke this function, so don't fill it up with things.
+ */
 static int
 run_main_loop_until_done(void)
 {