fix misc doxygen issues

This commit is contained in:
Christian Grothoff 2017-04-20 07:49:56 +02:00
parent b0811dd868
commit 487237381d
No known key found for this signature in database
GPG Key ID: 939E6BE1E29FC3CC
35 changed files with 55 additions and 61 deletions

View File

@ -205,7 +205,8 @@ report_reserve_inconsistency (const struct TALER_ReservePublicKeyP *reserve_pub,
/** /**
* Report a global inconsistency with respect to a wire transfer. * Report a global inconsistency with respect to a wire transfer.
* *
* @param reserve_pub the affected reserve * @param destination wire transfer target account
* @param rowid which row is the inconsitency in
* @param expected expected amount * @param expected expected amount
* @param observed observed amount * @param observed observed amount
* @param diagnostic message explaining what @a expected and @a observed refer to * @param diagnostic message explaining what @a expected and @a observed refer to
@ -509,7 +510,7 @@ struct ReserveSummary
* The "total_in" and "total_out" amounts of @a rs must already be * The "total_in" and "total_out" amounts of @a rs must already be
* initialized (so we can determine the currency). * initialized (so we can determine the currency).
* *
* @param[in|out] rs reserve summary to (fully) initialize * @param[in,out] rs reserve summary to (fully) initialize
* @return #GNUNET_OK on success, #GNUNET_SYSERR on DB errors * @return #GNUNET_OK on success, #GNUNET_SYSERR on DB errors
*/ */
static int static int
@ -2241,7 +2242,7 @@ check_wire_out_cb (void *cls,
* Analyze the exchange aggregator's payment processing. * Analyze the exchange aggregator's payment processing.
* *
* @param cls closure * @param cls closure
* @param int #GNUNET_OK on success, #GNUNET_SYSERR on hard errors * @return #GNUNET_OK on success, #GNUNET_SYSERR on hard errors
*/ */
static int static int
analyze_aggregations (void *cls) analyze_aggregations (void *cls)
@ -2500,7 +2501,7 @@ get_denomination_summary (struct CoinContext *cc,
* denomination. Also remove and free the memory of @a value. * denomination. Also remove and free the memory of @a value.
* *
* @param cls the `struct CoinContext` * @param cls the `struct CoinContext`
* @param key the hash of the denomination key * @param denom_hash the hash of the denomination key
* @param value a `struct DenominationSummary` * @param value a `struct DenominationSummary`
* @return #GNUNET_OK (continue to iterate) * @return #GNUNET_OK (continue to iterate)
*/ */
@ -2975,9 +2976,6 @@ refresh_session_cb (void *cls,
* Function called with details about deposits that have been made, * Function called with details about deposits that have been made,
* with the goal of auditing the deposit's execution. * with the goal of auditing the deposit's execution.
* *
* As a side-effect, #get_coin_summary will report
* inconsistencies in the deposited coin's balance.
*
* @param cls closure * @param cls closure
* @param rowid unique serial ID for the deposit in our DB * @param rowid unique serial ID for the deposit in our DB
* @param timestamp when did the deposit happen * @param timestamp when did the deposit happen
@ -3118,9 +3116,6 @@ deposit_cb (void *cls,
* refunded amount back to the outstanding balance of the respective * refunded amount back to the outstanding balance of the respective
* denomination. * denomination.
* *
* As a side-effect, #get_coin_summary will report
* inconsistencies in the refunded coin's balance.
*
* @param cls closure * @param cls closure
* @param rowid unique serial ID for the refund in our DB * @param rowid unique serial ID for the refund in our DB
* @param denom_pub denomination public key of @a coin_pub * @param denom_pub denomination public key of @a coin_pub
@ -3263,7 +3258,7 @@ refund_cb (void *cls,
* Analyze the exchange's processing of coins. * Analyze the exchange's processing of coins.
* *
* @param cls closure * @param cls closure
* @param int #GNUNET_OK on success, #GNUNET_SYSERR on hard errors * @return #GNUNET_OK on success, #GNUNET_SYSERR on hard errors
*/ */
static int static int
analyze_coins (void *cls) analyze_coins (void *cls)

View File

@ -166,7 +166,6 @@ handle_admin_add_incoming_finished (void *cls,
* @param exchange_base_url base URL of the exchange (for tracking) * @param exchange_base_url base URL of the exchange (for tracking)
* @param wtid wire transfer identifier for the transfer * @param wtid wire transfer identifier for the transfer
* @param amount amount that was deposited * @param amount amount that was deposited
* @param execution_date when did we receive the amount
* @param debit_account_no account number to withdraw from (53 bits at most) * @param debit_account_no account number to withdraw from (53 bits at most)
* @param credit_account_no account number to deposit into (53 bits at most) * @param credit_account_no account number to deposit into (53 bits at most)
* @param res_cb the callback to call when the final result for this request is available * @param res_cb the callback to call when the final result for this request is available

View File

@ -109,7 +109,7 @@ struct TALER_FAKEBANK_Handle
* @param h bank instance * @param h bank instance
* @param want_amount transfer amount desired * @param want_amount transfer amount desired
* @param want_debit account that should have been debited * @param want_debit account that should have been debited
* @param want_debit account that should have been credited * @param want_credit account that should have been credited
* @param exchange_base_url expected base URL of the exchange * @param exchange_base_url expected base URL of the exchange
* i.e. "https://example.com/"; may include a port * i.e. "https://example.com/"; may include a port
* @param[out] wtid set to the wire transfer identifier * @param[out] wtid set to the wire transfer identifier

View File

@ -390,13 +390,13 @@ static char *currency;
static struct GNUNET_TIME_Absolute start_time; static struct GNUNET_TIME_Absolute start_time;
/** /**
* Number of times #bennchmark_run has executed. Used * Number of times #benchmark_run has executed. Used
* to indicate when we consider us warm. * to indicate when we consider us warm.
*/ */
static unsigned long long warm; static unsigned long long warm;
/** /**
* Number of times #bennchmark_run should execute * Number of times #benchmark_run should execute
* before we shut down. * before we shut down.
*/ */
static unsigned int num_iterations; static unsigned int num_iterations;
@ -425,7 +425,7 @@ static unsigned long long num_admin;
/** /**
* Throw a weighted coin with @a probability. * Throw a weighted coin with @a probability.
* *
* @reurn #GNUNET_OK with @a probability, #GNUNET_NO with 1 - @a probability * @return #GNUNET_OK with @a probability, #GNUNET_NO with 1 - @a probability
*/ */
static unsigned int static unsigned int
eval_probability (float probability) eval_probability (float probability)

View File

@ -784,15 +784,15 @@ MAH_handle_is_ready (struct TALER_EXCHANGE_Handle *h)
/** /**
* Obtain the URL to use for an API request. * Obtain the URL to use for an API request.
* *
* @param base_url base URL of the exchange (i.e. "http://exchange/") * @param h handle for the exchange
* @param path Taler API path (i.e. "/reserve/withdraw") * @param path Taler API path (i.e. "/reserve/withdraw")
* @return the full URI to use with cURL * @return the full URI to use with cURL
*/ */
char * char *
MAH_path_to_url (struct TALER_EXCHANGE_Handle *exchange, MAH_path_to_url (struct TALER_EXCHANGE_Handle *h,
const char *path) const char *path)
{ {
return MAH_path_to_url2 (exchange->url, return MAH_path_to_url2 (h->url,
path); path);
} }

View File

@ -55,6 +55,7 @@ char *
MAH_path_to_url (struct TALER_EXCHANGE_Handle *h, MAH_path_to_url (struct TALER_EXCHANGE_Handle *h,
const char *path); const char *path);
/** /**
* Obtain the URL to use for an API request. * Obtain the URL to use for an API request.
* *

View File

@ -605,10 +605,10 @@ TALER_EXCHANGE_reserve_status (struct TALER_EXCHANGE_Handle *exchange,
/** /**
* Cancel a withdraw status request. This function cannot be used * Cancel a reserve status request. This function cannot be used
* on a request handle if a response is already served for it. * on a request handle if a response is already served for it.
* *
* @param rsh the withdraw status request handle * @param rsh the reserve status request handle
*/ */
void void
TALER_EXCHANGE_reserve_status_cancel (struct TALER_EXCHANGE_ReserveStatusHandle *rsh) TALER_EXCHANGE_reserve_status_cancel (struct TALER_EXCHANGE_ReserveStatusHandle *rsh)

View File

@ -877,7 +877,7 @@ exchange_keys_update_denomkeys ()
/** /**
* Sign @a af with @a priv * Sign @a af with @a priv
* *
* @param[in|out] af fee structure to sign * @param[in,out] af fee structure to sign
* @param wireplugin name of the plugin for which we sign * @param wireplugin name of the plugin for which we sign
* @param priv private key to use for signing * @param priv private key to use for signing
*/ */

View File

@ -59,7 +59,7 @@ static int global_ret;
* @param cls closure * @param cls closure
* @param args remaining command-line arguments * @param args remaining command-line arguments
* @param cfgfile name of the configuration file used (for saving, can be NULL!) * @param cfgfile name of the configuration file used (for saving, can be NULL!)
* @param c configuration * @param cfg configuration
*/ */
static void static void
run (void *cls, run (void *cls,

View File

@ -1117,7 +1117,6 @@ wire_prepare_cb (void *cls,
* do. * do.
* *
* @param cls NULL * @param cls NULL
* @param tc scheduler context
*/ */
static void static void
run_transfers (void *cls) run_transfers (void *cls)

View File

@ -477,8 +477,8 @@ handle_mhd_admin_request (void *cls,
* Parse the configuration to determine on which port * Parse the configuration to determine on which port
* or UNIX domain path we should run an HTTP service. * or UNIX domain path we should run an HTTP service.
* *
* @param type section of the configuration to parse ("exchange" or "exchange-admin") * @param section section of the configuration to parse ("exchange" or "exchange-admin")
* @param[out] port set to the port number, or 0 for none * @param[out] rport set to the port number, or 0 for none
* @param[out] unix_path set to the UNIX path, or NULL for none * @param[out] unix_path set to the UNIX path, or NULL for none
* @param[out] unix_mode set to the mode to be used for @a unix_path * @param[out] unix_mode set to the mode to be used for @a unix_path
* @return #GNUNET_OK on success * @return #GNUNET_OK on success
@ -594,7 +594,6 @@ parse_port_config (const char *section,
* Load configuration parameters for the exchange * Load configuration parameters for the exchange
* server into the corresponding global variables. * server into the corresponding global variables.
* *
* @param exchange_directory the exchange's directory
* @return #GNUNET_OK on success * @return #GNUNET_OK on success
*/ */
static int static int

View File

@ -654,7 +654,7 @@ TEH_DB_execute_reserve_status (struct MHD_Connection *connection,
* @param blinded_msg_len number of bytes in @a blinded_msg * @param blinded_msg_len number of bytes in @a blinded_msg
* @param h_blind hash of @a blinded_msg * @param h_blind hash of @a blinded_msg
* @param signature signature over the withdraw request, to be stored in DB * @param signature signature over the withdraw request, to be stored in DB
* @param denom_sig[out] where to write the resulting signature * @param[out] denom_sig where to write the resulting signature
* (used to release memory in case of transaction failure * (used to release memory in case of transaction failure
* @return MHD result code * @return MHD result code
*/ */
@ -1967,6 +1967,7 @@ struct WtidTransactionContext
* @param cls our context for transmission * @param cls our context for transmission
* @param rowid which row in the DB is the information from (for diagnostics) * @param rowid which row in the DB is the information from (for diagnostics)
* @param merchant_pub public key of the merchant (should be same for all callbacks with the same @e cls) * @param merchant_pub public key of the merchant (should be same for all callbacks with the same @e cls)
* @param wire_method which wire plugin was used
* @param h_wire hash of wire transfer details of the merchant (should be same for all callbacks with the same @e cls) * @param h_wire hash of wire transfer details of the merchant (should be same for all callbacks with the same @e cls)
* @param exec_time execution time of the wire transfer (should be same for all callbacks with the same @e cls) * @param exec_time execution time of the wire transfer (should be same for all callbacks with the same @e cls)
* @param h_proposal_data which proposal was this payment about * @param h_proposal_data which proposal was this payment about

View File

@ -133,7 +133,7 @@ struct TEH_DB_MeltDetails
* @param session_hash hash code of the session the coins are melted into * @param session_hash hash code of the session the coins are melted into
* @param num_new_denoms number of entries in @a denom_pubs, size of y-dimension of @a commit_coin array * @param num_new_denoms number of entries in @a denom_pubs, size of y-dimension of @a commit_coin array
* @param denom_pubs array of public denomination keys for the refresh (?) * @param denom_pubs array of public denomination keys for the refresh (?)
* @param coin_melt_details signatures and (residual) value of and information about the respective coin to be melted * @param coin_melt_detail signatures and (residual) value of and information about the respective coin to be melted
* @param commit_coin 2d array of coin commitments (what the exchange is to sign * @param commit_coin 2d array of coin commitments (what the exchange is to sign
* once the "/refres/reveal" of cut and choose is done) * once the "/refres/reveal" of cut and choose is done)
* @param transfer_pubs array of transfer public keys (what the exchange is * @param transfer_pubs array of transfer public keys (what the exchange is
@ -146,7 +146,7 @@ TEH_DB_execute_refresh_melt (struct MHD_Connection *connection,
const struct GNUNET_HashCode *session_hash, const struct GNUNET_HashCode *session_hash,
unsigned int num_new_denoms, unsigned int num_new_denoms,
const struct TALER_DenominationPublicKey *denom_pubs, const struct TALER_DenominationPublicKey *denom_pubs,
const struct TEH_DB_MeltDetails *coin_melt_details, const struct TEH_DB_MeltDetails *coin_melt_detail,
struct TALER_EXCHANGEDB_RefreshCommitCoin *const* commit_coin, struct TALER_EXCHANGEDB_RefreshCommitCoin *const* commit_coin,
const struct TALER_TransferPublicKeyP *transfer_pubs); const struct TALER_TransferPublicKeyP *transfer_pubs);

View File

@ -141,7 +141,7 @@ verify_and_execute_payback (struct MHD_Connection *connection,
/** /**
* Handle a "/payback" request. Parses the JSON, and, if successful, * Handle a "/payback" request. Parses the JSON, and, if successful,
* passes the JSON data to #parse_and_handle_payback_request() to * passes the JSON data to #verify_and_execute_payback() to
* further check the details of the operation specified. If * further check the details of the operation specified. If
* everything checks out, this will ultimately lead to the "/refund" * everything checks out, this will ultimately lead to the "/refund"
* being executed, or rejected. * being executed, or rejected.

View File

@ -28,7 +28,7 @@
/** /**
* Handle a "/payback" request. Parses the JSON, and, if successful, * Handle a "/payback" request. Parses the JSON, and, if successful,
* passes the JSON data to #parse_and_handle_payback_request() to * passes the JSON data to #verify_and_execute_payback() to
* further check the details of the operation specified. If * further check the details of the operation specified. If
* everything checks out, this will ultimately lead to the "/refund" * everything checks out, this will ultimately lead to the "/refund"
* being executed, or rejected. * being executed, or rejected.

View File

@ -97,7 +97,7 @@ verify_and_execute_refund (struct MHD_Connection *connection,
/** /**
* Handle a "/refund" request. Parses the JSON, and, if successful, * Handle a "/refund" request. Parses the JSON, and, if successful,
* passes the JSON data to #parse_and_handle_refund_request() to * passes the JSON data to #verify_and_execute_refund() to
* further check the details of the operation specified. If * further check the details of the operation specified. If
* everything checks out, this will ultimately lead to the "/refund" * everything checks out, this will ultimately lead to the "/refund"
* being executed, or rejected. * being executed, or rejected.

View File

@ -30,7 +30,7 @@
/** /**
* Handle a "/refund" request. Parses the JSON, and, if successful, * Handle a "/refund" request. Parses the JSON, and, if successful,
* passes the JSON data to #parse_and_handle_refund_request() to * passes the JSON data to #verify_and_execute_refund() to
* further check the details of the operation specified. If * further check the details of the operation specified. If
* everything checks out, this will ultimately lead to the "/refund" * everything checks out, this will ultimately lead to the "/refund"
* being executed, or rejected. * being executed, or rejected.

View File

@ -80,7 +80,7 @@ TEH_RESPONSE_can_compress (struct MHD_Connection *connection)
/** /**
* Try to compress a response body. Updates @a buf and @buf_size. * Try to compress a response body. Updates @a buf and @a buf_size.
* *
* @param[in,out] buf pointer to body to compress * @param[in,out] buf pointer to body to compress
* @param[in,out] buf_size pointer to initial size of @a buf * @param[in,out] buf_size pointer to initial size of @a buf

View File

@ -46,7 +46,7 @@ TEH_RESPONSE_add_global_headers (struct MHD_Response *response);
/** /**
* Try to compress a response body. Updates @a buf and @buf_size. * Try to compress a response body. Updates @a buf and @a buf_size.
* *
* @param[in,out] buf pointer to body to compress * @param[in,out] buf pointer to body to compress
* @param[in,out] buf_size pointer to initial size of @a buf * @param[in,out] buf_size pointer to initial size of @a buf

View File

@ -165,7 +165,7 @@ TEH_VALIDATION_done ()
* *
* @param wire the JSON wire format object * @param wire the JSON wire format object
* @param ours #GNUNET_YES if the signature should match our master key * @param ours #GNUNET_YES if the signature should match our master key
* @param[OUT] emsg set to error message if we return an error code * @param[out] emsg set to error message if we return an error code
* @return #TALER_EC_NONE if correctly formatted; otherwise error code * @return #TALER_EC_NONE if correctly formatted; otherwise error code
*/ */
enum TALER_ErrorCode enum TALER_ErrorCode

View File

@ -48,7 +48,7 @@ TEH_VALIDATION_done (void);
* *
* @param wire the JSON wire format object * @param wire the JSON wire format object
* @param ours #GNUNET_YES if the signature should match our master key * @param ours #GNUNET_YES if the signature should match our master key
* @param[OUT] emsg set to error message if we return an error code * @param[out] emsg set to error message if we return an error code
* @return #TALER_EC_NONE if correctly formatted; otherwise error code * @return #TALER_EC_NONE if correctly formatted; otherwise error code
*/ */
enum TALER_ErrorCode enum TALER_ErrorCode

View File

@ -117,6 +117,7 @@ TALER_EXCHANGEDB_signing_keys_iterate (const char *exchange_base_dir,
* Obtain the name of the directory we use to store signing * Obtain the name of the directory we use to store signing
* keys created at time @a start. * keys created at time @a start.
* *
* @param exchange_directory base director where we store key material
* @param start time at which we create the signing key * @param start time at which we create the signing key
* @return name of the directory we should use, basically "$EXCHANGEDIR/$TIME/"; * @return name of the directory we should use, basically "$EXCHANGEDIR/$TIME/";
* (valid until next call to this function) * (valid until next call to this function)

View File

@ -2762,7 +2762,7 @@ postgres_have_deposit (void *cls,
* *
* @param cls the @e cls of this struct with the plugin-specific state * @param cls the @e cls of this struct with the plugin-specific state
* @param session connection to the database * @param session connection to the database
* @param deposit_serial_id identifies the deposit row to modify * @param rowid identifies the deposit row to modify
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/ */
static int static int
@ -2867,7 +2867,7 @@ postgres_test_deposit_done (void *cls,
* *
* @param cls the @e cls of this struct with the plugin-specific state * @param cls the @e cls of this struct with the plugin-specific state
* @param session connection to the database * @param session connection to the database
* @param deposit_serial_id identifies the deposit row to modify * @param rowid identifies the deposit row to modify
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/ */
static int static int
@ -6131,8 +6131,7 @@ postgres_select_reserve_closed_above_serial_id (void *cls,
* @param coin_sig signature of the coin of type #TALER_SIGNATURE_WALLET_COIN_PAYBACK * @param coin_sig signature of the coin of type #TALER_SIGNATURE_WALLET_COIN_PAYBACK
* @param coin_blind blinding key of the coin * @param coin_blind blinding key of the coin
* @param amount total amount to be paid back * @param amount total amount to be paid back
* @param receiver_account_details who should receive the funds * @param h_blind_ev hash of the blinded coin's envelope (must match reserves_out entry)
* @parma h_blind_ev hash of the blinded coin's envelope (must match reserves_out entry)
* @param timestamp current time (rounded) * @param timestamp current time (rounded)
* @return #GNUNET_OK on success, * @return #GNUNET_OK on success,
* #GNUNET_SYSERR on DB errors * #GNUNET_SYSERR on DB errors

View File

@ -61,7 +61,6 @@ typedef void
* @param exchange_base_url base URL of the exchange (for tracking) * @param exchange_base_url base URL of the exchange (for tracking)
* @param wtid wire transfer identifier for the transfer * @param wtid wire transfer identifier for the transfer
* @param amount amount that was deposited * @param amount amount that was deposited
* @param execution_date when did we receive the amount
* @param debit_account_no account number to withdraw from (53 bits at most) * @param debit_account_no account number to withdraw from (53 bits at most)
* @param credit_account_no account number to deposit into (53 bits at most) * @param credit_account_no account number to deposit into (53 bits at most)
* @param res_cb the callback to call when the final result for this request is available * @param res_cb the callback to call when the final result for this request is available

View File

@ -495,7 +495,7 @@ TALER_link_derive_transfer_secret (const struct TALER_CoinSpendPrivateKeyP *coin
* *
* @param trans_priv transfer private key * @param trans_priv transfer private key
* @param coin_pub coin public key * @param coin_pub coin public key
* @param[out] secret set to the shared secret * @param[out] transfer_secret set to the shared secret
*/ */
void void
TALER_link_reveal_transfer_secret (const struct TALER_TransferPrivateKeyP *trans_priv, TALER_link_reveal_transfer_secret (const struct TALER_TransferPrivateKeyP *trans_priv,
@ -510,7 +510,7 @@ TALER_link_reveal_transfer_secret (const struct TALER_TransferPrivateKeyP *trans
* *
* @param trans_pub transfer private key * @param trans_pub transfer private key
* @param coin_priv coin public key * @param coin_priv coin public key
* @param[out] secret set to the shared secret * @param[out] transfer_secret set to the shared secret
*/ */
void void
TALER_link_recover_transfer_secret (const struct TALER_TransferPublicKeyP *trans_pub, TALER_link_recover_transfer_secret (const struct TALER_TransferPublicKeyP *trans_pub,

View File

@ -837,13 +837,13 @@ TALER_EXCHANGE_reserve_status (struct TALER_EXCHANGE_Handle *exchange,
/** /**
* Cancel a withdraw status request. This function cannot be used * Cancel a reserve status request. This function cannot be used
* on a request handle if a response is already served for it. * on a request handle if a response is already served for it.
* *
* @param wsh the withdraw status request handle * @param rsh the reserve status request handle
*/ */
void void
TALER_EXCHANGE_reserve_status_cancel (struct TALER_EXCHANGE_ReserveStatusHandle *wsh); TALER_EXCHANGE_reserve_status_cancel (struct TALER_EXCHANGE_ReserveStatusHandle *rsh);
/* ********************* /reserve/withdraw *********************** */ /* ********************* /reserve/withdraw *********************** */

View File

@ -2093,7 +2093,7 @@ struct TALER_EXCHANGEDB_Plugin
* @param h_blind_ev blinded envelope, as calculated by the exchange * @param h_blind_ev blinded envelope, as calculated by the exchange
* @param amount total amount to be paid back * @param amount total amount to be paid back
* @param receiver_account_details who should receive the funds * @param receiver_account_details who should receive the funds
* @parma h_blind_ev hash of the blinded coin's envelope (must match reserves_out entry) * @param h_blind_ev hash of the blinded coin's envelope (must match reserves_out entry)
* @param now timestamp to store * @param now timestamp to store
* @return #GNUNET_OK on success, * @return #GNUNET_OK on success,
* #GNUNET_SYSERR on DB errors * #GNUNET_SYSERR on DB errors

View File

@ -15,7 +15,7 @@
*/ */
/** /**
* @file bank-lib/fakebank.h * @file include/taler_fakebank_lib.h
* @brief API for a library that fakes being a Taler bank * @brief API for a library that fakes being a Taler bank
* @author Christian Grothoff <christian@grothoff.org> * @author Christian Grothoff <christian@grothoff.org>
*/ */

View File

@ -82,6 +82,7 @@ TALER_gcrypt_init (void);
/** /**
* Obtain denomination amount from configuration file. * Obtain denomination amount from configuration file.
* *
* @param cfg configuration to parse
* @param section section of the configuration to access * @param section section of the configuration to access
* @param option option of the configuration to access * @param option option of the configuration to access
* @param[out] denom set to the amount found in configuration * @param[out] denom set to the amount found in configuration

View File

@ -138,7 +138,7 @@ struct TALER_WIRE_Plugin
* @param cls the @e cls of this struct with the plugin-specific state * @param cls the @e cls of this struct with the plugin-specific state
* @param wire the JSON wire format object * @param wire the JSON wire format object
* @param master_pub public key of the exchange to verify against * @param master_pub public key of the exchange to verify against
* @param[OUT] emsg set to an error message, unless we return #TALER_EC_NONE; * @param[out] emsg set to an error message, unless we return #TALER_EC_NONE;
* error message must be freed by the caller using GNUNET_free() * error message must be freed by the caller using GNUNET_free()
* @return #TALER_EC_NONE if correctly formatted * @return #TALER_EC_NONE if correctly formatted
*/ */

View File

@ -132,7 +132,7 @@ extract_amount_nbo_helper (PGresult *result,
* *
* @param cls closure * @param cls closure
* @param result where to extract data from * @param result where to extract data from
* @param int row to extract data from * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from * @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL * @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result * @param[out] dst where to store the result
@ -200,7 +200,7 @@ TALER_PQ_result_spec_amount_nbo (const char *name,
* *
* @param cls closure * @param cls closure
* @param result where to extract data from * @param result where to extract data from
* @param int row to extract data from * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from * @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL * @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result * @param[out] dst where to store the result
@ -272,7 +272,7 @@ TALER_PQ_result_spec_amount (const char *name,
* *
* @param cls closure * @param cls closure
* @param result where to extract data from * @param result where to extract data from
* @param int row to extract data from * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from * @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL * @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result * @param[out] dst where to store the result

View File

@ -136,7 +136,7 @@ TALER_link_derive_transfer_secret (const struct TALER_CoinSpendPrivateKeyP *coin
* *
* @param trans_priv transfer private key * @param trans_priv transfer private key
* @param coin_pub coin public key * @param coin_pub coin public key
* @param[out] secret set to the shared secret * @param[out] transfer_secret set to the shared secret
*/ */
void void
TALER_link_reveal_transfer_secret (const struct TALER_TransferPrivateKeyP *trans_priv, TALER_link_reveal_transfer_secret (const struct TALER_TransferPrivateKeyP *trans_priv,
@ -156,7 +156,7 @@ TALER_link_reveal_transfer_secret (const struct TALER_TransferPrivateKeyP *trans
* *
* @param trans_pub transfer private key * @param trans_pub transfer private key
* @param coin_priv coin public key * @param coin_priv coin public key
* @param[out] secret set to the shared secret * @param[out] transfer_secret set to the shared secret
*/ */
void void
TALER_link_recover_transfer_secret (const struct TALER_TransferPublicKeyP *trans_pub, TALER_link_recover_transfer_secret (const struct TALER_TransferPublicKeyP *trans_pub,

View File

@ -357,7 +357,7 @@ validate_iban (const char *iban)
* @param sepa_name name of the account holder * @param sepa_name name of the account holder
* @param iban bank account number in IBAN format * @param iban bank account number in IBAN format
* @param bic bank identifier * @param bic bank identifier
* @param[out] mp purpose to be signed * @param[out] wsd purpose to be signed
*/ */
static void static void
compute_purpose (const char *sepa_name, compute_purpose (const char *sepa_name,
@ -451,7 +451,7 @@ verify_wire_sepa_signature_ok (const json_t *json,
* @param cls the @e cls of this struct with the plugin-specific state * @param cls the @e cls of this struct with the plugin-specific state
* @param wire the JSON wire format object * @param wire the JSON wire format object
* @param master_pub public key of the exchange to verify against * @param master_pub public key of the exchange to verify against
* @param[OUT] emsg set to an error message, unless we return #TALER_EC_NONE; * @param[out] emsg set to an error message, unless we return #TALER_EC_NONE;
* error message must be freed by the caller using GNUNET_free() * error message must be freed by the caller using GNUNET_free()
* @return #TALER_EC_NONE if correctly formatted * @return #TALER_EC_NONE if correctly formatted
*/ */

View File

@ -98,7 +98,7 @@ template_get_wire_details (void *cls,
* @param cls the @e cls of this struct with the plugin-specific state * @param cls the @e cls of this struct with the plugin-specific state
* @param wire the JSON wire format object * @param wire the JSON wire format object
* @param master_pub public key of the exchange to verify against * @param master_pub public key of the exchange to verify against
* @param[OUT] emsg set to an error message, unless we return #TALER_EC_NONE; * @param[out] emsg set to an error message, unless we return #TALER_EC_NONE;
* error message must be freed by the caller using GNUNET_free() * error message must be freed by the caller using GNUNET_free()
* @return #TALER_EC_NONE if correctly formatted * @return #TALER_EC_NONE if correctly formatted
*/ */

View File

@ -183,7 +183,7 @@ test_amount_round (void *cls,
* *
* @param account number of the account * @param account number of the account
* @param bank_uri URI of the bank * @param bank_uri URI of the bank
* @param[out] mp purpose to be signed * @param[out] wsd purpose to be signed
*/ */
static void static void
compute_purpose (uint64_t account, compute_purpose (uint64_t account,
@ -218,7 +218,7 @@ compute_purpose (uint64_t account,
* @param cls the @e cls of this struct with the plugin-specific state * @param cls the @e cls of this struct with the plugin-specific state
* @param wire the JSON wire format object * @param wire the JSON wire format object
* @param master_pub public key of the exchange to verify against * @param master_pub public key of the exchange to verify against
* @param[OUT] emsg set to an error message, unless we return #TALER_EC_NONE; * @param[out] emsg set to an error message, unless we return #TALER_EC_NONE;
* error message must be freed by the caller using GNUNET_free() * error message must be freed by the caller using GNUNET_free()
* @return #TALER_EC_NONE if correctly formatted * @return #TALER_EC_NONE if correctly formatted
*/ */