From 7a1146f147da5446b4b8488cc60d4368aadfe66a Mon Sep 17 00:00:00 2001 From: Marcello Stanisci Date: Mon, 28 May 2018 17:23:05 +0200 Subject: Commenting the remaining "lib" traits. --- src/exchange-lib/testing_api_trait_number.c | 38 +++++++++++++++-------------- 1 file changed, 20 insertions(+), 18 deletions(-) (limited to 'src/exchange-lib/testing_api_trait_number.c') diff --git a/src/exchange-lib/testing_api_trait_number.c b/src/exchange-lib/testing_api_trait_number.c index 4db88792..67b01ae8 100644 --- a/src/exchange-lib/testing_api_trait_number.c +++ b/src/exchange-lib/testing_api_trait_number.c @@ -33,13 +33,13 @@ #define TALER_TESTING_TRAIT_UINT64 "uint-64" /** - * Obtain a "number" value from @a cmd. + * Obtain a number from @a cmd. * - * @param cmd command to extract trait from - * @param selector which coin to pick if @a cmd has multiple on - * offer + * @param cmd command to extract the number from. + * @param index the number's index number. * @param n[out] set to the number coming from @a cmd. - * @return #GNUNET_OK on success + * + * @return #GNUNET_OK on success. */ int TALER_TESTING_get_trait_uint @@ -53,11 +53,15 @@ TALER_TESTING_get_trait_uint index); } + + /** - * @param selector associate the object with this "tag" - * @param n which object should be returned + * Offer a number. + * + * @param index the number's index number. + * @param n the number to offer. * - * @return the trait, to be put in the traits array of the command + * @return #GNUNET_OK on success. */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_uint @@ -73,13 +77,13 @@ TALER_TESTING_make_trait_uint } /** - * Obtain a "number" value from @a cmd. + * Obtain a "number" value from @a cmd, 64-bit version. * - * @param cmd command to extract trait from - * @param selector which coin to pick if @a cmd has multiple on - * offer + * @param cmd command to extract the number from. + * @param index the number's index number. * @param n[out] set to the number coming from @a cmd. - * @return #GNUNET_OK on success + * + * @return #GNUNET_OK on success. */ int TALER_TESTING_get_trait_uint64 @@ -94,10 +98,10 @@ TALER_TESTING_get_trait_uint64 } /** - * @param selector associate the object with this "tag" - * @param n which object should be returned + * Offer number trait, 64-bit version. * - * @return the trait, to be put in the traits array of the command + * @param index the number's index number. + * @param n number to offer. */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_uint64 @@ -112,6 +116,4 @@ TALER_TESTING_make_trait_uint64 return ret; } - - /* end of testing_api_trait_number.c */ -- cgit v1.2.3