-remove GNUNET_MQ_impl_send_commit, make it part of send_continue, to ensure calling...

[oweals/gnunet.git] / src / include / gnunet_testbed_service.h

diff --git a/src/include/gnunet_testbed_service.h b/src/include/gnunet_testbed_service.h
index fa07cc63e8bfabdbaed507b9c509641d7ac94da4..01c7d674b40391b359452ed3306b9798bbb6d523 100644 (file)
--- a/src/include/gnunet_testbed_service.h
+++ b/src/include/gnunet_testbed_service.h
@@ -114,7 +114,8 @@ GNUNET_TESTBED_host_create_with_id (uint32_t id,
 
 
 /**
- * Load a set of hosts from a configuration file.
+ * Load a set of hosts from a configuration file.  The hostfile format is
+ * specified at https://gnunet.org/content/hosts-file-format
  *
  * @param filename file with the host specification
  * @param cfg the configuration to use as a template while starting a controller
@@ -804,13 +805,11 @@ GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
 
 
 /**
- * Change peer configuration.  Must only be called while the
- * peer is stopped.  Ports and paths cannot be changed this
+ * Change @a peer configuration.  Ports and paths cannot be changed this
  * way.
  *
  * @param peer peer to change configuration for
- * @param cfg new configuration (differences to existing
- *            configuration only)
+ * @param cfg new configuration
  * @return handle to the operation
  */
 struct GNUNET_TESTBED_Operation *
@@ -1108,7 +1107,7 @@ GNUNET_TESTBED_overlay_connect (void *op_cls,
  * @param nsuccess the number of successful overlay connects
  * @param nfailures the number of overlay connects which failed
  */
-typedef void (*GNUNET_TESTBED_TopologyCompletionCallback) (void *cls, 
+typedef void (*GNUNET_TESTBED_TopologyCompletionCallback) (void *cls,
                                                           unsigned int nsuccess,
                                                           unsigned int nfailures);
 
@@ -1277,7 +1276,7 @@ GNUNET_TESTBED_service_connect (void *op_cls,
  * cancels the operation, frees its resources and ensures the no event is
  * generated with respect to this operation. Note that however cancelling an
  * operation does NOT guarantee that the operation will be fully undone (or that
- * nothing ever happened). 
+ * nothing ever happened).
  *
  * This function MUST be called for every operation to fully remove the
  * operation from the operation queue.  After calling this function, if
@@ -1439,11 +1438,11 @@ GNUNET_TESTBED_run (const char *host_filename,
  *        for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
  *        set in the event_mask as this is the only way get access to the
  *        handle of each peer
- * @param cc_cls closure for cc
+ * @param cc_cls closure for @a cc
  * @param test_master this callback will be called once the test is ready or
  *          upon timeout
- * @param test_master_cls closure for 'test_master'.
- * @return GNUNET_SYSERR on error, GNUNET_OK on success
+ * @param test_master_cls closure for @a test_master.
+ * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
  */
 int
 GNUNET_TESTBED_test_run (const char *testname,
@@ -1491,7 +1490,7 @@ enum GNUNET_TESTBED_BarrierStatus
    * Error status
    */
   GNUNET_TESTBED_BARRIERSTATUS_ERROR,
-  
+
 };
 
 
@@ -1518,7 +1517,7 @@ typedef void (*GNUNET_TESTBED_barrier_status_cb) (void *cls,
 
 /**
  * Initialise a barrier and call the given callback when the required percentage
- * of peers (quorum) reach the barrier.  
+ * of peers (quorum) reach the barrier.
  *
  * @param controller the handle to the controller
  * @param name identification name of the barrier