diff options
| author | Christian Grothoff <christian@grothoff.org> | 2022-02-12 12:35:03 +0100 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2022-02-12 12:35:03 +0100 |
| commit | 730d8c893cdf272f1a5e2a7f796102d670a28c47 (patch) | |
| tree | 1f1d20030c928c5937adb6e4d6edc273fe9be7bd /src/lib | |
| parent | d81b3f13d16210c1ae995306507c1b56091bc14e (diff) | |
-more doxygen fixes
Diffstat (limited to 'src/lib')
| -rw-r--r-- | src/lib/auditor_api_handle.c | 41 | ||||
| -rw-r--r-- | src/lib/exchange_api_deposit.c | 1 | ||||
| -rw-r--r-- | src/lib/exchange_api_refresh_common.h | 4 | ||||
| -rw-r--r-- | src/lib/exchange_api_refreshes_reveal.c | 11 | ||||
| -rw-r--r-- | src/lib/exchange_api_withdraw.c | 3 |
5 files changed, 11 insertions, 49 deletions
diff --git a/src/lib/auditor_api_handle.c b/src/lib/auditor_api_handle.c index 1d5522141..f7d7f9a77 100644 --- a/src/lib/auditor_api_handle.c +++ b/src/lib/auditor_api_handle.c @@ -365,12 +365,6 @@ version_completed_cb (void *cls, /* ********************* library internal API ********* */ -/** - * Get the context of a auditor. - * - * @param h the auditor handle to query - * @return ctx context to execute jobs in - */ struct GNUNET_CURL_Context * TALER_AUDITOR_handle_to_context_ (struct TALER_AUDITOR_Handle *h) { @@ -378,13 +372,7 @@ TALER_AUDITOR_handle_to_context_ (struct TALER_AUDITOR_Handle *h) } -/** - * Check if the handle is ready to process requests. - * - * @param h the auditor handle to query - * @return #GNUNET_YES if we are ready, #GNUNET_NO if not - */ -int +enum GNUNET_GenericReturnValue TALER_AUDITOR_handle_is_ready_ (struct TALER_AUDITOR_Handle *h) { GNUNET_log (GNUNET_ERROR_TYPE_INFO, @@ -396,13 +384,6 @@ TALER_AUDITOR_handle_is_ready_ (struct TALER_AUDITOR_Handle *h) } -/** - * Obtain the URL to use for an API request. - * - * @param h handle for the auditor - * @param path Taler API path (i.e. "/deposit-confirmation") - * @return the full URL to use with cURL - */ char * TALER_AUDITOR_path_to_url_ (struct TALER_AUDITOR_Handle *h, const char *path) @@ -417,21 +398,6 @@ TALER_AUDITOR_path_to_url_ (struct TALER_AUDITOR_Handle *h, /* ********************* public API ******************* */ -/** - * Initialise a connection to the auditor. Will connect to the - * auditor and obtain information about the auditor's master public - * key and the auditor's auditor. The respective information will - * be passed to the @a version_cb once available, and all future - * interactions with the auditor will be checked to be signed - * (where appropriate) by the respective master key. - * - * @param ctx the context - * @param url HTTP base URL for the auditor - * @param version_cb function to call with the - * auditor's version information - * @param version_cb_cls closure for @a version_cb - * @return the auditor handle; NULL upon error - */ struct TALER_AUDITOR_Handle * TALER_AUDITOR_connect (struct GNUNET_CURL_Context *ctx, const char *url, @@ -515,11 +481,6 @@ request_version (void *cls) } -/** - * Disconnect from the auditor - * - * @param auditor the auditor handle - */ void TALER_AUDITOR_disconnect (struct TALER_AUDITOR_Handle *auditor) { diff --git a/src/lib/exchange_api_deposit.c b/src/lib/exchange_api_deposit.c index fa3d75f5d..7ff596518 100644 --- a/src/lib/exchange_api_deposit.c +++ b/src/lib/exchange_api_deposit.c @@ -461,6 +461,7 @@ handle_deposit_finished (void *cls, * @param amount the amount to be deposited * @param h_wire hash of the merchant’s account details * @param h_contract_terms hash of the contact of the merchant with the customer (further details are never disclosed to the exchange) + * @param ech hash over contract extensions * @param coin_pub coin’s public key * @param denom_sig exchange’s unblinded signature of the coin * @param denom_pub denomination key with which the coin is signed diff --git a/src/lib/exchange_api_refresh_common.h b/src/lib/exchange_api_refresh_common.h index 70085a5b6..923fb76c4 100644 --- a/src/lib/exchange_api_refresh_common.h +++ b/src/lib/exchange_api_refresh_common.h @@ -122,7 +122,7 @@ struct MeltData * @param rms secret internals of the refresh-reveal operation * @param rd refresh data with the characteristics of the operation * @param alg_values contributions from the exchange into the melt - * @param[out] rd where to write the derived melt data + * @param[out] md where to write the derived melt data */ enum GNUNET_GenericReturnValue TALER_EXCHANGE_get_melt_data_ ( @@ -136,7 +136,7 @@ TALER_EXCHANGE_get_melt_data_ ( * Free all information associated with a melting session. Note * that we allow the melting session to be only partially initialized, * as we use this function also when freeing melt data that was not - * fully initialized (i.e. due to failures in #TALER_EXCHANGE_deserialize_melt_data_()). + * fully initialized. * * @param[in] md melting data to release, the pointer itself is NOT * freed (as it is typically not allocated by itself) diff --git a/src/lib/exchange_api_refreshes_reveal.c b/src/lib/exchange_api_refreshes_reveal.c index 2fc02d330..0b44aa355 100644 --- a/src/lib/exchange_api_refreshes_reveal.c +++ b/src/lib/exchange_api_refreshes_reveal.c @@ -89,18 +89,17 @@ struct TALER_EXCHANGE_RefreshesRevealHandle /** - * We got a 200 OK response for the /refreshes/$RCH/reveal operation. - * Extract the coin signatures and return them to the caller. - * The signatures we get from the exchange is for the blinded value. - * Thus, we first must unblind them and then should verify their - * validity. + * We got a 200 OK response for the /refreshes/$RCH/reveal operation. Extract + * the coin signatures and return them to the caller. The signatures we get + * from the exchange is for the blinded value. Thus, we first must unblind + * them and then should verify their validity. * * If everything checks out, we return the unblinded signatures * to the application via the callback. * * @param rrh operation handle * @param json reply from the exchange - * @param[out] sigs array of length `num_fresh_coins`, initialized to contain the coin private keys + * @param[out] coin_privs array of length `num_fresh_coins`, initialized to contain the coin private keys * @param[out] sigs array of length `num_fresh_coins`, initialized to contain signatures * @return #GNUNET_OK on success, #GNUNET_SYSERR on errors */ diff --git a/src/lib/exchange_api_withdraw.c b/src/lib/exchange_api_withdraw.c index 743fea4bb..c832699a2 100644 --- a/src/lib/exchange_api_withdraw.c +++ b/src/lib/exchange_api_withdraw.c @@ -185,7 +185,8 @@ handle_reserve_withdraw_finished ( /** * Function called when stage 1 of CS withdraw is finished (request r_pub's) * - * @param cls + * @param cls the `struct TALER_EXCHANGE_WithdrawHandle` + * @param csrr replies from the /csr request */ static void withdraw_cs_stage_two_callback (void *cls, |