diff options
author | Christian Grothoff <grothoff@gnunet.org> | 2023-11-28 11:39:18 +0900 |
---|---|---|
committer | Christian Grothoff <grothoff@gnunet.org> | 2023-11-28 11:39:18 +0900 |
commit | 35d52699018a62851ba1420715d4bec3818a190a (patch) | |
tree | 7a84936c83a09bdb27fe50c130e9a2f2161d843a /src | |
parent | f7661b0c1f74cd1955e7a8de22dda1fecff2a2de (diff) |
-misc doxygen fixes
Diffstat (limited to 'src')
-rw-r--r-- | src/auditor/taler-helper-auditor-wire.c | 3 | ||||
-rw-r--r-- | src/auditordb/pg_select_pending_deposits.h | 2 | ||||
-rw-r--r-- | src/bank-lib/fakebank_bank_get_withdrawals.h | 2 | ||||
-rw-r--r-- | src/bank-lib/fakebank_bank_post_withdrawals_abort.h | 2 | ||||
-rw-r--r-- | src/bank-lib/fakebank_bank_post_withdrawals_confirm.c | 8 | ||||
-rw-r--r-- | src/exchange/taler-exchange-httpd.c | 1 | ||||
-rw-r--r-- | src/include/taler_auditordb_plugin.h | 2 | ||||
-rw-r--r-- | src/include/taler_crypto_lib.h | 2 | ||||
-rw-r--r-- | src/include/taler_exchange_service.h | 16 | ||||
-rw-r--r-- | src/include/taler_exchangedb_plugin.h | 2 | ||||
-rw-r--r-- | src/include/taler_json_lib.h | 7 | ||||
-rw-r--r-- | src/lib/auditor_api_deposit_confirmation.c | 3 | ||||
-rw-r--r-- | src/lib/exchange_api_coins_history.c | 9 |
13 files changed, 29 insertions, 30 deletions
diff --git a/src/auditor/taler-helper-auditor-wire.c b/src/auditor/taler-helper-auditor-wire.c index 2d2bdbcc2..9f85722d4 100644 --- a/src/auditor/taler-helper-auditor-wire.c +++ b/src/auditor/taler-helper-auditor-wire.c @@ -1117,8 +1117,9 @@ generate_report (void *cls, * and have not yet seen a wire transfer. * * @param cls closure, points to a `struct ReportMissingWireContext` + * @param batch_deposit_serial_id row in the database for which the wire transfer is missing * @param total_amount value of the missing deposits, including fee - * @param payto_uri where should the funds be wired + * @param wire_target_h_payto hash of payto-URI where the funds should have been wired * @param deadline what was the earliest requested wire transfer deadline */ static void diff --git a/src/auditordb/pg_select_pending_deposits.h b/src/auditordb/pg_select_pending_deposits.h index bbf3e843a..7e085304d 100644 --- a/src/auditordb/pg_select_pending_deposits.h +++ b/src/auditordb/pg_select_pending_deposits.h @@ -30,6 +30,8 @@ * Return (batch) deposits for which we have not yet * seen the required wire transfer. * + * @param cls closure + * @param master_pub master public key of the exchange * @param deadline only return up to this deadline * @param cb function to call on each entry * @param cb_cls closure for @a cb diff --git a/src/bank-lib/fakebank_bank_get_withdrawals.h b/src/bank-lib/fakebank_bank_get_withdrawals.h index a753dcee8..62a96866c 100644 --- a/src/bank-lib/fakebank_bank_get_withdrawals.h +++ b/src/bank-lib/fakebank_bank_get_withdrawals.h @@ -17,7 +17,7 @@ see <http://www.gnu.org/licenses/> */ /** - * @file bank-lib/fakebank_bank_get_accounts_withdrawals.h + * @file bank-lib/fakebank_bank_get_withdrawals.h * @brief implements the Taler Bank API "GET /accounts/ACC/withdrawals/WID" handler * @author Christian Grothoff <christian@grothoff.org> */ diff --git a/src/bank-lib/fakebank_bank_post_withdrawals_abort.h b/src/bank-lib/fakebank_bank_post_withdrawals_abort.h index fcc94e201..920b0b802 100644 --- a/src/bank-lib/fakebank_bank_post_withdrawals_abort.h +++ b/src/bank-lib/fakebank_bank_post_withdrawals_abort.h @@ -17,7 +17,7 @@ see <http://www.gnu.org/licenses/> */ /** - * @file bank-lib/fakebank_bank_post_accounts_withdrawals_abort.h + * @file bank-lib/fakebank_bank_post_withdrawals_abort.h * @brief implement bank API withdrawals /abort endpoint * @author Christian Grothoff <christian@grothoff.org> */ diff --git a/src/bank-lib/fakebank_bank_post_withdrawals_confirm.c b/src/bank-lib/fakebank_bank_post_withdrawals_confirm.c index 90aaf5e2c..2fa67c970 100644 --- a/src/bank-lib/fakebank_bank_post_withdrawals_confirm.c +++ b/src/bank-lib/fakebank_bank_post_withdrawals_confirm.c @@ -34,14 +34,6 @@ #include "fakebank_common_make_admin_transfer.h" -/** - * Handle POST /withdrawals/{withdrawal_id}/confirm request. - * - * @param h our fakebank handle - * @param connection the connection - * @param withdrawal_id the withdrawal operation identifier - * @return MHD result code - */ MHD_RESULT TALER_FAKEBANK_bank_withdrawals_confirm_ ( struct TALER_FAKEBANK_Handle *h, diff --git a/src/exchange/taler-exchange-httpd.c b/src/exchange/taler-exchange-httpd.c index 1cde58164..67e089627 100644 --- a/src/exchange/taler-exchange-httpd.c +++ b/src/exchange/taler-exchange-httpd.c @@ -390,7 +390,6 @@ handle_post_coins (struct TEH_RequestContext *rc, * EdDSA key of the coin and demultiplexes based on $OP. * * @param rc request context - * @param root uploaded JSON data * @param args array of additional options * @return MHD result code */ diff --git a/src/include/taler_auditordb_plugin.h b/src/include/taler_auditordb_plugin.h index 31e6723a5..b83d6316c 100644 --- a/src/include/taler_auditordb_plugin.h +++ b/src/include/taler_auditordb_plugin.h @@ -628,7 +628,7 @@ typedef enum GNUNET_GenericReturnValue * @param batch_deposit_serial_id where in the table are we * @param total_amount value of all missing deposits, including fees * @param wire_target_h_payto hash of the recipient account's payto URI - * @param earliest_deadline what was the earliest requested wire transfer deadline + * @param deadline what was the earliest requested wire transfer deadline */ typedef void (*TALER_AUDITORDB_WireMissingCallback)( diff --git a/src/include/taler_crypto_lib.h b/src/include/taler_crypto_lib.h index 0d3935238..6f5b403b0 100644 --- a/src/include/taler_crypto_lib.h +++ b/src/include/taler_crypto_lib.h @@ -2324,7 +2324,7 @@ struct TALER_CRYPTO_RsaDenominationHelper; * @param validity_duration how long does the key remain available for signing; * zero if the key has been revoked or purged * @param h_rsa hash of the RSA @a denom_pub that is available (or was purged) - * @param denom_pub the public key itself, NULL if the key was revoked or purged + * @param bs_pub the public key itself, NULL if the key was revoked or purged * @param sm_pub public key of the security module, NULL if the key was revoked or purged * @param sm_sig signature from the security module, NULL if the key was revoked or purged * The signature was already verified against @a sm_pub. diff --git a/src/include/taler_exchange_service.h b/src/include/taler_exchange_service.h index 7b9b1dd41..503074599 100644 --- a/src/include/taler_exchange_service.h +++ b/src/include/taler_exchange_service.h @@ -1767,7 +1767,6 @@ struct TALER_EXCHANGE_CoinsHistoryHandle; * @param dk denomination key of the coin * @param history JSON array with the coin's history * @param coin_pub public key of the coin - * @param currency currency of the coin * @param[out] total_in set to total amount credited to the coin in @a history * @param[out] total_out set to total amount debited to the coin in @a history * @param rlen length of the @a rhistory array @@ -1871,15 +1870,12 @@ typedef void * have to combine multiple partial coin histories * into one coherent history before calling this function. * - * @param keys /keys data of the exchange - * @param dk denomination key of the coin - * @param history JSON array with the coin's full history - * @param coin_pub public key of the coin - * @param currency currency of the coin - * @param[out] total_in set to total amount credited to the coin in @a history - * @param[out] total_out set to total amount debited to the coin in @a history - * @param len length of the @a rhistory - * @param[out] rhistory where to write the parsed @a history + * @param ctx context for managing request + * @param url base URL of the exchange + * @param coin_priv private key of the coin + * @param start_off offset from which on to request history + * @param cb function to call with results + * @param cb_cls closure for @a cb * @return #GNUNET_OK if @a history is valid, * #GNUNET_SYSERR if not */ diff --git a/src/include/taler_exchangedb_plugin.h b/src/include/taler_exchangedb_plugin.h index 704f8012a..c68ebb539 100644 --- a/src/include/taler_exchangedb_plugin.h +++ b/src/include/taler_exchangedb_plugin.h @@ -3401,7 +3401,7 @@ typedef void * @param batch_deposit_serial_id where in the table are we * @param total_amount value of all missing deposits, including fees * @param wire_target_h_payto hash of the recipient account's payto URI - * @param earliest_deadline what was the earliest requested wire transfer deadline + * @param deadline what was the earliest requested wire transfer deadline */ typedef void (*TALER_EXCHANGEDB_WireMissingCallback)( diff --git a/src/include/taler_json_lib.h b/src/include/taler_json_lib.h index dc8061705..51fd17dd0 100644 --- a/src/include/taler_json_lib.h +++ b/src/include/taler_json_lib.h @@ -425,7 +425,7 @@ struct TALER_JSON_ProtocolVersion /** * Number of protocol versions this @e revision is * backwards-compatible with. Subtract this number - * from @a current to get the minimum protocol version + * from @e current to get the minimum protocol version * required from the client. */ unsigned int age; @@ -438,15 +438,14 @@ struct TALER_JSON_ProtocolVersion * encoding the version as "$CURRENT:$REVISION:$AGE". * * @param field name of the field (usually "version") - * @param[out] current protocol current to initialize - * @param[out] revision protocol revision to initialize - * @param[out] age protocol age to initialize + * @param[out] ver protocol versions to initialize * @return corresponding field spec */ struct GNUNET_JSON_Specification TALER_JSON_spec_version (const char *field, struct TALER_JSON_ProtocolVersion *ver); + /** * Generate a parser specification for a denomination public key of a given * cipher. diff --git a/src/lib/auditor_api_deposit_confirmation.c b/src/lib/auditor_api_deposit_confirmation.c index 1e2ecc6cc..172a12ece 100644 --- a/src/lib/auditor_api_deposit_confirmation.c +++ b/src/lib/auditor_api_deposit_confirmation.c @@ -155,7 +155,8 @@ handle_deposit_confirmation_finished (void *cls, * @param wire_deadline by what time must the amount be wired to the merchant * @param refund_deadline date until which the merchant can issue a refund to the customer via the auditor (can be zero if refunds are not allowed); must not be after the @a wire_deadline * @param amount_without_fee the amount confirmed to be wired by the exchange to the merchant - * @param coin_pub coin’s public key + * @param num_coins number of coins involved + * @param coin_sigs array of @a num_coins coin signatures * @param merchant_pub the public key of the merchant (used to identify the merchant for refund requests) * @param exchange_sig the signature made with purpose #TALER_SIGNATURE_EXCHANGE_CONFIRM_DEPOSIT * @param exchange_pub the public key of the exchange that matches @a exchange_sig diff --git a/src/lib/exchange_api_coins_history.c b/src/lib/exchange_api_coins_history.c index 6981fad5a..0999e185e 100644 --- a/src/lib/exchange_api_coins_history.c +++ b/src/lib/exchange_api_coins_history.c @@ -130,6 +130,7 @@ typedef enum GNUNET_GenericReturnValue * Handle deposit entry in the coin's history. * * @param[in,out] pc overall context + * @param[out] rh history entry to initialize * @param amount main amount of this operation * @param transaction JSON details for the operation * @return #GNUNET_SYSERR on error, @@ -226,6 +227,7 @@ help_deposit (struct CoinHistoryParseContext *pc, * Handle melt entry in the coin's history. * * @param[in,out] pc overall context + * @param[out] rh history entry to initialize * @param amount main amount of this operation * @param transaction JSON details for the operation * @return #GNUNET_SYSERR on error, @@ -294,6 +296,7 @@ help_melt (struct CoinHistoryParseContext *pc, * Handle refund entry in the coin's history. * * @param[in,out] pc overall context + * @param[out] rh history entry to initialize * @param amount main amount of this operation * @param transaction JSON details for the operation * @return #GNUNET_SYSERR on error, @@ -373,6 +376,7 @@ help_refund (struct CoinHistoryParseContext *pc, * Handle recoup entry in the coin's history. * * @param[in,out] pc overall context + * @param[out] rh history entry to initialize * @param amount main amount of this operation * @param transaction JSON details for the operation * @return #GNUNET_SYSERR on error, @@ -439,6 +443,7 @@ help_recoup (struct CoinHistoryParseContext *pc, * the value being credited to the old coin. * * @param[in,out] pc overall context + * @param[out] rh history entry to initialize * @param amount main amount of this operation * @param transaction JSON details for the operation * @return #GNUNET_SYSERR on error, @@ -505,6 +510,7 @@ help_recoup_refresh (struct CoinHistoryParseContext *pc, * the value being credited to the this coin. * * @param[in,out] pc overall context + * @param[out] rh history entry to initialize * @param amount main amount of this operation * @param transaction JSON details for the operation * @return #GNUNET_SYSERR on error, @@ -556,6 +562,7 @@ help_old_coin_recoup (struct CoinHistoryParseContext *pc, * Handle purse deposit entry in the coin's history. * * @param[in,out] pc overall context + * @param[out] rh history entry to initialize * @param amount main amount of this operation * @param transaction JSON details for the operation * @return #GNUNET_SYSERR on error, @@ -625,6 +632,7 @@ help_purse_deposit (struct CoinHistoryParseContext *pc, * Handle purse refund entry in the coin's history. * * @param[in,out] pc overall context + * @param[out] rh history entry to initialize * @param amount main amount of this operation * @param transaction JSON details for the operation * @return #GNUNET_SYSERR on error, @@ -686,6 +694,7 @@ help_purse_refund (struct CoinHistoryParseContext *pc, * Handle reserve deposit entry in the coin's history. * * @param[in,out] pc overall context + * @param[out] rh history entry to initialize * @param amount main amount of this operation * @param transaction JSON details for the operation * @return #GNUNET_SYSERR on error, |