[tor-commits] [tor/master] adding documentation to extracted unit test helper

[nickm at torproject.org]

commit c86bbdd3aea050537dfe659013c1db2aa481bf06
Author: Chelsea H. Komlo <chelsea.komlo at gmail.com>
Date:   Mon Nov 21 13:30:25 2016 -0500

    adding documentation to extracted unit test helper
---
 src/test/test_helpers.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/test/test_helpers.c b/src/test/test_helpers.c
index fbc09fa..132af39 100644
--- a/src/test/test_helpers.c
+++ b/src/test/test_helpers.c
@@ -108,6 +108,8 @@ connection_write_to_buf_mock(const char *string, size_t len,
   write_to_buf(string, len, conn->outbuf);
 }
 
+/* Set up a fake origin circuit with the specified number of cells,
+ * Return a pointer to the newly-created dummy circuit */
 circuit_t *
 dummy_origin_circuit_new(int n_cells)
 {