[GNUnet-SVN] r38231 - gnunet/src/include

[gnunet]

Author: harsha
Date: 2016-10-27 17:02:36 +0200 (Thu, 27 Oct 2016)
New Revision: 38231

Modified:
   gnunet/src/include/gnunet_testbed_service.h
Log:
update documentation

Modified: gnunet/src/include/gnunet_testbed_service.h
===================================================================
--- gnunet/src/include/gnunet_testbed_service.h 2016-10-27 15:02:18 UTC (rev 
38230)
+++ gnunet/src/include/gnunet_testbed_service.h 2016-10-27 15:02:36 UTC (rev 
38231)
@@ -1531,8 +1531,10 @@
  * @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
  */