summaryrefslogtreecommitdiff
path: root/src/include/gnunet_testbed_service.h
diff options
context:
space:
mode:
authorSree Harsha Totakura <totakura@in.tum.de>2016-10-27 15:02:36 +0000
committerSree Harsha Totakura <totakura@in.tum.de>2016-10-27 15:02:36 +0000
commit04d5943630fd2e30978bcd5b1fa0b1b80822b086 (patch)
tree7de1775d08eda12ebfb2a82782fbf88b56327e8b /src/include/gnunet_testbed_service.h
parentbdaa29c6a12d17fc823cee610e4636be8ce1068c (diff)
update documentation
Diffstat (limited to 'src/include/gnunet_testbed_service.h')
-rw-r--r--src/include/gnunet_testbed_service.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/include/gnunet_testbed_service.h b/src/include/gnunet_testbed_service.h
index f8a8ef38d..1c8d83ff9 100644
--- a/src/include/gnunet_testbed_service.h
+++ b/src/include/gnunet_testbed_service.h
@@ -1531,8 +1531,10 @@ enum GNUNET_TESTBED_BarrierStatus
* @param cls the closure given to GNUNET_TESTBED_barrier_init()
* @param name the name of the barrier
* @param barrier the barrier handle
- * @param status status of the barrier; #GNUNET_OK if the barrier is crossed;
- * #GNUNET_SYSERR upon error
+ * @param status status of the barrier. The barrier is removed once it has been
+ * crossed or an error occurs while processing it. Therefore it is
+ * invalid to call GNUNET_TESTBED_barrier_cancel() on a crossed or
+ * errored barrier.
* @param emsg if the status were to be #GNUNET_SYSERR, this parameter has the
* error messsage
*/