[gnunet] 15/90: -DOC: Comment stripping pass in TESTING libraries

[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 d21ed4b27f0709277823b5e3c8bfa4b66672f39a
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Fri Sep 2 20:10:29 2022 +0100

    -DOC: Comment stripping pass in TESTING libraries
---
 src/include/gnunet_testing_lib.h         |  6 ++--
 src/include/gnunet_testing_netjail_lib.h |  3 +-
 src/testing/testing.c                    | 62 +-------------------------------
 3 files changed, 5 insertions(+), 66 deletions(-)

diff --git a/src/include/gnunet_testing_lib.h b/src/include/gnunet_testing_lib.h
index 724382c66..2f64c306b 100644
--- a/src/include/gnunet_testing_lib.h
+++ b/src/include/gnunet_testing_lib.h
@@ -401,7 +401,7 @@ typedef void
  * Starts a peer using the given configuration and then invokes the
  * given callback.  This function ALSO initializes the scheduler loop
  * and should thus be called directly from "main".  The testcase
- * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
+ * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
  *
  * @param testdir only the directory name without any path. This is used for
  *          all service homes; the directory will be created in a temporary
@@ -409,7 +409,7 @@ typedef void
  * @param cfgfilename name of the configuration file to use;
  *         use NULL to only run with defaults
  * @param tm main function of the testcase
- * @param tm_cls closure for 'tm'
+ * @param tm_cls closure for @a tm
  * @return 0 on success, 1 on error
  */
 int
@@ -425,7 +425,7 @@ GNUNET_TESTING_peer_run (const char *testdir,
  * Starts a service using the given configuration and then invokes the
  * given callback.  This function ALSO initializes the scheduler loop
  * and should thus be called directly from "main".  The testcase
- * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
+ * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
  *
  * This function is useful if the testcase is for a single service
  * and if that service doesn't itself depend on other services.
diff --git a/src/include/gnunet_testing_netjail_lib.h 
b/src/include/gnunet_testing_netjail_lib.h
index b65ae6537..2fe72e9b5 100644
--- a/src/include/gnunet_testing_netjail_lib.h
+++ b/src/include/gnunet_testing_netjail_lib.h
@@ -417,13 +417,12 @@ GNUNET_TESTING_cmd_stop_testing_system (
   const char *helper_start_label,
   struct GNUNET_TESTING_NetjailTopology *topology);
 
-
 /**
  * Create a GNUNET_CMDS_LOCAL_FINISHED message.
  *
  * @param rv The result of the local test as GNUNET_GenericReturnValue.
  * @return The GNUNET_CMDS_LOCAL_FINISHED message.
-*/
+ */
 struct GNUNET_MessageHeader *
 GNUNET_TESTING_send_local_test_finished_msg (enum GNUNET_GenericReturnValue 
rv);
 
diff --git a/src/testing/testing.c b/src/testing/testing.c
index a00d7217f..de5234979 100644
--- a/src/testing/testing.c
+++ b/src/testing/testing.c
@@ -1503,17 +1503,6 @@ disconn_status (void *cls, int connected)
 }
 
 
-/**
- * Stop a peer asynchronously using ARM API.  Peer's shutdown is signaled
- * through the GNUNET_TESTING_PeerStopCallback().
- *
- * @param peer the peer to stop
- * @param cb the callback to signal peer shutdown
- * @param cb_cls closure for the above callback
- * @return #GNUNET_OK upon successfully giving the request to the ARM API (this
- *           does not mean that the peer is successfully stopped); 
#GNUNET_SYSERR
- *           upon any error.
- */
 int
 GNUNET_TESTING_peer_stop_async (struct GNUNET_TESTING_Peer *peer,
                                 GNUNET_TESTING_PeerStopCallback cb,
@@ -1581,22 +1570,6 @@ GNUNET_TESTING_peer_destroy (struct GNUNET_TESTING_Peer 
*peer)
 }
 
 
-/**
- * Start a single peer and run a test using the testing library.
- * Starts a peer using the given configuration and then invokes the
- * given callback.  This function ALSO initializes the scheduler loop
- * and should thus be called directly from "main".  The testcase
- * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
- *
- * @param testdir only the directory name without any path. This is used for
- *          all service homes; the directory will be created in a temporary
- *          location depending on the underlying OS
- * @param cfgfilename name of the configuration file to use;
- *         use NULL to only run with defaults
- * @param tm main function of the testcase
- * @param tm_cls closure for @a tm
- * @return 0 on success, 1 on error
- */
 int
 GNUNET_TESTING_peer_run (const char *testdir,
                          const char *cfgfilename,
@@ -1648,27 +1621,6 @@ service_run_main (void *cls)
 }
 
 
-/**
- * Start a single service (no ARM, except of course if the given
- * service name is 'arm') and run a test using the testing library.
- * Starts a service using the given configuration and then invokes the
- * given callback.  This function ALSO initializes the scheduler loop
- * and should thus be called directly from "main".  The testcase
- * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
- *
- * This function is useful if the testcase is for a single service
- * and if that service doesn't itself depend on other services.
- *
- * @param testdir only the directory name without any path. This is used for
- *          all service homes; the directory will be created in a temporary
- *          location depending on the underlying OS
- * @param service_name name of the service to run
- * @param cfgfilename name of the configuration file to use;
- *         use NULL to only run with defaults
- * @param tm main function of the testcase
- * @param tm_cls closure for @a tm
- * @return 0 on success, 1 on error
- */
 int
 GNUNET_TESTING_service_run (const char *testdir,
                             const char *service_name,
@@ -2161,13 +2113,6 @@ GNUNET_TESTING_get_connections (unsigned int num, struct
 }
 
 
-/**
- * Retrieve the public key from the test system with the unique node id.
- *
- * @param num The unique node id.
- * @param tl_system The test system.
- * @return The peer identity wrapping the public key.
- */
 struct GNUNET_PeerIdentity *
 GNUNET_TESTING_get_pub_key (unsigned int num,
                             const struct GNUNET_TESTING_System *tl_system)
@@ -2343,12 +2288,7 @@ GNUNET_TESTING_get_address (struct 
GNUNET_TESTING_NodeConnection *connection,
 }
 
 
-/**
- * Create a GNUNET_CMDS_LOCAL_FINISHED message.
- *
- * @param rv The result of the local test as GNUNET_GenericReturnValue.
- * @return The GNUNET_CMDS_LOCAL_FINISHED message.
-*/
+
 struct GNUNET_MessageHeader *
 GNUNET_TESTING_send_local_test_finished_msg (enum GNUNET_GenericReturnValue rv)
 {

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