From: Sree Harsha Totakura <totakura@in.tum.de>
Date: Thu, 27 Oct 2016 15:02:36 +0000 (+0000)
Subject: update documentation
X-Git-Tag: initial-import-from-subversion-38251~21
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=04d5943630fd2e30978bcd5b1fa0b1b80822b086;p=oweals%2Fgnunet.git

update documentation
---

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
  */