From ef870b54ac7a83dfd386f5dbd6945422796c8ccd Mon Sep 17 00:00:00 2001 From: MS Date: Thu, 15 Oct 2020 12:05:33 +0200 Subject: Doxygen fixes --- src/testing/testing_api_trait_claim_nonce.c | 19 +---------- src/testing/testing_api_trait_hash.c | 37 -------------------- src/testing/testing_api_trait_merchant_sig.c | 19 ----------- src/testing/testing_api_trait_planchet.c | 17 ---------- src/testing/testing_api_trait_refund_entry.c | 17 ---------- src/testing/testing_api_trait_string.c | 50 ---------------------------- 6 files changed, 1 insertion(+), 158 deletions(-) diff --git a/src/testing/testing_api_trait_claim_nonce.c b/src/testing/testing_api_trait_claim_nonce.c index 66f5ce8e..7a878812 100644 --- a/src/testing/testing_api_trait_claim_nonce.c +++ b/src/testing/testing_api_trait_claim_nonce.c @@ -28,16 +28,7 @@ #define TALER_TESTING_TRAIT_CLAIM_NONCE "nonce" -/** - * Obtain an order claim nonce from a @a cmd. - * - * @param cmd command to extract the trait from. - * @param index which nonce to pick if @a - * cmd has multiple on offer - * @param nonce[out] set to the wanted data. - * - * @return #GNUNET_OK on success - */ + int TALER_TESTING_get_trait_claim_nonce (const struct TALER_TESTING_Command *cmd, @@ -51,14 +42,6 @@ TALER_TESTING_get_trait_claim_nonce } -/** - * Offer an order claim nonce. - * - * @param index which nonce to offer if there are - * multiple on offer. - * @param nonce set to the offered nonce. - * @return the trait - */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_claim_nonce (unsigned int index, diff --git a/src/testing/testing_api_trait_hash.c b/src/testing/testing_api_trait_hash.c index 7a4fdb22..f653f80b 100644 --- a/src/testing/testing_api_trait_hash.c +++ b/src/testing/testing_api_trait_hash.c @@ -35,16 +35,6 @@ #define TALER_TESTING_TRAIT_TIP_ID "tip-id" #define TALER_TESTING_TRAIT_H_CONTRACT_TERMS "h-contract-terms" -/** - * Obtain tip id from a @a cmd. - * - * @param cmd command to extract the trait from. - * @param index which tip id to pick if @a - * cmd has multiple on offer - * @param tip_id[out] set to the wanted data. - * - * @return #GNUNET_OK on success - */ int TALER_TESTING_get_trait_tip_id (const struct TALER_TESTING_Command *cmd, @@ -58,14 +48,6 @@ TALER_TESTING_get_trait_tip_id } -/** - * Offer tip id. - * - * @param index which tip id to offer if there are - * multiple on offer. - * @param tip_id set to the offered tip id. - * @return the trait - */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_tip_id (unsigned int index, @@ -80,15 +62,6 @@ TALER_TESTING_make_trait_tip_id } -/** - * Obtain contract terms hash from a @a cmd. - * - * @param cmd command to extract the trait from. - * @param index index number of the trait to fetch. - * @param h_contract_terms[out] set to the wanted data. - * - * @return #GNUNET_OK on success - */ int TALER_TESTING_get_trait_h_contract_terms (const struct TALER_TESTING_Command *cmd, @@ -102,16 +75,6 @@ TALER_TESTING_get_trait_h_contract_terms } -/** - * Offer contract terms hash code. - * - * @param index which hashed contract terms to - * offer if there are multiple on offer - * @param h_contract_terms set to the offered hashed - * contract terms. - * - * @return the trait - */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_h_contract_terms (unsigned int index, diff --git a/src/testing/testing_api_trait_merchant_sig.c b/src/testing/testing_api_trait_merchant_sig.c index 71decd04..2662a870 100644 --- a/src/testing/testing_api_trait_merchant_sig.c +++ b/src/testing/testing_api_trait_merchant_sig.c @@ -28,16 +28,6 @@ #define TALER_TESTING_TRAIT_MERCHANT_SIG "reserve-private-key" -/** - * Obtain a merchant signature over a contract from a @a cmd. - * - * @param cmd command to extract trait from - * @param index which signature to pick if @a cmd has multiple - * on offer - * @param merchant_sig[out] set to the wanted signature. - * - * @return #GNUNET_OK on success - */ int TALER_TESTING_get_trait_merchant_sig (const struct TALER_TESTING_Command *cmd, @@ -51,15 +41,6 @@ TALER_TESTING_get_trait_merchant_sig } -/** - * Offer a merchant signature over a contract. - * - * @param index which signature to offer if there are multiple - * on offer - * @param merchant_sig set to the offered signature. - * - * @return the trait - */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_merchant_sig (unsigned int index, diff --git a/src/testing/testing_api_trait_planchet.c b/src/testing/testing_api_trait_planchet.c index a852d956..97ee8881 100644 --- a/src/testing/testing_api_trait_planchet.c +++ b/src/testing/testing_api_trait_planchet.c @@ -28,15 +28,6 @@ #define TALER_TESTING_TRAIT_PLANCHET_SECRETS "planchet-secrets" -/** - * Obtain planchet secrets from a @a cmd. - * - * @param cmd command to extract trait from. - * @param index index of the trait. - * @param planchet_secrets[out] set to the wanted secrets. - * - * @return #GNUNET_OK on success - */ int TALER_TESTING_get_trait_planchet_secrets (const struct TALER_TESTING_Command *cmd, @@ -50,14 +41,6 @@ TALER_TESTING_get_trait_planchet_secrets } -/** - * Offer planchet secrets. - * - * @param index of the trait. - * @param planchet_secrets set to the offered secrets. - * - * @return the trait - */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_planchet_secrets (unsigned int index, diff --git a/src/testing/testing_api_trait_refund_entry.c b/src/testing/testing_api_trait_refund_entry.c index af8e3846..5c99bac2 100644 --- a/src/testing/testing_api_trait_refund_entry.c +++ b/src/testing/testing_api_trait_refund_entry.c @@ -33,15 +33,6 @@ #define TALER_TESTING_TRAIT_REFUND_ENTRY "refund-entry" -/** - * Obtain refund entry from a @a cmd. - * - * @param cmd command to extract the trait from. - * @param index the trait index. - * @param refund_entry[out] set to the wanted data. - * - * @return #GNUNET_OK on success - */ int TALER_TESTING_get_trait_refund_entry ( const struct TALER_TESTING_Command *cmd, @@ -55,14 +46,6 @@ TALER_TESTING_get_trait_refund_entry ( } -/** - * Offer refund entry. - * - * @param index index number of the trait to offer. - * @param refund_entry set to the offered refund entry. - * - * @return the trait - */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_refund_entry ( unsigned int index, diff --git a/src/testing/testing_api_trait_string.c b/src/testing/testing_api_trait_string.c index d3518d2d..44ff616c 100644 --- a/src/testing/testing_api_trait_string.c +++ b/src/testing/testing_api_trait_string.c @@ -29,21 +29,6 @@ #define TALER_TESTING_TRAIT_PROPOSAL_REFERENCE "proposal-reference" #define TALER_TESTING_TRAIT_COIN_REFERENCE "coin-reference" -/** - * Obtain a reference to a proposal command. Any command that - * works with proposals, might need to offer their reference to - * it. Notably, the "pay" command, offers its proposal reference - * to the "pay abort" command as the latter needs to reconstruct - * the same data needed by the former in order to use the "pay - * abort" API. - * - * @param cmd command to extract the trait from. - * @param index which reference to pick if @a cmd has multiple - * on offer. - * @param proposal_reference[out] set to the wanted reference. - * - * @return #GNUNET_OK on success - */ int TALER_TESTING_get_trait_proposal_reference (const struct TALER_TESTING_Command *cmd, @@ -57,15 +42,6 @@ TALER_TESTING_get_trait_proposal_reference } -/** - * Offer a proposal reference. - * - * @param index which reference to offer if there are - * multiple on offer. - * @param proposal_reference[out] pointer to the reference to offer. - * - * @return the trait - */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_proposal_reference (unsigned int index, @@ -80,23 +56,6 @@ TALER_TESTING_make_trait_proposal_reference } -/** - * Obtain a reference to any command that can provide coins as - * traits. - * - * @param cmd command to extract trait from - * @param index which reference to pick if @a cmd has multiple - * on offer - * @param coin_reference[out] set to the wanted reference. - * NOTE: a _single_ reference can contain - * _multiple_ instances, using semi-colon as separator. - * For example, a _single_ reference can be this: - * "coin-ref-1", or even this: "coin-ref-1;coin-ref-2". - * The "pay" command contains functions that can parse - * such format. - * - * @return #GNUNET_OK on success - */ int TALER_TESTING_get_trait_coin_reference (const struct TALER_TESTING_Command *cmd, @@ -110,15 +69,6 @@ TALER_TESTING_get_trait_coin_reference } -/** - * Offer a coin reference. - * - * @param index which reference to offer if there are - * multiple on offer. - * @param coin_reference set to the offered reference. - * - * @return the trait - */ struct TALER_TESTING_Trait TALER_TESTING_make_trait_coin_reference (unsigned int index, -- cgit v1.2.3