[gnunet] 32/90: -DOC: Another comment stripping pass through TESTBED

[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 0d89c3b61d882e1b4f5f5b07f9721a53ce0aa8c2
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Sun Sep 4 02:47:50 2022 +0100

    -DOC: Another comment stripping pass through TESTBED
---
 src/testbed/gnunet-service-testbed.c       |  5 -----
 src/testbed/gnunet-service-testbed.h       |  9 ++++-----
 src/testbed/gnunet-service-testbed_peers.c | 18 ------------------
 src/testbed/testbed_api.c                  | 23 -----------------------
 src/testbed/testbed_api_hosts.c            |  7 -------
 src/testbed/testbed_api_operations.c       |  8 --------
 src/testbed/testbed_api_operations.h       |  4 ++--
 src/testbed/testbed_api_testbed.c          |  5 -----
 src/testbed/testbed_api_topology.c         | 21 ---------------------
 src/testbed/testbed_api_topology.h         |  6 ++++--
 10 files changed, 10 insertions(+), 96 deletions(-)

diff --git a/src/testbed/gnunet-service-testbed.c 
b/src/testbed/gnunet-service-testbed.c
index 3ef99ae25..91aa5dd88 100644
--- a/src/testbed/gnunet-service-testbed.c
+++ b/src/testbed/gnunet-service-testbed.c
@@ -295,11 +295,6 @@ GST_forwarded_operation_reply_relay (void *cls,
 }
 
 
-/**
- * Task to free resources when forwarded operation has been timed out
- *
- * @param cls the ForwardedOperationContext
- */
 void
 GST_forwarded_operation_timeout (void *cls)
 {
diff --git a/src/testbed/gnunet-service-testbed.h 
b/src/testbed/gnunet-service-testbed.h
index 1c6aadb59..920e22f05 100644
--- a/src/testbed/gnunet-service-testbed.h
+++ b/src/testbed/gnunet-service-testbed.h
@@ -570,10 +570,9 @@ GST_forwarded_operation_reply_relay (void *cls,
 
 
 /**
- * Task to free resources when forwarded operation has been timedout
+ * Task to free resources when forwarded operation has been timed out.
  *
  * @param cls the ForwardedOperationContext
- * @param tc the task context from scheduler
  */
 void
 GST_forwarded_operation_timeout (void *cls);
@@ -669,7 +668,7 @@ check_peer_create (void *cls,
  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER messages
  *
  * @param cls identification of the client
- * @param message the actual message
+ * @param msg the actual message
  */
 void
 handle_peer_create (void *cls,
@@ -688,7 +687,7 @@ handle_peer_destroy (void *cls,
 
 
 /**
- * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
+ * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_START_PEER messages
  *
  * @param cls identification of the client
  * @param msg the actual message
@@ -746,7 +745,7 @@ check_manage_peer_service (void *cls,
 
 
 /**
- * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_MANAGE_PEER_SERVICE message
+ * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_MANAGE_PEER_SERVICE messages
  *
  * @param cls identification of client
  * @param msg the actual message
diff --git a/src/testbed/gnunet-service-testbed_peers.c 
b/src/testbed/gnunet-service-testbed_peers.c
index 0bfeb4583..154a6d4ec 100644
--- a/src/testbed/gnunet-service-testbed_peers.c
+++ b/src/testbed/gnunet-service-testbed_peers.c
@@ -428,12 +428,6 @@ check_peer_create (void *cls,
 }
 
 
-/**
- * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER messages
- *
- * @param cls identification of the client
- * @param msg the actual message
- */
 void
 handle_peer_create (void *cls,
                     const struct GNUNET_TESTBED_PeerCreateMessage *msg)
@@ -644,12 +638,6 @@ start_peer (struct Peer *peer)
 }
 
 
-/**
- * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_START_PEER messages
- *
- * @param cls identification of the client
- * @param msg the actual message
- */
 void
 handle_peer_start (void *cls,
                    const struct GNUNET_TESTBED_PeerStartMessage *msg)
@@ -1301,12 +1289,6 @@ check_manage_peer_service (void *cls,
 }
 
 
-/**
- * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_MANAGE_PEER_SERVICE messages
- *
- * @param cls identification of client
- * @param msg the actual message
- */
 void
 handle_manage_peer_service (void *cls,
                             const struct
diff --git a/src/testbed/testbed_api.c b/src/testbed/testbed_api.c
index b95586975..46b8ab901 100644
--- a/src/testbed/testbed_api.c
+++ b/src/testbed/testbed_api.c
@@ -2146,13 +2146,6 @@ GNUNET_TESTBED_extract_config_ (const struct 
GNUNET_MessageHeader *msg)
 }
 
 
-/**
- * Checks the integrity of the OperationFailureEventMessage and if good returns
- * the error message it contains.
- *
- * @param msg the OperationFailureEventMessage
- * @return the error message
- */
 const char *
 GNUNET_TESTBED_parse_error_string_ (
   const struct GNUNET_TESTBED_OperationFailureEventMessage *msg)
@@ -2327,22 +2320,6 @@ GNUNET_TESTBED_barrier_remove_ (struct 
GNUNET_TESTBED_Barrier *barrier)
 }
 
 
-/**
- * Initialise a barrier and call the given callback when the required 
percentage
- * of peers (quorum) reach the barrier OR upon error.
- *
- * @param controller the handle to the controller
- * @param name identification name of the barrier
- * @param quorum the percentage of peers that is required to reach the barrier.
- *   Peers signal reaching a barrier by calling
- *   GNUNET_TESTBED_barrier_reached().
- * @param cb the callback to call when the barrier is reached or upon error.
- *   Cannot be NULL.
- * @param cls closure for the above callback
- * @param echo GNUNET_YES to echo the barrier crossed status message back to 
the
- *   controller
- * @return barrier handle; NULL upon error
- */
 struct GNUNET_TESTBED_Barrier *
 GNUNET_TESTBED_barrier_init_ (struct GNUNET_TESTBED_Controller *controller,
                               const char *name,
diff --git a/src/testbed/testbed_api_hosts.c b/src/testbed/testbed_api_hosts.c
index 4cbfd8d29..e0c48f709 100644
--- a/src/testbed/testbed_api_hosts.c
+++ b/src/testbed/testbed_api_hosts.c
@@ -215,13 +215,6 @@ GNUNET_TESTBED_host_create_by_id_ (
 }
 
 
-/**
- * Obtain the host's unique global ID.
- *
- * @param host handle to the host, NULL means 'localhost'
- * @return id global host ID assigned to the host (0 is
- *         'localhost', but then obviously not globally unique)
- */
 uint32_t
 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host)
 {
diff --git a/src/testbed/testbed_api_operations.c 
b/src/testbed/testbed_api_operations.c
index a23f8c666..ea7e71496 100644
--- a/src/testbed/testbed_api_operations.c
+++ b/src/testbed/testbed_api_operations.c
@@ -1039,14 +1039,6 @@ GNUNET_TESTBED_operation_create_ (void *cls, 
OperationStart start,
 }
 
 
-/**
- * Create an operation queue.
- *
- * @param type the type of operation queue
- * @param max_active maximum number of operations in this
- *        queue that can be active in parallel at the same time
- * @return handle to the queue
- */
 struct OperationQueue *
 GNUNET_TESTBED_operation_queue_create_ (enum OperationQueueType type,
                                         unsigned int max_active)
diff --git a/src/testbed/testbed_api_operations.h 
b/src/testbed/testbed_api_operations.h
index d9de5c011..2dba9c14d 100644
--- a/src/testbed/testbed_api_operations.h
+++ b/src/testbed/testbed_api_operations.h
@@ -60,8 +60,8 @@ enum OperationQueueType
  * Create an operation queue.
  *
  * @param type the type of operation queue
- * @param max_active maximum number of operations in this queue that can be
- *   active in parallel at the same time.
+ * @param max_active maximum number of operations in this
+ *        queue that can be active in parallel at the same time.
  * @return handle to the queue
  */
 struct OperationQueue *
diff --git a/src/testbed/testbed_api_testbed.c 
b/src/testbed/testbed_api_testbed.c
index e0b76ad78..8e75daae3 100644
--- a/src/testbed/testbed_api_testbed.c
+++ b/src/testbed/testbed_api_testbed.c
@@ -1005,11 +1005,6 @@ host_registration_completion (void *cls, const char 
*emsg)
 }
 
 
-/**
- * Task to register all hosts available in the global host list
- *
- * @param cls RunContext
- */
 static void
 register_hosts (void *cls)
 {
diff --git a/src/testbed/testbed_api_topology.c 
b/src/testbed/testbed_api_topology.c
index 46f7efc76..f73be378e 100644
--- a/src/testbed/testbed_api_topology.c
+++ b/src/testbed/testbed_api_topology.c
@@ -637,18 +637,6 @@ gen_topo_ring (struct TopologyContext *tc)
 }
 
 
-/**
- * Returns the number of links that are required to generate a 2d torus for the
- * given number of peers. Also returns the arrangement (number of rows and the
- * length of each row)
- *
- * @param num_peers number of peers
- * @param rows number of rows in the 2d torus. Can be NULL
- * @param rows_len the length of each row. This array will be allocated
- *          fresh. The caller should free it. Can be NULL
- * @return the number of links that are required to generate a 2d torus for the
- *           given number of peers
- */
 unsigned int
 GNUNET_TESTBED_2dtorus_calc_links (unsigned int num_peers, unsigned int *rows,
                                    unsigned int **rows_len)
@@ -1454,15 +1442,6 @@ GNUNET_TESTBED_overlay_configure_topology (void *op_cls,
 }
 
 
-/**
- * Get a topology from a string input.
- *
- * @param topology where to write the retrieved topology
- * @param topology_string The string to attempt to
- *        get a configuration value from
- * @return #GNUNET_YES if topology string matched a
- *         known topology, #GNUNET_NO if not
- */
 int
 GNUNET_TESTBED_topology_get_ (enum GNUNET_TESTBED_TopologyOption *topology,
                               const char *topology_string)
diff --git a/src/testbed/testbed_api_topology.h 
b/src/testbed/testbed_api_topology.h
index 564fa421f..ffa32dfa5 100644
--- a/src/testbed/testbed_api_topology.h
+++ b/src/testbed/testbed_api_topology.h
@@ -36,6 +36,8 @@
  * @param rows number of rows in the 2d torus. Can be NULL.
  * @param rows_len the length of each row. This array will be allocated
  *          fresh. The caller should free it. Can be NULL.
+ * @return the number of links that are required to generate a 2d torus for the
+ *           given number of peers
  */
 unsigned int
 GNUNET_TESTBED_2dtorus_calc_links (unsigned int num_peers, unsigned int *rows,
@@ -48,8 +50,8 @@ GNUNET_TESTBED_2dtorus_calc_links (unsigned int num_peers, 
unsigned int *rows,
  * @param topology where to write the retrieved topology
  * @param topology_string The string to attempt to
  *        get a configuration value from
- * @return GNUNET_YES if topology string matched a
- *         known topology, GNUNET_NO if not
+ * @return #GNUNET_YES if topology string matched a
+ *         known topology, #GNUNET_NO if not
  */
 int
 GNUNET_TESTBED_topology_get_ (enum GNUNET_TESTBED_TopologyOption *topology,

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