-handle doxygen complaints

This commit is contained in:
Özgür Kesim 2023-07-11 09:06:28 +02:00
parent 43d5e5707c
commit 88ecba945e
Signed by: oec
GPG Key ID: 3D76A56D79EDD9D7
7 changed files with 50 additions and 56 deletions

View File

@ -106,7 +106,7 @@ free_age_withdraw_context_resources (struct AgeWithdrawContext *awc)
* @param connection The MHD connection to handle * @param connection The MHD connection to handle
* @param j_denoms_h Array of n hashes of the denominations for the withdrawal, in JSON format * @param j_denoms_h Array of n hashes of the denominations for the withdrawal, in JSON format
* @param j_blinded_coin_evs Array of n arrays of kappa blinded envelopes of in JSON format for the coins. * @param j_blinded_coin_evs Array of n arrays of kappa blinded envelopes of in JSON format for the coins.
* @param[out] aws The context of the operation, only partially built at call time * @param[out] awc The context of the operation, only partially built at call time
* @param[out] mhd_ret The result if a reply is queued for MHD * @param[out] mhd_ret The result if a reply is queued for MHD
* @return true on success, false on failure, with a reply already queued for MHD * @return true on success, false on failure, with a reply already queued for MHD
*/ */
@ -315,7 +315,7 @@ EXIT:
* @param connection HTTP-connection to the client * @param connection HTTP-connection to the client
* @param ksh The handle to the current state of (denomination) keys in the exchange * @param ksh The handle to the current state of (denomination) keys in the exchange
* @param denom_h Hash of the denomination key to check * @param denom_h Hash of the denomination key to check
* @param[out] dk On success, will contain the denomination key details * @param[out] pdk On success, will contain the denomination key details
* @param[out] result On failure, an MHD-response will be qeued and result will be set to accordingly * @param[out] result On failure, an MHD-response will be qeued and result will be set to accordingly
* @return true on success (denomination valid), false otherwise * @return true on success (denomination valid), false otherwise
*/ */
@ -402,7 +402,7 @@ denomination_is_valid (
* *
* @param connection The HTTP connection to the client * @param connection The HTTP connection to the client
* @param len The lengths of the array @a denoms_h * @param len The lengths of the array @a denoms_h
* @param denoms_h array of hashes of denomination public keys * @param denom_hs array of hashes of denomination public keys
* @param coin_evs array of blinded coin planchets * @param coin_evs array of blinded coin planchets
* @param[out] denom_serials On success, will be filled with the serial-id's of the denomination keys. Caller must deallocate. * @param[out] denom_serials On success, will be filled with the serial-id's of the denomination keys. Caller must deallocate.
* @param[out] amount_with_fee On succes, will contain the committed amount including fees * @param[out] amount_with_fee On succes, will contain the committed amount including fees
@ -511,8 +511,7 @@ static enum GNUNET_GenericReturnValue
verify_reserve_signature ( verify_reserve_signature (
struct MHD_Connection *connection, struct MHD_Connection *connection,
const struct TALER_EXCHANGEDB_AgeWithdraw *commitment, const struct TALER_EXCHANGEDB_AgeWithdraw *commitment,
enum MHD_Result *mhd_ret enum MHD_Result *mhd_ret)
)
{ {
TEH_METRICS_num_verifications[TEH_MT_SIGNATURE_EDDSA]++; TEH_METRICS_num_verifications[TEH_MT_SIGNATURE_EDDSA]++;
@ -824,10 +823,7 @@ age_withdraw_transaction (void *cls,
* 2.) age withdraw was successful. * 2.) age withdraw was successful.
* *
* @param connection HTTP-connection to the client * @param connection HTTP-connection to the client
* @param h_commitment Original commitment * @param awc The context for the current age withdraw request
* @param num_coins Number of coins
* @param coin_evs The Hashes of the undisclosed, blinded coins, @a num_coins many
* @param denom_keys The array of denomination keys, @a num_coins. Needed to detect Clause-Schnorr-based denominations
* @param[out] result On error, a HTTP-response will be queued and result set accordingly * @param[out] result On error, a HTTP-response will be queued and result set accordingly
* @return GNUNET_OK on success, GNUNET_SYSERR otherwise * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
*/ */

View File

@ -81,8 +81,6 @@ struct AgeRevealContext
* memory for those. * memory for those.
* *
* @param connection The MHD connection to handle * @param connection The MHD connection to handle
* @param j_denoms_h Array of hashes of the denominations for the withdrawal, in JSON format
* @param j_coin_evs The blinded envelopes in JSON format for the coins that are not revealed and will be signed on success
* @param j_disclosed_coin_secrets The n*(kappa-1) disclosed coins' private keys in JSON format, from which all other attributes (age restriction, blinding, nonce) will be derived from * @param j_disclosed_coin_secrets The n*(kappa-1) disclosed coins' private keys in JSON format, from which all other attributes (age restriction, blinding, nonce) will be derived from
* @param[out] actx The context of the operation, only partially built at call time * @param[out] actx The context of the operation, only partially built at call time
* @param[out] mhd_ret The result if a reply is queued for MHD * @param[out] mhd_ret The result if a reply is queued for MHD
@ -235,11 +233,11 @@ find_original_commitment (
* @brief Derives a age-restricted planchet from a given secret and calculates the hash * @brief Derives a age-restricted planchet from a given secret and calculates the hash
* *
* @param connection Connection to the client * @param connection Connection to the client
* @param ksh The denomination keys in memory * @param keys The denomination keys in memory
* @param secret The secret to a planchet * @param secret The secret to a planchet
* @param denom_pub_h The hash of the denomination for the planchet * @param denom_pub_h The hash of the denomination for the planchet
* @param max_age The maximum age allowed * @param max_age The maximum age allowed
* @param[out] hc Hashcode to write * @param[out] bch Hashcode to write
* @param[out] result On error, a HTTP-response will be queued and result set accordingly * @param[out] result On error, a HTTP-response will be queued and result set accordingly
* @return GNUNET_OK on success, GNUNET_SYSERR otherwise, with an error message * @return GNUNET_OK on success, GNUNET_SYSERR otherwise, with an error message
* written to the client and @e result set. * written to the client and @e result set.

View File

@ -2825,7 +2825,7 @@ typedef void
* *
* @param curl_ctx The curl context * @param curl_ctx The curl context
* @param exchange_url The base url of the exchange * @param exchange_url The base url of the exchange
* @parm keys The denomination keys from the exchange * @param keys The denomination keys from the exchange
* @param reserve_priv The pivate key to the reserve * @param reserve_priv The pivate key to the reserve
* @param num_coins The number of elements in @e coin_inputs * @param num_coins The number of elements in @e coin_inputs
* @param coin_inputs The input for the coins to withdraw * @param coin_inputs The input for the coins to withdraw
@ -2842,8 +2842,8 @@ TALER_EXCHANGE_age_withdraw (
struct TALER_EXCHANGE_Keys *keys, struct TALER_EXCHANGE_Keys *keys,
const struct TALER_ReservePrivateKeyP *reserve_priv, const struct TALER_ReservePrivateKeyP *reserve_priv,
size_t num_coins, size_t num_coins,
const struct TALER_EXCHANGE_AgeWithdrawCoinInput coin_inputs[ const struct TALER_EXCHANGE_AgeWithdrawCoinInput coin_inputs[const static
const static num_coins], num_coins],
uint8_t max_age, uint8_t max_age,
TALER_EXCHANGE_AgeWithdrawCallback res_cb, TALER_EXCHANGE_AgeWithdrawCallback res_cb,
void *res_cb_cls); void *res_cb_cls);
@ -3144,7 +3144,6 @@ struct TALER_EXCHANGE_RefreshesRevealHandle;
* *
* @param ctx curl context * @param ctx curl context
* @param url exchange base URL * @param url exchange base URL
* @param keys exchange keys
* @param rms the fresh secret that defines the refresh operation * @param rms the fresh secret that defines the refresh operation
* @param rd the refresh data that characterizes the refresh operation * @param rd the refresh data that characterizes the refresh operation
* @param num_coins number of fresh coins to be created, length of the @a exchange_vals array, must match value in @a rd * @param num_coins number of fresh coins to be created, length of the @a exchange_vals array, must match value in @a rd

View File

@ -2210,6 +2210,7 @@ TALER_TESTING_cmd_proof_kyc_oauth2 (
* KYC processes which also provides a @a birthdate in a response * KYC processes which also provides a @a birthdate in a response
* *
* @param label command label * @param label command label
* @param birthdate fixed birthdate, such as "2022-03-04", "2022-03-00", "2022-00-00"
* @param port the TCP port to listen on * @param port the TCP port to listen on
*/ */
struct TALER_TESTING_Command struct TALER_TESTING_Command
@ -2463,6 +2464,30 @@ TALER_TESTING_cmd_check_aml_decisions (
unsigned int expected_http_status); unsigned int expected_http_status);
/* ****************** convenience functions ************** */
/**
* Get exchange URL from interpreter. Convenience function.
*
* @param is interpreter state.
* @return the exchange URL, or NULL on error
*/
const char *
TALER_TESTING_get_exchange_url (
struct TALER_TESTING_Interpreter *is);
/**
* Get exchange keys from interpreter. Convenience function.
*
* @param is interpreter state.
* @return the exchange keys, or NULL on error
*/
struct TALER_EXCHANGE_Keys *
TALER_TESTING_get_keys (
struct TALER_TESTING_Interpreter *is);
/* *** Generic trait logic for implementing traits ********* */ /* *** Generic trait logic for implementing traits ********* */
@ -2702,28 +2727,4 @@ TALER_TESTING_SIMPLE_TRAITS (TALER_TESTING_MAKE_DECL_SIMPLE_TRAIT)
TALER_TESTING_INDEXED_TRAITS (TALER_TESTING_MAKE_DECL_INDEXED_TRAIT) TALER_TESTING_INDEXED_TRAITS (TALER_TESTING_MAKE_DECL_INDEXED_TRAIT)
/* ****************** convenience functions ************** */
/**
* Get exchange URL from interpreter. Convenience function.
*
* @param is interpreter state.
* @return the exchange URL, or NULL on error
*/
const char *
TALER_TESTING_get_exchange_url (
struct TALER_TESTING_Interpreter *is);
/**
* Get exchange keys from interpreter. Convenience function.
*
* @param is interpreter state.
* @return the exchange keys, or NULL on error
*/
struct TALER_EXCHANGE_Keys *
TALER_TESTING_get_keys (
struct TALER_TESTING_Interpreter *is);
#endif #endif

View File

@ -95,7 +95,7 @@ struct TALER_AUDITOR_GetConfigHandle
* in the @a key_data. * in the @a key_data.
* *
* @param[in] resp_obj JSON object to parse * @param[in] resp_obj JSON object to parse
* @param[in,out] auditor where to store the results we decoded * @param[in,out] vi where to store the results we decoded
* @param[out] vc where to store config compatibility data * @param[out] vc where to store config compatibility data
* @return #TALER_EC_NONE on success * @return #TALER_EC_NONE on success
*/ */

View File

@ -382,7 +382,8 @@ reserve_age_withdraw_payment_required (
* HTTP /reserves/$RESERVE_PUB/age-withdraw request. * HTTP /reserves/$RESERVE_PUB/age-withdraw request.
* *
* @param cls the `struct TALER_EXCHANGE_AgeWithdrawHandle` * @param cls the `struct TALER_EXCHANGE_AgeWithdrawHandle`
* @param aw2r response data * @param response_code The HTTP response code
* @param response response data
*/ */
static void static void
handle_reserve_age_withdraw_finished ( handle_reserve_age_withdraw_finished (
@ -651,6 +652,7 @@ ERROR:
* Prepares the request URL for the age-withdraw request * Prepares the request URL for the age-withdraw request
* *
* @param awh The handler * @param awh The handler
* @param exchange_url The base-URL to the exchange
*/ */
static static
enum GNUNET_GenericReturnValue enum GNUNET_GenericReturnValue

View File

@ -120,10 +120,8 @@ do_retry (void *cls)
/** /**
* Callback to analyze the /exchanges response. * Callback to analyze the /exchanges response.
* *
* @param cls closure. * @param cls closure of type struct ExchangesState*
* @param hr HTTP response details * @param ler Response to the GET /exchanges request
* @param num_exchanges length of the @a ei array
* @param ei array with information about the exchanges
*/ */
static void static void
exchanges_cb (void *cls, exchanges_cb (void *cls,