From effa3db3cdb276b798026342a6cf6caf44ffedfb Mon Sep 17 00:00:00 2001
From: Marcello Stanisci <stanisci.m@gmail.com>
Date: Sat, 26 May 2018 10:36:54 +0200
Subject: Commenting the "keyup" CMD.

---
 src/exchange-lib/testing_api_cmd_exec_keyup.c | 44 +++++++++++++--------------
 1 file changed, 22 insertions(+), 22 deletions(-)

(limited to 'src/exchange-lib/testing_api_cmd_exec_keyup.c')

diff --git a/src/exchange-lib/testing_api_cmd_exec_keyup.c b/src/exchange-lib/testing_api_cmd_exec_keyup.c
index 9398dd4fe..6b2c81ea9 100644
--- a/src/exchange-lib/testing_api_cmd_exec_keyup.c
+++ b/src/exchange-lib/testing_api_cmd_exec_keyup.c
@@ -31,6 +31,9 @@
 #include "taler_testing_lib.h"
 
 
+/**
+ * State for a "keyup" CMD.
+ */
 struct KeyupState
 {
 
@@ -40,22 +43,18 @@ struct KeyupState
   struct GNUNET_OS_Process *keyup_proc;
 
   /**
-   * Which configuration file should we pass to the process?
+   * Configuration file used by the command.
    */
   const char *config_filename;
-
 };
 
 
 /**
- * Runs the command.  Note that upon return, the interpreter
- * will not automatically run the next command, as the command
- * may continue asynchronously in other scheduler tasks.  Thus,
- * the command must ensure to eventually call
- * #TALER_TESTING_interpreter_next() or
- * #TALER_TESTING_interpreter_fail().
+ * Run the command; calls the `taler-exchange-keyup' program.
  *
- * @param is interpreter state
+ * @param cls closure.
+ * @param cmd the commaind being run.
+ * @param is interpreter state.
  */
 static void
 keyup_run (void *cls,
@@ -85,10 +84,11 @@ keyup_run (void *cls,
 
 
 /**
- * Clean up after the command.  Run during forced termination
- * (CTRL-C) or test failure or test success.
+ * Free the state of a "keyup" CMD, and possibly kills its
+ * process if it did not terminate correctly.
  *
- * @param cls closure
+ * @param cls closure.
+ * @param cmd the command being freed.
  */
 static void
 keyup_cleanup (void *cls,
@@ -110,16 +110,16 @@ keyup_cleanup (void *cls,
 
 
 /**
- * Extract information from a command that is useful for other
- * commands.
+ * Offer "keyup" CMD internal data to other commands.
  *
- * @param cls closure
- * @param ret[out] result (could be anything)
- * @param trait name of the trait
+ * @param cls closure.
+ * @param ret[out] result (could be anything).
+ * @param trait name of the trait.
  * @param selector more detailed information about which object
  *                 to return in case there were multiple generated
- *                 by the command
- * @return #GNUNET_OK on success
+ *                 by the command.
+ *
+ * @return #GNUNET_OK on success.
  */
 static int
 keyup_traits (void *cls,
@@ -141,10 +141,10 @@ keyup_traits (void *cls,
 
 
 /**
- * Execute taler-exchange-keyup process.
+ * Make the "keyup" CMD.
  *
- * @param label command label
- * @param config_filename configuration filename
+ * @param label command label.
+ * @param config_filename configuration filename.
  *
  * @return the command.
  */
-- 
cgit v1.2.3