From d97260408c3938110dbfdc3703981f488b4e5125 Mon Sep 17 00:00:00 2001 From: Marcello Stanisci Date: Mon, 28 May 2018 15:51:23 +0200 Subject: [PATCH] Commenting the "fresh coins" trait. --- .../testing_api_trait_fresh_coin.c | 21 ++++++++++++------- src/exchange-lib/testing_api_traits.c | 8 +++---- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/src/exchange-lib/testing_api_trait_fresh_coin.c b/src/exchange-lib/testing_api_trait_fresh_coin.c index 985591ba3..8779593ab 100644 --- a/src/exchange-lib/testing_api_trait_fresh_coin.c +++ b/src/exchange-lib/testing_api_trait_fresh_coin.c @@ -32,13 +32,14 @@ #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 selector which coin to pick if @a cmd has multiple on - * offer - * @param fresh_coins[out] will point to array of fresh coins - * @return #GNUNET_OK on success + * @param cmd command to extract the fresh coin from. + * @param index which array to pick if @a cmd has multiple + * on offer. + * @param fresh_coins[out] will point to the offered array. + * + * @return #GNUNET_OK on success. */ int 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 * - * @return the trait, to be put in the traits array of the command + * @return the trait, */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_fresh_coins diff --git a/src/exchange-lib/testing_api_traits.c b/src/exchange-lib/testing_api_traits.c index 051bd202c..3e6aedda7 100644 --- a/src/exchange-lib/testing_api_traits.c +++ b/src/exchange-lib/testing_api_traits.c @@ -49,12 +49,12 @@ TALER_TESTING_trait_end () /** * Pick the chosen trait from the traits array. * - * @param traits the traits array - * @param ret where to store the result + * @param traits the traits array. + * @param ret where to store the result. * @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 TALER_TESTING_get_trait (const struct TALER_TESTING_Trait *traits,