From ccb88693447dba52bf2b2ae84fd4f329bbcd81f6 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Sat, 18 Jan 2020 13:35:51 +0100 Subject: [PATCH] doxygen --- src/lib/testing_api_helpers_exchange.c | 2 +- src/lib/testing_api_trait_amount.c | 16 ++++++---------- src/lib/testing_api_trait_blinding_key.c | 4 +--- src/lib/testing_api_trait_cmd.c | 9 ++++----- src/lib/testing_api_trait_coin_priv.c | 2 +- src/lib/testing_api_trait_contract.c | 4 ++-- src/lib/testing_api_trait_denom_pub.c | 17 ++++++++--------- src/lib/testing_api_trait_denom_sig.c | 2 +- src/lib/testing_api_trait_exchange_pub.c | 2 +- src/lib/testing_api_trait_exchange_sig.c | 2 +- src/lib/testing_api_trait_json.c | 4 ++-- 11 files changed, 28 insertions(+), 36 deletions(-) diff --git a/src/lib/testing_api_helpers_exchange.c b/src/lib/testing_api_helpers_exchange.c index fdabd4a44..1aeff16d8 100644 --- a/src/lib/testing_api_helpers_exchange.c +++ b/src/lib/testing_api_helpers_exchange.c @@ -492,7 +492,7 @@ fail: * launch the exchange process itself. * * @param config_filename configuration file to use - * @param ec[out] will be set to the exchange configuration data + * @param[out] ec will be set to the exchange configuration data * @return #GNUNET_OK on success, #GNUNET_NO if test should be * skipped, #GNUNET_SYSERR on test failure */ diff --git a/src/lib/testing_api_trait_amount.c b/src/lib/testing_api_trait_amount.c index 395e6b6c9..b33259e5d 100644 --- a/src/lib/testing_api_trait_amount.c +++ b/src/lib/testing_api_trait_amount.c @@ -37,15 +37,13 @@ * @param cmd command to extract the amount from. * @param index which amount to pick if @a cmd has multiple * on offer - * @param amount[out] set to the amount. - * + * @param[out] amount set to the amount. * @return #GNUNET_OK on success */ int -TALER_TESTING_get_trait_amount_obj - (const struct TALER_TESTING_Command *cmd, - unsigned int index, - const struct TALER_Amount **amount) +TALER_TESTING_get_trait_amount_obj (const struct TALER_TESTING_Command *cmd, + unsigned int index, + const struct TALER_Amount **amount) { return cmd->traits (cmd->cls, (const void **) amount, @@ -60,13 +58,11 @@ TALER_TESTING_get_trait_amount_obj * @param index which amount to offer, in case there are * multiple available. * @param amount the amount to offer. - * * @return the trait. */ struct TALER_TESTING_Trait -TALER_TESTING_make_trait_amount_obj - (unsigned int index, - const struct TALER_Amount *amount) +TALER_TESTING_make_trait_amount_obj (unsigned int index, + const struct TALER_Amount *amount) { struct TALER_TESTING_Trait ret = { .index = index, diff --git a/src/lib/testing_api_trait_blinding_key.c b/src/lib/testing_api_trait_blinding_key.c index cf343666e..f20116870 100644 --- a/src/lib/testing_api_trait_blinding_key.c +++ b/src/lib/testing_api_trait_blinding_key.c @@ -37,8 +37,7 @@ * * @param cmd command to extract trait from * @param index which coin to pick if @a cmd has multiple on offer. - * @param blinding_key[out] set to the offered blinding key. - * + * @param[out] blinding_key set to the offered blinding key. * @return #GNUNET_OK on success. */ int @@ -59,7 +58,6 @@ TALER_TESTING_get_trait_blinding_key * * @param index index number to associate to the offered key. * @param blinding_key blinding key to offer. - * * @return the trait. */ struct TALER_TESTING_Trait diff --git a/src/lib/testing_api_trait_cmd.c b/src/lib/testing_api_trait_cmd.c index d008bc1dc..0c7dc0c86 100644 --- a/src/lib/testing_api_trait_cmd.c +++ b/src/lib/testing_api_trait_cmd.c @@ -31,6 +31,7 @@ #define TALER_TESTING_TRAIT_CMD "cmd" + /** * Obtain a command from @a cmd. * @@ -39,8 +40,7 @@ * kind of traits do not need this index. For * example, a "batch" CMD returns always the * CMD currently being executed. - * @param cmd_[out] where to write the wire details. - * + * @param[out] cmd_ where to write the wire details. * @return #GNUNET_OK on success. */ int @@ -67,9 +67,8 @@ TALER_TESTING_get_trait_cmd * @return the trait. */ struct TALER_TESTING_Trait -TALER_TESTING_make_trait_cmd - (unsigned int index, - const struct TALER_TESTING_Command *cmd) +TALER_TESTING_make_trait_cmd (unsigned int index, + const struct TALER_TESTING_Command *cmd) { struct TALER_TESTING_Trait ret = { .index = index, diff --git a/src/lib/testing_api_trait_coin_priv.c b/src/lib/testing_api_trait_coin_priv.c index 1984f808d..a8b496e77 100644 --- a/src/lib/testing_api_trait_coin_priv.c +++ b/src/lib/testing_api_trait_coin_priv.c @@ -38,7 +38,7 @@ * * @param cmd command to extract trait from. * @param index index of the coin priv to obtain. - * @param coin_priv[out] set to the private key of the coin. + * @param[out] coin_priv set to the private key of the coin. * @return #GNUNET_OK on success. */ int diff --git a/src/lib/testing_api_trait_contract.c b/src/lib/testing_api_trait_contract.c index 7ef2c6b55..0fe741774 100644 --- a/src/lib/testing_api_trait_contract.c +++ b/src/lib/testing_api_trait_contract.c @@ -33,13 +33,13 @@ */ #define TALER_TESTING_TRAIT_CONTRACT_TERMS "contract-terms" + /** * Obtain contract terms from @a cmd. * * @param cmd command to extract the contract terms from. * @param index contract terms index number. - * @param contract_terms[out] where to write the contract - * terms. + * @param[out] contract_terms where to write the contract terms. * @return #GNUNET_OK on success. */ int diff --git a/src/lib/testing_api_trait_denom_pub.c b/src/lib/testing_api_trait_denom_pub.c index 6f6e2f837..7217495c6 100644 --- a/src/lib/testing_api_trait_denom_pub.c +++ b/src/lib/testing_api_trait_denom_pub.c @@ -37,15 +37,14 @@ * * @param cmd command to extract trait from * @param index index number of the denom to obtain. - * @param denom_pub[out] set to the offered denom pub. - * + * @param[out] denom_pub set to the offered denom pub. * @return #GNUNET_OK on success. */ int -TALER_TESTING_get_trait_denom_pub - (const struct TALER_TESTING_Command *cmd, - unsigned int index, - const struct TALER_EXCHANGE_DenomPublicKey **denom_pub) +TALER_TESTING_get_trait_denom_pub (const struct TALER_TESTING_Command *cmd, + unsigned int index, + const struct + TALER_EXCHANGE_DenomPublicKey **denom_pub) { return cmd->traits (cmd->cls, (const void **) denom_pub, @@ -62,9 +61,9 @@ TALER_TESTING_get_trait_denom_pub * @return the trait. */ struct TALER_TESTING_Trait -TALER_TESTING_make_trait_denom_pub - (unsigned int index, - const struct TALER_EXCHANGE_DenomPublicKey *denom_pub) +TALER_TESTING_make_trait_denom_pub (unsigned int index, + const struct + TALER_EXCHANGE_DenomPublicKey *denom_pub) { struct TALER_TESTING_Trait ret = { .index = index, diff --git a/src/lib/testing_api_trait_denom_sig.c b/src/lib/testing_api_trait_denom_sig.c index cfb19d438..9f6e2b984 100644 --- a/src/lib/testing_api_trait_denom_sig.c +++ b/src/lib/testing_api_trait_denom_sig.c @@ -38,7 +38,7 @@ * * @param cmd command to extract the denom sig from. * @param index index number associated with the denom sig. - * @param denom_sig[out] set to the offered signature. + * @param[out] denom_sig set to the offered signature. * @return #GNUNET_OK on success. */ int diff --git a/src/lib/testing_api_trait_exchange_pub.c b/src/lib/testing_api_trait_exchange_pub.c index b98f6589a..a7fc215e2 100644 --- a/src/lib/testing_api_trait_exchange_pub.c +++ b/src/lib/testing_api_trait_exchange_pub.c @@ -36,7 +36,7 @@ * * @param cmd command to extract trait from * @param index index number of the exchange to obtain. - * @param exchange_pub[out] set to the offered exchange pub. + * @param[out] exchange_pub set to the offered exchange pub. * @return #GNUNET_OK on success. */ int diff --git a/src/lib/testing_api_trait_exchange_sig.c b/src/lib/testing_api_trait_exchange_sig.c index 5790beb17..ffb084a54 100644 --- a/src/lib/testing_api_trait_exchange_sig.c +++ b/src/lib/testing_api_trait_exchange_sig.c @@ -36,7 +36,7 @@ * * @param cmd command to extract trait from * @param index index number of the exchange to obtain. - * @param exchange_sig[out] set to the offered exchange signature. + * @param[out] exchange_sig set to the offered exchange signature. * @return #GNUNET_OK on success. */ int diff --git a/src/lib/testing_api_trait_json.c b/src/lib/testing_api_trait_json.c index 110661b53..f7739aa8e 100644 --- a/src/lib/testing_api_trait_json.c +++ b/src/lib/testing_api_trait_json.c @@ -37,7 +37,7 @@ * * @param cmd command to extract the keys from. * @param index index number associate with the keys on offer. - * @param keys[out] where to write the serialized keys. + * @param[out] keys where to write the serialized keys. * @return #GNUNET_OK on success. */ int @@ -82,7 +82,7 @@ TALER_TESTING_make_trait_exchange_keys * @param index index number associate with the wire details * on offer; usually zero, as one command sticks to * one bank account. - * @param wire_details[out] where to write the wire details. + * @param[out] wire_details where to write the wire details. * @return #GNUNET_OK on success. */ int