From 9c45958a55d25f87fa8848765cb924ddc604e91b Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Sat, 18 Jan 2020 14:13:28 +0100 Subject: doxygen --- src/include/taler_mhd_lib.h | 2 +- src/include/taler_pq_lib.h | 4 ++-- src/include/taler_testing_lib.h | 7 ++----- src/include/taler_util.h | 1 + src/lib/testing_api_cmd_refresh.c | 22 ++++++++-------------- src/lib/testing_api_cmd_track.c | 2 +- src/mhd/mhd_legal.c | 8 ++++---- src/pq/pq_result_helper.c | 3 ++- src/util/crypto_wire.c | 4 ++-- src/util/util.c | 1 + 10 files changed, 24 insertions(+), 30 deletions(-) (limited to 'src') diff --git a/src/include/taler_mhd_lib.h b/src/include/taler_mhd_lib.h index 6840509b5..e82d8d75f 100644 --- a/src/include/taler_mhd_lib.h +++ b/src/include/taler_mhd_lib.h @@ -422,7 +422,7 @@ TALER_MHD_legal_load (const struct GNUNET_CONFIGURATION_Handle *cfg, /** * Free set of legal documents * - * @param leg legal documents to free + * @param legal legal documents to free */ void TALER_MHD_legal_free (struct TALER_MHD_Legal *legal); diff --git a/src/include/taler_pq_lib.h b/src/include/taler_pq_lib.h index 697917568..066f117ee 100644 --- a/src/include/taler_pq_lib.h +++ b/src/include/taler_pq_lib.h @@ -95,7 +95,7 @@ TALER_PQ_query_param_absolute_time_nbo (const struct * Currency amount expected. * * @param name name of the field in the table - * @param currency expected currency for the @a amount + * @param currency currency to use for @a amount * @param[out] amount where to store the result * @return array entry for the result specification to use */ @@ -109,7 +109,7 @@ TALER_PQ_result_spec_amount_nbo (const char *name, * Currency amount expected. * * @param name name of the field in the table - * @param currency expected currency for the @a amount + * @param currency currency to use for @a amount * @param[out] amount where to store the result * @return array entry for the result specification to use */ diff --git a/src/include/taler_testing_lib.h b/src/include/taler_testing_lib.h index b20f7c116..060bbd0a7 100644 --- a/src/include/taler_testing_lib.h +++ b/src/include/taler_testing_lib.h @@ -1250,10 +1250,8 @@ TALER_TESTING_cmd_refresh_reveal_with_retry (struct TALER_TESTING_Command cmd); * Create a "refresh link" command. * * @param label command label. - * @param exchange connection to the exchange. * @param reveal_reference reference to a "refresh reveal" CMD. * @param expected_response_code expected HTTP response code - * * @return the "refresh link" command */ struct TALER_TESTING_Command @@ -1307,7 +1305,6 @@ TALER_TESTING_cmd_track_transaction (const char *label, * @param index index number of the WTID to track, in case there * are multiple on offer. * @param expected_response_code expected HTTP response code. - * * @return the command. */ struct TALER_TESTING_Command @@ -1327,7 +1324,7 @@ TALER_TESTING_cmd_track_transfer_empty (const char *label, * @param index in case there are multiple WTID offered, this * parameter selects a particular one. * @param expected_response_code expected HTTP response code. - * @param expected_amount how much money we expect being moved + * @param expected_total_amount how much money we expect being moved * with this wire-transfer. * @param expected_wire_fee expected wire fee. * @return the command @@ -1461,7 +1458,7 @@ TALER_TESTING_cmd_refund (const char *label, * the index of the coin using "$LABEL#$INDEX" syntax. * Here, $INDEX must be a non-negative number. * @param amount denomination to pay back. - * @param NULL if coin was not refreshed, otherwise label of the melt operation + * @param melt_reference NULL if coin was not refreshed, otherwise label of the melt operation * @return the command. */ struct TALER_TESTING_Command diff --git a/src/include/taler_util.h b/src/include/taler_util.h index 335b123c3..9157faf01 100644 --- a/src/include/taler_util.h +++ b/src/include/taler_util.h @@ -224,6 +224,7 @@ TALER_url_absolute_raw_va (const char *proto, /** * Make an absolute URL for a given MHD connection. * + * @param connection the connection to get the URL for * @param path path of the url * @param ... NULL-terminated key-value pairs (char *) for query parameters, * the value will be url-encoded diff --git a/src/lib/testing_api_cmd_refresh.c b/src/lib/testing_api_cmd_refresh.c index da9f7c051..fb3ee185d 100644 --- a/src/lib/testing_api_cmd_refresh.c +++ b/src/lib/testing_api_cmd_refresh.c @@ -1157,11 +1157,10 @@ parse_amounts (struct RefreshMeltState *rms, * @return the command. */ struct TALER_TESTING_Command -TALER_TESTING_cmd_refresh_melt - (const char *label, - const char *coin_reference, - unsigned int expected_response_code, - ...) +TALER_TESTING_cmd_refresh_melt (const char *label, + const char *coin_reference, + unsigned int expected_response_code, + ...) { struct RefreshMeltState *rms; va_list ap; @@ -1193,7 +1192,6 @@ TALER_TESTING_cmd_refresh_melt * request, see #5312. * * @param label command label - * @param exchange connection to the exchange * @param coin_reference reference to a command that will provide * a coin to refresh * @param expected_response_code expected HTTP code @@ -1201,11 +1199,10 @@ TALER_TESTING_cmd_refresh_melt * @return the command. */ struct TALER_TESTING_Command -TALER_TESTING_cmd_refresh_melt_double - (const char *label, - const char *coin_reference, - unsigned int expected_response_code, - ...) +TALER_TESTING_cmd_refresh_melt_double (const char *label, + const char *coin_reference, + unsigned int expected_response_code, + ...) { struct RefreshMeltState *rms; va_list ap; @@ -1257,7 +1254,6 @@ TALER_TESTING_cmd_refresh_melt_with_retry (struct TALER_TESTING_Command cmd) * @param[out] ret result (could be anything). * @param trait name of the trait. * @param index index number of the object to offer. - * * @return #GNUNET_OK on success. */ static int @@ -1318,7 +1314,6 @@ refresh_reveal_traits (void *cls, * @param exchange connection to the exchange. * @param melt_reference reference to a "refresh melt" command. * @param expected_response_code expected HTTP response code. - * * @return the command. */ struct TALER_TESTING_Command @@ -1369,7 +1364,6 @@ TALER_TESTING_cmd_refresh_reveal_with_retry (struct TALER_TESTING_Command cmd) * @param label command label. * @param reveal_reference reference to a "refresh reveal" CMD. * @param expected_response_code expected HTTP response code - * * @return the "refresh link" command */ struct TALER_TESTING_Command diff --git a/src/lib/testing_api_cmd_track.c b/src/lib/testing_api_cmd_track.c index 6d095bafb..bb70c5bad 100644 --- a/src/lib/testing_api_cmd_track.c +++ b/src/lib/testing_api_cmd_track.c @@ -768,7 +768,7 @@ TALER_TESTING_cmd_track_transfer_empty (const char *label, * @param index in case there are multiple WTID offered, this * parameter selects a particular one. * @param expected_response_code expected HTTP response code. - * @param expected_amount how much money we expect being moved + * @param expected_total_amount how much money we expect being moved * with this wire-transfer. * @param expected_wire_fee expected wire fee. * @return the command diff --git a/src/mhd/mhd_legal.c b/src/mhd/mhd_legal.c index b39ab4378..e0fb0b294 100644 --- a/src/mhd/mhd_legal.c +++ b/src/mhd/mhd_legal.c @@ -80,7 +80,7 @@ struct TALER_MHD_Legal /** * Check if @a mime matches the @a accept_pattern. * - * @param accept_pattern a mime pattern like text/plain or image/ + * @param accept_pattern a mime pattern like text/plain or image/STAR * @param mime the mime type to match * @return true if @a mime matches the @a accept_pattern */ @@ -307,7 +307,7 @@ TALER_MHD_reply_legal (struct MHD_Connection *conn, * Load all the terms of service from @a path under language @a lang * from file @a name * - * @param legal[in,out] where to write the result + * @param[in,out] legal where to write the result * @param path where the terms are found * @param lang which language directory to crawl * @param name specific file to access @@ -467,7 +467,7 @@ load_terms (struct TALER_MHD_Legal *legal, /** * Load all the terms of service from @a path under language @a lang. * - * @param legal[in,out] where to write the result + * @param[in,out] legal where to write the result * @param path where the terms are found * @param lang which language directory to crawl */ @@ -569,7 +569,7 @@ TALER_MHD_legal_load (const struct GNUNET_CONFIGURATION_Handle *cfg, /** * Free set of legal documents * - * @param leg legal documents to free + * @param legal legal documents to free */ void TALER_MHD_legal_free (struct TALER_MHD_Legal *legal) diff --git a/src/pq/pq_result_helper.c b/src/pq/pq_result_helper.c index f6eab87e1..b3977d738 100644 --- a/src/pq/pq_result_helper.c +++ b/src/pq/pq_result_helper.c @@ -161,6 +161,7 @@ extract_amount_nbo (void *cls, * Currency amount expected. * * @param name name of the field in the table + * @param currency the currency to use for @a amount * @param[out] amount where to store the result * @return array entry for the result specification to use */ @@ -239,7 +240,7 @@ extract_amount (void *cls, * Currency amount expected. * * @param name name of the field in the table - * @param currency the currency the amount is in + * @param currency the currency to use for @a amount * @param[out] amount where to store the result * @return array entry for the result specification to use */ diff --git a/src/util/crypto_wire.c b/src/util/crypto_wire.c index e3a5b9fb6..37cb8848a 100644 --- a/src/util/crypto_wire.c +++ b/src/util/crypto_wire.c @@ -161,8 +161,8 @@ TALER_merchant_wire_signature_check (const char *payto_url, * * @param payto_url account specification * @param salt the salt used to salt the @a payto_url when hashing - * @param merchant_priv private key to sign with - * @param[out] merchant_sig where to write the signature + * @param merch_priv private key to sign with + * @param[out] merch_sig where to write the signature */ void TALER_merchant_wire_signature_make (const char *payto_url, diff --git a/src/util/util.c b/src/util/util.c index c9316462b..84f774d1c 100644 --- a/src/util/util.c +++ b/src/util/util.c @@ -489,6 +489,7 @@ TALER_mhd_is_https (struct MHD_Connection *connection) /** * Make an absolute URL for a given MHD connection. * + * @param connection the connection to get the URL for * @param path path of the url * @param ... NULL-terminated key-value pairs (char *) for query parameters, * the value will be url-encoded -- cgit v1.2.3