[gnunet] 11/90: -DOC: Comment stripping pass in TESTBED subsystem

[gnunet]

This is an automated email from the git hooks/post-receive script.

martin-schanzenbach pushed a commit to branch master
in repository gnunet.

commit 71d3949f6e9889887168784b5f341baa32f791fe
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Fri Sep 2 20:04:17 2022 +0100

    -DOC: Comment stripping pass in TESTBED subsystem
---
 src/include/gnunet_testbed_service.h |  8 +++---
 src/testbed/testbed_api.c            | 24 ----------------
 src/testbed/testbed_api_barriers.c   | 11 --------
 src/testbed/testbed_api_hosts.c      | 11 --------
 src/testbed/testbed_api_peers.c      | 55 ------------------------------------
 src/testbed/testbed_api_topology.c   | 42 ---------------------------
 6 files changed, 4 insertions(+), 147 deletions(-)

diff --git a/src/include/gnunet_testbed_service.h 
b/src/include/gnunet_testbed_service.h
index 29515b7af..ef67ab8ca 100644
--- a/src/include/gnunet_testbed_service.h
+++ b/src/include/gnunet_testbed_service.h
@@ -1030,8 +1030,8 @@ enum GNUNET_TESTBED_TopologyOption
  * Configure overall network topology to have a particular shape.
  *
  * @param op_cls closure argument to give with the operation event
- * @param num_peers number of peers in 'peers'
- * @param peers array of 'num_peers' with the peers to configure
+ * @param num_peers number of peers in @a peers
+ * @param peers array of @a num_peers with the peers to configure
  * @param topo desired underlay topology to use
  * @param ap topology-specific options
  * @return handle to the operation, NULL if configuring the topology
@@ -1052,8 +1052,8 @@ GNUNET_TESTBED_underlay_configure_topology_va (void 
*op_cls,
  * Configure overall network topology to have a particular shape.
  *
  * @param op_cls closure argument to give with the operation event
- * @param num_peers number of peers in 'peers'
- * @param peers array of 'num_peers' with the peers to configure
+ * @param num_peers number of peers in @a peers
+ * @param peers array of @a num_peers with the peers to configure
  * @param topo desired underlay topology to use
  * @param ... topology-specific options
  * @return handle to the operation, NULL if configuring the topology
diff --git a/src/testbed/testbed_api.c b/src/testbed/testbed_api.c
index 18bb0c3f6..b95586975 100644
--- a/src/testbed/testbed_api.c
+++ b/src/testbed/testbed_api.c
@@ -1917,21 +1917,6 @@ GNUNET_TESTBED_get_slave_config_ (void *op_cls,
 }
 
 
-/**
- * Function to acquire the configuration of a running slave controller. The
- * completion of the operation is signalled through the controller_cb from
- * GNUNET_TESTBED_controller_connect(). If the operation is successful the
- * handle to the configuration is available in the generic pointer of
- * operation_finished field of struct GNUNET_TESTBED_EventInformation.
- *
- * @param op_cls the closure for the operation
- * @param master the handle to master controller
- * @param slave_host the host where the slave controller is running; the handle
- *          to the slave_host should remain valid until this operation is
- *          cancelled or marked as finished
- * @return the operation handle; NULL if the slave_host is not registered at
- *           master
- */
 struct GNUNET_TESTBED_Operation *
 GNUNET_TESTBED_get_slave_config (void *op_cls,
                                  struct GNUNET_TESTBED_Controller *master,
@@ -1946,15 +1931,6 @@ GNUNET_TESTBED_get_slave_config (void *op_cls,
 }
 
 
-/**
- * Ask the testbed controller to write the current overlay topology to
- * a file.  Naturally, the file will only contain a snapshot as the
- * topology may evolve all the time.
- *
- * @param controller overlay controller to inspect
- * @param filename name of the file the topology should
- *        be written to.
- */
 void
 GNUNET_TESTBED_overlay_write_topology_to_file (
   struct GNUNET_TESTBED_Controller *controller,
diff --git a/src/testbed/testbed_api_barriers.c 
b/src/testbed/testbed_api_barriers.c
index 61578c1e6..6074beb12 100644
--- a/src/testbed/testbed_api_barriers.c
+++ b/src/testbed/testbed_api_barriers.c
@@ -160,17 +160,6 @@ mq_error_handler (void *cls,
 }
 
 
-/**
- * Wait for a barrier to be crossed.  This function should be called by the
- * peers which have been started by the testbed.  If the peer is not started by
- * testbed this function may return error
- *
- * @param name the name of the barrier
- * @param cb the barrier wait callback
- * @param cb_cls the closure for @a cb
- * @return barrier wait handle which can be used to cancel the waiting at
- *   anytime before the callback is called.  NULL upon error.
- */
 struct GNUNET_TESTBED_BarrierWaitHandle *
 GNUNET_TESTBED_barrier_wait (const char *name,
                              GNUNET_TESTBED_barrier_wait_cb cb,
diff --git a/src/testbed/testbed_api_hosts.c b/src/testbed/testbed_api_hosts.c
index 8dd0a4893..4cbfd8d29 100644
--- a/src/testbed/testbed_api_hosts.c
+++ b/src/testbed/testbed_api_hosts.c
@@ -393,17 +393,6 @@ GNUNET_TESTBED_host_create (const char *hostname,
 }
 
 
-/**
- * Load a set of hosts from a configuration file.
- *
- * @param filename file with the host specification
- * @param cfg the configuration to use as a template while starting a 
controller
- *          on any of the loaded hosts.  Operation queue sizes specific to a 
host
- *          are also read from this configuration handle
- * @param hosts set to the hosts found in the file; caller must free this if
- *          number of hosts returned is greater than 0
- * @return number of hosts returned in 'hosts', 0 on error
- */
 unsigned int
 GNUNET_TESTBED_hosts_load_from_file (
   const char *filename,
diff --git a/src/testbed/testbed_api_peers.c b/src/testbed/testbed_api_peers.c
index 99d30e85b..b8e428441 100644
--- a/src/testbed/testbed_api_peers.c
+++ b/src/testbed/testbed_api_peers.c
@@ -661,18 +661,6 @@ GNUNET_TESTBED_peer_start (void *op_cls, struct 
GNUNET_TESTBED_Peer *peer,
 }
 
 
-/**
- * Stop the given peer.  The handle remains valid (use
- * "GNUNET_TESTBED_peer_destroy" to fully clean up the
- * state of the peer).
- *
- * @param op_cls the closure for this operation; will be set in the event
- *          information
- * @param peer peer to stop
- * @param pcc function to call upon completion
- * @param pcc_cls closure for 'pcc'
- * @return handle to the operation
- */
 struct GNUNET_TESTBED_Operation *
 GNUNET_TESTBED_peer_stop (void *op_cls,
                           struct GNUNET_TESTBED_Peer *peer,
@@ -701,20 +689,6 @@ GNUNET_TESTBED_peer_stop (void *op_cls,
 }
 
 
-/**
- * Request information about a peer. The controller callback will not be called
- * with event type GNUNET_TESTBED_ET_OPERATION_FINISHED when result for this
- * operation is available. Instead, the GNUNET_TESTBED_PeerInfoCallback() will
- * be called.
- * The peer information in the callback is valid until the operation is 
canceled.
- *
- * @param peer peer to request information about
- * @param pit desired information
- * @param cb the convenience callback to be called when results for this
- *          operation are available
- * @param cb_cls the closure for the above callback
- * @return handle to the operation
- */
 struct GNUNET_TESTBED_Operation *
 GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
                                      enum GNUNET_TESTBED_PeerInformationType
@@ -847,20 +821,6 @@ GNUNET_TESTBED_underlay_configure_link (void *op_cls,
 }
 
 
-/**
- * Both peers must have been started before calling this function.
- * This function then obtains a HELLO from 'p1', gives it to 'p2'
- * and asks 'p2' to connect to 'p1'.
- *
- * @param op_cls closure argument to give with the operation event
- * @param cb the callback to call when this operation has finished
- * @param cb_cls the closure for the above callback
- * @param p1 first peer
- * @param p2 second peer
- * @return handle to the operation, NULL if connecting these two
- *         peers is fundamentally not possible at this time (peers
- *         not running or underlay disallows)
- */
 struct GNUNET_TESTBED_Operation *
 GNUNET_TESTBED_overlay_connect (void *op_cls,
                                 GNUNET_TESTBED_OperationCompletionCallback cb,
@@ -957,21 +917,6 @@ oprelease_manage_service (void *cls)
 }
 
 
-/**
- * Start or stop given service at a peer.  This should not be called to
- * start/stop the peer's ARM service.  Use GNUNET_TESTBED_peer_start(),
- * GNUNET_TESTBED_peer_stop() for starting/stopping peer's ARM service.  
Success
- * or failure of the generated operation is signalled through the controller
- * event callback and/or operation completion callback.
- *
- * @param op_cls the closure for the operation
- * @param peer the peer whose service is to be started/stopped
- * @param service_name the name of the service
- * @param cb the operation completion callback
- * @param cb_cls the closure for the operation completion callback
- * @param start 1 to start the service; 0 to stop the service
- * @return an operation handle; NULL upon error (peer not running)
- */
 struct GNUNET_TESTBED_Operation *
 GNUNET_TESTBED_peer_manage_service (void *op_cls,
                                     struct GNUNET_TESTBED_Peer *peer,
diff --git a/src/testbed/testbed_api_topology.c 
b/src/testbed/testbed_api_topology.c
index e68e449ad..46f7efc76 100644
--- a/src/testbed/testbed_api_topology.c
+++ b/src/testbed/testbed_api_topology.c
@@ -1250,17 +1250,6 @@ gen_topo_clique (struct TopologyContext *tc)
 }
 
 
-/**
- * Configure overall network topology to have a particular shape.
- *
- * @param op_cls closure argument to give with the operation event
- * @param num_peers number of peers in @a peers
- * @param peers array of @a num_peers with the peers to configure
- * @param topo desired underlay topology to use
- * @param ap topology-specific options
- * @return handle to the operation, NULL if configuring the topology
- *         is not allowed at this time
- */
 struct GNUNET_TESTBED_Operation *
 GNUNET_TESTBED_underlay_configure_topology_va (void *op_cls,
                                                unsigned int num_peers,
@@ -1275,17 +1264,6 @@ GNUNET_TESTBED_underlay_configure_topology_va (void 
*op_cls,
 }
 
 
-/**
- * Configure overall network topology to have a particular shape.
- *
- * @param op_cls closure argument to give with the operation event
- * @param num_peers number of peers in @a peers
- * @param peers array of @a num_peers with the peers to configure
- * @param topo desired underlay topology to use
- * @param ... topology-specific options
- * @return handle to the operation, NULL if configuring the topology
- *         is not allowed at this time
- */
 struct GNUNET_TESTBED_Operation *
 GNUNET_TESTBED_underlay_configure_topology (void *op_cls,
                                             unsigned int num_peers,
@@ -1298,26 +1276,6 @@ GNUNET_TESTBED_underlay_configure_topology (void *op_cls,
 }
 
 
-/**
- * All peers must have been started before calling this function.
- * This function then connects the given peers in the P2P overlay
- * using the given topology.
- *
- * @param op_cls closure argument to give with the peer connect operation 
events
- *          generated through this function
- * @param num_peers number of peers in @a peers
- * @param peers array of @a num_peers with the peers to configure
- * @param max_connections the maximums number of overlay connections that will
- *          be made to achieve the given topology
- * @param comp_cb the completion callback to call when the topology generation
- *          is completed
- * @param comp_cb_cls closure for the above completion callback
- * @param topo desired underlay topology to use
- * @param va topology-specific options
- * @return handle to the operation, NULL if connecting these
- *         peers is fundamentally not possible at this time (peers
- *         not running or underlay disallows) or if num_peers is less than 2
- */
 struct GNUNET_TESTBED_Operation *
 GNUNET_TESTBED_overlay_configure_topology_va (void *op_cls,
                                               unsigned int num_peers,

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.