doxygen work

This commit is contained in:
Christian Grothoff 2020-01-18 13:23:10 +01:00
parent dac255329f
commit 9317d6d69d
No known key found for this signature in database
GPG Key ID: 939E6BE1E29FC3CC
18 changed files with 31 additions and 45 deletions

View File

@ -3320,7 +3320,7 @@ get_refunds_cb (void *cls,
* @param session database handle to use
* @param coin_pub coin to get refunds for
* @param merchant_pub merchant to get refunds for
* @param h_contract_pub contract (hash) to get refunds for
* @param h_contract contract (hash) to get refunds for
* @param cb function to call for each refund found
* @param cb_cls closure for @a cb
* @return query result status
@ -3489,8 +3489,7 @@ postgres_insert_melt (void *cls,
* @param cls the @e cls of this struct with the plugin-specific state
* @param session database connection
* @param rc identify commitment and thus refresh operation
* @param num_rrcs_newcoins number of coins to generate, size of the
* @a rrcs array
* @param num_rrcs number of coins to generate, size of the @a rrcs array
* @param rrcs information about the new coins
* @param num_tprivs number of entries in @a tprivs, should be #TALER_CNC_KAPPA - 1
* @param tprivs transfer private keys to store
@ -6947,7 +6946,7 @@ postgres_get_reserve_by_h_blind (void *cls,
* @param cls closure
* @param session a session
* @param h_blind_ev hash of the blinded coin
* @param[out] reserve_pub set to information about the reserve (on success only)
* @param[out] old_coin_pub set to information about the old coin (on success only)
* @return transaction status code
*/
static enum GNUNET_DB_QueryStatus

View File

@ -170,8 +170,8 @@ TALER_BANK_admin_add_incoming_cancel (struct
* @param exchange_base_url base URL of this exchange (included in subject
* to facilitate use of tracking API by merchant backend)
* @param wtid wire transfer identifier to use
* @param buf[out] set to transaction data to persist, NULL on error
* @param buf_size[out] set to number of bytes in @a buf, 0 on error
* @param[out] buf set to transaction data to persist, NULL on error
* @param[out] buf_size set to number of bytes in @a buf, 0 on error
*/
void
TALER_BANK_prepare_wire_transfer (const char *destination_account_payto_uri,
@ -469,7 +469,7 @@ TALER_BANK_debit_history_cancel (struct TALER_BANK_DebitHistoryHandle *hh);
*
* @param cfg configuration to parse
* @param section the section with the configuration data
* @param auth[out] set to the configuration data found
* @param[out] auth set to the configuration data found
* @return #GNUNET_OK on success
*/
int

View File

@ -2126,8 +2126,7 @@ struct TALER_EXCHANGEDB_Plugin
* @param cls the @e cls of this struct with the plugin-specific state
* @param session database connection
* @param rc identify commitment and thus refresh operation
* @param num_rrcs_newcoins number of coins to generate, size of the
* @a rrcs array
* @param num_rrcs number of coins to generate, size of the @a rrcs array
* @param rrcs information about the new coins
* @param num_tprivs number of entries in @a tprivs, should be #TALER_CNC_KAPPA - 1
* @param tprivs transfer private keys to store

View File

@ -146,7 +146,7 @@ TALER_JSON_get_error_code2 (const void *data,
* hash is what is put into the contract.
*
* @param wire_s wire details to hash
* @param hc[out] set to the hash
* @param[out] hc set to the hash
* @return #GNUNET_OK on success, #GNUNET_SYSERR if @a wire_s is malformed
*/
int

View File

@ -381,7 +381,7 @@ TALER_MHD_open_unix_path (const char *unix_path,
*
* @param cfg configuration to parse
* @param section configuration section to use
* @param port[out] port to set, if TCP without BINDTO
* @param[out] port port to set, if TCP without BINDTO
* @return -1 and a port of zero on error, otherwise
* either -1 and a port, or a bound stream socket
*/

View File

@ -1897,7 +1897,6 @@ TALER_TESTING_get_trait_process (const struct TALER_TESTING_Command *cmd,
* @param index offered location index number, in case there are
* multiple on offer.
* @param processp process location to offer.
*
* @return the trait.
*/
struct TALER_TESTING_Trait
@ -1910,7 +1909,6 @@ TALER_TESTING_make_trait_process (unsigned int index,
*
* @param index index number to associate with offered coin priv.
* @param coin_priv coin private key to offer.
*
* @return the trait.
*/
struct TALER_TESTING_Trait
@ -1938,7 +1936,6 @@ TALER_TESTING_get_trait_coin_priv (const struct TALER_TESTING_Command *cmd,
*
* @param index index number to associate to the offered key.
* @param blinding_key blinding key to offer.
*
* @return the trait.
*/
struct TALER_TESTING_Trait
@ -1969,7 +1966,6 @@ TALER_TESTING_get_trait_blinding_key (const struct TALER_TESTING_Command *cmd,
*
* @param index index number to associate to the offered denom pub.
* @param denom_pub denom pub to offer with this trait.
*
* @return the trait.
*/
struct TALER_TESTING_Trait
@ -2014,7 +2010,6 @@ TALER_TESTING_get_trait_denom_sig (const struct TALER_TESTING_Command *cmd,
* @param index index number to associate to the signature on
* offer.
* @param denom_sig the denom sig on offer.
*
* @return the trait.
*/
struct TALER_TESTING_Trait

View File

@ -361,7 +361,7 @@ validate_payto_iban (const char *account_url)
* hash is what is put into the contract.
*
* @param wire_s wire details to hash
* @param hc[out] set to the hash
* @param[out] hc set to the hash
* @return #GNUNET_OK on success, #GNUNET_SYSERR if @a wire_s is malformed
*/
int

View File

@ -181,8 +181,8 @@ auditor_cb (void *cls,
*
* @param dh deposit handle
* @param json json reply with the signature
* @param exchange_sig[out] set to the exchange's signature
* @param exchange_pub[out] set to the exchange's public key
* @param[out] exchange_sig set to the exchange's signature
* @param[out] exchange_pub set to the exchange's public key
* @return #GNUNET_OK if the signature is valid, #GNUNET_SYSERR if not
*/
static int

View File

@ -38,7 +38,7 @@
*
* @param cmd command to extract the number from.
* @param index the number's index number.
* @param n[out] set to the number coming from @a cmd.
* @param[out] n set to the number coming from @a cmd.
* @return #GNUNET_OK on success.
*/
int
@ -78,8 +78,7 @@ TALER_TESTING_make_trait_uint (unsigned int index,
*
* @param cmd command to extract the number from.
* @param index the number's index number.
* @param n[out] set to the number coming from @a cmd.
*
* @param[out] n set to the number coming from @a cmd.
* @return #GNUNET_OK on success.
*/
int
@ -117,7 +116,7 @@ TALER_TESTING_make_trait_uint64 (unsigned int index,
* Obtain a bank transaction row value from @a cmd.
*
* @param cmd command to extract the number from.
* @param row[out] set to the number coming from @a cmd.
* @param[out] row set to the number coming from @a cmd.
* @return #GNUNET_OK on success.
*/
int

View File

@ -39,9 +39,8 @@
* @param cmd command to extract trait from.
* @param index which process to pick if @a cmd
* has multiple on offer.
* @param coin_priv[out] set to the address of the pointer to the
* @param[out] processp set to the address of the pointer to the
* process.
*
* @return #GNUNET_OK on success.
*/
int

View File

@ -37,7 +37,7 @@
*
* @param cmd command to extract the reserve priv from.
* @param index reserve priv's index number.
* @param reserve_priv[out] set to the reserve priv.
* @param[out] reserve_priv set to the reserve priv.
* @return #GNUNET_OK on success.
*/
int

View File

@ -37,7 +37,7 @@
*
* @param cmd command to extract the reserve pub from.
* @param index reserve pub's index number.
* @param reserve_pub[out] set to the reserve pub.
* @param[out] reserve_pub set to the reserve pub.
* @return #GNUNET_OK on success.
*/
int

View File

@ -56,7 +56,7 @@
* @param cmd command to extract the subject from.
* @param index index number associated with the transfer
* subject to offer.
* @param s[out] where to write the offered
* @param[out] s where to write the offered
* string
* @return #GNUNET_OK on success.
*/
@ -99,8 +99,7 @@ TALER_TESTING_make_trait_string (unsigned int index,
* @param cmd command to extract the url from.
* @param index which url is to be picked, in case
* multiple are offered.
* @param url[out] where to write the url.
*
* @param[out] url where to write the url.
* @return #GNUNET_OK on success.
*/
int
@ -148,8 +147,7 @@ TALER_TESTING_make_trait_url (unsigned int index,
* @param cmd command to extract the order id from.
* @param index which order id is to be picked, in case
* multiple are offered.
* @param order_id[out] where to write the order id.
*
* @param[out] order_id where to write the order id.
* @return #GNUNET_OK on success.
*/
int
@ -170,7 +168,6 @@ TALER_TESTING_get_trait_order_id (const struct TALER_TESTING_Command *cmd,
* @param index which order id is to be offered,
* in case multiple are offered.
* @param order_id the order id to offer.
*
* @return the trait.
*/
struct TALER_TESTING_Trait
@ -192,7 +189,7 @@ TALER_TESTING_make_trait_order_id (unsigned int index,
* @param cmd command to extract the url from.
* @param pt which url is to be picked, in case
* multiple are offered.
* @param url[out] where to write the url.
* @param[out] url where to write the url.
* @return #GNUNET_OK on success.
*/
int

View File

@ -37,7 +37,7 @@
* @param cmd command to extract trait from
* @param index which time stamp to pick if
* @a cmd has multiple on offer.
* @param time[out] set to the wanted WTID.
* @param[out] time set to the wanted WTID.
* @return #GNUNET_OK on success
*/
int

View File

@ -37,7 +37,7 @@
* @param cmd command to extract trait from
* @param index which WTID to pick if @a cmd has multiple on
* offer
* @param wtid[out] set to the wanted WTID.
* @param[out] wtid set to the wanted WTID.
* @return #GNUNET_OK on success
*/
int

View File

@ -296,7 +296,7 @@ TALER_MHD_open_unix_path (const char *unix_path,
*
* @param cfg configuration to parse
* @param section configuration section to use
* @param port[out] port to set, if TCP without BINDTO
* @param[out] port port to set, if TCP without BINDTO
* @return -1 and a port of zero on error, otherwise
* either -1 and a port, or a bound stream socket
*/

View File

@ -539,20 +539,18 @@ TALER_amount_normalize (struct TALER_Amount *amount)
/**
* Convert the fraction of @a amount to a string
* in decimals.
* Convert the fraction of @a amount to a string in decimals.
*
* @param amount value to convert
* @param tail[out] where to write the reesult
* @param[out] tail where to write the reesult
*/
static void
amount_to_tail (const struct TALER_Amount *amount,
char tail[TALER_AMOUNT_FRAC_LEN + 1])
{
uint32_t n = amount->fraction;
unsigned int i;
for (i = 0; (i < TALER_AMOUNT_FRAC_LEN) && (0 != n); i++)
for (unsigned int i = 0; (i < TALER_AMOUNT_FRAC_LEN) && (0 != n); i++)
{
tail[i] = '0' + (n / (TALER_AMOUNT_FRAC_BASE / 10));
n = (n * 10) % (TALER_AMOUNT_FRAC_BASE);

View File

@ -78,7 +78,7 @@ TALER_exchange_wire_signature_check (const char *payto_url,
*
* @param payto_url account specification
* @param master_priv private key to sign with
* @param master_sig[out] where to write the signature
* @param[out] master_sig where to write the signature
*/
void
TALER_exchange_wire_signature_make (const char *payto_url,
@ -105,7 +105,7 @@ TALER_exchange_wire_signature_make (const char *payto_url,
*
* @param payto_url bank account
* @param salt salt used to eliminate brute-force inversion
* @param hc[out] set to the hash
* @param[out] hc set to the hash
*/
void
TALER_merchant_wire_signature_hash (const char *payto_url,
@ -162,7 +162,7 @@ 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 merchant_sig[out] where to write the signature
* @param[out] merchant_sig where to write the signature
*/
void
TALER_merchant_wire_signature_make (const char *payto_url,