Commenting the "keyup" CMD.

This commit is contained in:
Marcello Stanisci 2018-05-26 10:36:54 +02:00
parent 69f05ae663
commit effa3db3cd
No known key found for this signature in database
GPG Key ID: 8D526861953F4C0F

View File

@ -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.
*/