Commenting the "fresh coins" trait.

This commit is contained in:
Marcello Stanisci 2018-05-28 15:51:23 +02:00
parent 027da0f1a3
commit d97260408c
No known key found for this signature in database
GPG Key ID: 8D526861953F4C0F
2 changed files with 17 additions and 12 deletions

View File

@ -32,13 +32,14 @@
#define TALER_TESTING_TRAIT_FRESH_COINS "fresh-coins" #define TALER_TESTING_TRAIT_FRESH_COINS "fresh-coins"
/** /**
* Obtain a "number" value from @a cmd. * Get a array of fresh coins.
* *
* @param cmd command to extract trait from * @param cmd command to extract the fresh coin from.
* @param selector which coin to pick if @a cmd has multiple on * @param index which array to pick if @a cmd has multiple
* offer * on offer.
* @param fresh_coins[out] will point to array of fresh coins * @param fresh_coins[out] will point to the offered array.
* @return #GNUNET_OK on success *
* @return #GNUNET_OK on success.
*/ */
int int
TALER_TESTING_get_trait_fresh_coins TALER_TESTING_get_trait_fresh_coins
@ -53,10 +54,14 @@ TALER_TESTING_get_trait_fresh_coins
} }
/** /**
* @param selector associate the object with this "tag" * Offer a _array_ of fresh coins.
*
* @param index which array of fresh coins to offer,
* if there are multiple on offer. Tipically passed as
* zero.
* @param fresh_coins the array of fresh coins to offer * @param fresh_coins the array of fresh coins to offer
* *
* @return the trait, to be put in the traits array of the command * @return the trait,
*/ */
struct TALER_TESTING_Trait struct TALER_TESTING_Trait
TALER_TESTING_make_trait_fresh_coins TALER_TESTING_make_trait_fresh_coins

View File

@ -49,12 +49,12 @@ TALER_TESTING_trait_end ()
/** /**
* Pick the chosen trait from the traits array. * Pick the chosen trait from the traits array.
* *
* @param traits the traits array * @param traits the traits array.
* @param ret where to store the result * @param ret where to store the result.
* @param selector which particular object in the trait should be * @param selector which particular object in the trait should be
* returned * returned.
* *
* @return GNUNET_OK if no error occurred, GNUNET_SYSERR otherwise * @return GNUNET_OK if no error occurred, GNUNET_SYSERR otherwise.
*/ */
int int
TALER_TESTING_get_trait (const struct TALER_TESTING_Trait *traits, TALER_TESTING_get_trait (const struct TALER_TESTING_Trait *traits,