From 4b2504a3c36d45beec3adda844658270d1ec18a3 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Mon, 30 Nov 2020 14:16:42 +0100 Subject: [PATCH] doxygen fixes --- src/exchange/taler-exchange-httpd_auditors.c | 2 ++ src/exchangedb/plugin_exchangedb_postgres.c | 2 +- src/include/taler_crypto_lib.h | 8 ++++---- src/include/taler_exchange_service.h | 8 ++++---- src/include/taler_exchangedb_plugin.h | 2 +- src/include/taler_testing_lib.h | 11 ++++++++--- src/lib/exchange_api_management_get_keys.c | 2 +- src/util/taler-helper-crypto-eddsa.c | 2 +- src/util/taler-helper-crypto-rsa.c | 6 +++--- 9 files changed, 25 insertions(+), 18 deletions(-) diff --git a/src/exchange/taler-exchange-httpd_auditors.c b/src/exchange/taler-exchange-httpd_auditors.c index 0aa10812e..3833a2014 100644 --- a/src/exchange/taler-exchange-httpd_auditors.c +++ b/src/exchange/taler-exchange-httpd_auditors.c @@ -212,6 +212,8 @@ add_auditor_denom_sig (void *cls, * * @param connection the MHD connection to handle * @param root uploaded JSON data + * @param auditor_pub public key of the auditor + * @param h_denom_pub hash of the denomination public key * @return MHD result code */ MHD_RESULT diff --git a/src/exchangedb/plugin_exchangedb_postgres.c b/src/exchangedb/plugin_exchangedb_postgres.c index e42d366cb..1a591bb80 100644 --- a/src/exchangedb/plugin_exchangedb_postgres.c +++ b/src/exchangedb/plugin_exchangedb_postgres.c @@ -7499,7 +7499,7 @@ postgres_lookup_auditor_timestamp ( * @param cls closure * @param session a session * @param auditor_pub key to look up information for - * @param[out] set to the base URL of the auditor's REST API; memory to be + * @param[out] auditor_url set to the base URL of the auditor's REST API; memory to be * released by the caller! * @param[out] enabled set if the auditor is currently in use * @return transaction status code diff --git a/src/include/taler_crypto_lib.h b/src/include/taler_crypto_lib.h index 8be0bad4a..ae7385058 100644 --- a/src/include/taler_crypto_lib.h +++ b/src/include/taler_crypto_lib.h @@ -880,7 +880,7 @@ TALER_CRYPTO_helper_denom_sign ( /** - * Ask the helper to revoke the public key associated with @param h_denom_pub. + * Ask the helper to revoke the public key associated with @param h_denom_pub . * Will cause the helper to tell all clients that the key is now unavailable, * and to create a replacement key. * @@ -1004,8 +1004,8 @@ TALER_CRYPTO_helper_esign_sign_ ( * * @param esh helper process connection * @param ps message to sign (MUST begin with a purpose) - * @param[out] exchange_pub set to the public key used for the signature upon success - * @param[out] exchange_sig set to the signature upon success + * @param[out] epub set to the public key used for the signature upon success + * @param[out] esig set to the signature upon success * @return the error code (or #TALER_EC_NONE on success) */ #define TALER_CRYPTO_helper_esign_sign(esh,ps,epub,esig) ( \ @@ -1021,7 +1021,7 @@ TALER_CRYPTO_helper_esign_sign_ ( /** - * Ask the helper to revoke the public key @param exchange_pub. + * Ask the helper to revoke the public key @param exchange_pub . * Will cause the helper to tell all clients that the key is now unavailable, * and to create a replacement key. * diff --git a/src/include/taler_exchange_service.h b/src/include/taler_exchange_service.h index a8b78a2b3..512dfb35c 100644 --- a/src/include/taler_exchange_service.h +++ b/src/include/taler_exchange_service.h @@ -2201,6 +2201,7 @@ struct TALER_EXCHANGE_ManagementPostKeysHandle; * * @param ctx the context * @param url HTTP base URL for the exchange + * @param pkd signature data to POST * @param cb function to call with the exchange's result * @param cb_cls closure for @a cb * @return the request handle; NULL upon error @@ -2217,7 +2218,7 @@ TALER_EXCHANGE_post_management_keys ( /** * Cancel #TALER_EXCHANGE_post_management_keys() operation. * - * @param gh handle of the operation to cancel + * @param ph handle of the operation to cancel */ void TALER_EXCHANGE_post_management_keys_cancel ( @@ -2450,7 +2451,6 @@ struct TALER_EXCHANGE_ManagementWireEnableHandle; * * @param ctx the context * @param url HTTP base URL for the exchange - * @param salt salt to use when hashing the account for the signature * @param payto_uri RFC 8905 URI of the exchange's bank account * @param validity_start when was this decided? * @param master_sig1 signature affirming the wire addition @@ -2586,7 +2586,7 @@ TALER_EXCHANGE_management_set_wire_fees ( /** * Cancel #TALER_EXCHANGE_management_enable_wire() operation. * - * @param wh handle of the operation to cancel + * @param swfh handle of the operation to cancel */ void TALER_EXCHANGE_management_set_wire_fees_cancel ( @@ -2639,7 +2639,7 @@ TALER_EXCHANGE_add_auditor_denomination ( /** * Cancel #TALER_EXCHANGE_add_auditor_denomination() operation. * - * @param gh handle of the operation to cancel + * @param ah handle of the operation to cancel */ void TALER_EXCHANGE_add_auditor_denomination_cancel ( diff --git a/src/include/taler_exchangedb_plugin.h b/src/include/taler_exchangedb_plugin.h index ae240b8d6..125cfe348 100644 --- a/src/include/taler_exchangedb_plugin.h +++ b/src/include/taler_exchangedb_plugin.h @@ -2977,7 +2977,7 @@ struct TALER_EXCHANGEDB_Plugin * @param cls closure * @param session a session * @param auditor_pub key to look up information for - * @param[out] set to the base URL of the auditor's REST API; memory to be + * @param[out] auditor_url set to the base URL of the auditor's REST API; memory to be * released by the caller! * @param[out] enabled set if the auditor is currently in use * @return transaction status code diff --git a/src/include/taler_testing_lib.h b/src/include/taler_testing_lib.h index f27938262..3f028cadf 100644 --- a/src/include/taler_testing_lib.h +++ b/src/include/taler_testing_lib.h @@ -2143,7 +2143,7 @@ TALER_TESTING_cmd_offline_sign_keys (const char *label, * Revoke an exchange denomination key. * * @param label command label. - * @param expected_http_status expected HTTP status from exchange + * @param expected_response_code expected HTTP status from exchange * @param bad_sig should we use a bogus signature? * @param denom_ref reference to a command that identifies * a denomination key (i.e. because it was used to @@ -2162,7 +2162,7 @@ TALER_TESTING_cmd_revoke_denom_key ( * Revoke an exchange online signing key. * * @param label command label. - * @param expected_http_status expected HTTP status from exchange + * @param expected_response_code expected HTTP status from exchange * @param bad_sig should we use a bogus signature? * @param signkey_ref reference to a command that identifies * a signing key (i.e. because it was used to @@ -2183,13 +2183,18 @@ TALER_TESTING_cmd_revoke_sign_key ( * the exchange. * * @param label command label. + * @param expected_http_status expected HTTP status from exchange * @param denom_ref reference to a command that identifies * a denomination key (i.e. because it was used to * withdraw a coin). + * @param bad_sig should we use a bogus signature? * @return the command */ struct TALER_TESTING_Command -TALER_TESTING_cmd_auditor_add_denom_key (const char *denom_ref); +TALER_TESTING_cmd_auditor_add_denom_sig (const char *label, + unsigned int expected_http_status, + const char *denom_ref, + bool bad_sig); /* *** Generic trait logic for implementing traits ********* */ diff --git a/src/lib/exchange_api_management_get_keys.c b/src/lib/exchange_api_management_get_keys.c index dfee6776e..bfda08c76 100644 --- a/src/lib/exchange_api_management_get_keys.c +++ b/src/lib/exchange_api_management_get_keys.c @@ -65,7 +65,7 @@ struct TALER_EXCHANGE_ManagementGetKeysHandle * * @param[in,out] gh request handle * @param response the response - * @return #MHD_OK if the response was well-formed + * @return #GNUNET_OK if the response was well-formed */ static int handle_ok (struct TALER_EXCHANGE_ManagementGetKeysHandle *gh, diff --git a/src/util/taler-helper-crypto-eddsa.c b/src/util/taler-helper-crypto-eddsa.c index f4bf47655..d09f16070 100644 --- a/src/util/taler-helper-crypto-eddsa.c +++ b/src/util/taler-helper-crypto-eddsa.c @@ -332,7 +332,7 @@ static struct GNUNET_NETWORK_Handle *done_signal; static volatile bool in_shutdown; /** - * Array of #num_worker sign_worker() threads. + * Array of #num_workers sign_worker() threads. */ static pthread_t *workers; diff --git a/src/util/taler-helper-crypto-rsa.c b/src/util/taler-helper-crypto-rsa.c index 140a0a8fc..977056743 100644 --- a/src/util/taler-helper-crypto-rsa.c +++ b/src/util/taler-helper-crypto-rsa.c @@ -400,7 +400,7 @@ static struct GNUNET_NETWORK_Handle *done_signal; static volatile bool in_shutdown; /** - * Array of #num_worker sign_worker() threads. + * Array of #num_workers sign_worker() threads. */ static pthread_t *workers; @@ -804,7 +804,7 @@ notify_client_dk_del (struct Client *client, /** * Initialize key material for denomination key @a dk (also on disk). * - * @param[in,out] denomination key to compute key material for + * @param[in,out] dk denomination key to compute key material for * @param position where in the DLL will the @a dk go * @return #GNUNET_OK on success */ @@ -1148,7 +1148,7 @@ create_key (struct Denomination *denom) * oldest denomination key, and the withdraw expiration time of * the newest denomination key minus the #lookahead_sign time. * - * @param denon denomination to compute action time for + * @param denom denomination to compute action time for */ static struct GNUNET_TIME_Absolute denomination_action_time (const struct Denomination *denom)