gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-exchange] branch master updated: -doxygen fixes


From: gnunet
Subject: [taler-exchange] branch master updated: -doxygen fixes
Date: Sat, 12 Feb 2022 11:12:36 +0100

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository exchange.

The following commit(s) were added to refs/heads/master by this push:
     new bc14c215 -doxygen fixes
bc14c215 is described below

commit bc14c215b3a29da0d8fbb9c3f7b577a3155c2943
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Sat Feb 12 11:12:33 2022 +0100

    -doxygen fixes
---
 src/auditordb/auditordb_plugin.c              | 11 ----
 src/auditordb/plugin_auditordb_postgres.c     |  2 +-
 src/bank-lib/bank_api_transfer.c              | 39 +----------
 src/exchange/taler-exchange-httpd_keys.h      |  2 +-
 src/exchange/taler-exchange-httpd_kyc-check.h |  2 +-
 src/exchangedb/exchangedb_transactions.c      | 12 +---
 src/exchangedb/plugin_exchangedb_postgres.c   |  9 ++-
 src/include/taler_auditor_service.h           |  2 +-
 src/include/taler_crypto_lib.h                | 15 ++---
 src/include/taler_exchange_service.h          |  5 +-
 src/include/taler_exchangedb_plugin.h         |  1 -
 src/include/taler_mhd_lib.h                   |  2 +-
 src/include/taler_pq_lib.h                    | 10 +--
 src/include/taler_testing_lib.h               | 27 +-------
 src/lib/exchange_api_deposits_get.c           | 19 ------
 src/mhd/mhd_parsing.c                         | 94 +--------------------------
 src/testing/testing_api_cmd_bank_check.c      | 27 +-------
 src/testing/testing_api_cmd_oauth.c           |  7 +-
 src/testing/testing_api_cmd_refund.c          |  1 -
 src/testing/testing_api_cmd_serialize_keys.c  | 18 -----
 src/testing/testing_api_helpers_exchange.c    | 11 ----
 src/testing/testing_api_loop.c                | 13 +---
 src/util/config.c                             | 17 -----
 src/util/taler-exchange-secmod-cs.c           |  9 ++-
 src/util/url.c                                | 50 --------------
 25 files changed, 40 insertions(+), 365 deletions(-)

diff --git a/src/auditordb/auditordb_plugin.c b/src/auditordb/auditordb_plugin.c
index d04e8815..635247aa 100644
--- a/src/auditordb/auditordb_plugin.c
+++ b/src/auditordb/auditordb_plugin.c
@@ -24,12 +24,6 @@
 #include <ltdl.h>
 
 
-/**
- * Initialize the plugin.
- *
- * @param cfg configuration to use
- * @return #GNUNET_OK on success
- */
 struct TALER_AUDITORDB_Plugin *
 TALER_AUDITORDB_plugin_load (const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
@@ -62,11 +56,6 @@ TALER_AUDITORDB_plugin_load (const struct 
GNUNET_CONFIGURATION_Handle *cfg)
 }
 
 
-/**
- * Shutdown the plugin.
- *
- * @param plugin the plugin to unload
- */
 void
 TALER_AUDITORDB_plugin_unload (struct TALER_AUDITORDB_Plugin *plugin)
 {
diff --git a/src/auditordb/plugin_auditordb_postgres.c 
b/src/auditordb/plugin_auditordb_postgres.c
index e0355d93..ef5f0073 100644
--- a/src/auditordb/plugin_auditordb_postgres.c
+++ b/src/auditordb/plugin_auditordb_postgres.c
@@ -144,7 +144,7 @@ postgres_create_tables (void *cls)
  * @param[in,out] pg the plugin-specific state
  * @return #GNUNET_OK on success
  */
-static int
+static enum GNUNET_GenericReturnValue
 setup_connection (struct PostgresClosure *pg)
 {
   struct GNUNET_PQ_PreparedStatement ps[] = {
diff --git a/src/bank-lib/bank_api_transfer.c b/src/bank-lib/bank_api_transfer.c
index bbfc9cec..3b50018d 100644
--- a/src/bank-lib/bank_api_transfer.c
+++ b/src/bank-lib/bank_api_transfer.c
@@ -65,18 +65,7 @@ struct WirePackP
 
 GNUNET_NETWORK_STRUCT_END
 
-/**
- * Prepare for execution of a wire transfer from the exchange to some
- * merchant.
- *
- * @param destination_account_payto_uri payto:// URL identifying where to send 
the money
- * @param amount amount to transfer, already rounded
- * @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[out] buf set to transfer 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_transfer (
   const char *destination_account_payto_uri,
@@ -247,17 +236,6 @@ handle_transfer_finished (void *cls,
 }
 
 
-/**
- * Execute a wire transfer.
- *
- * @param ctx curl context for our event loop
- * @param auth authentication data to authenticate with the bank
- * @param buf buffer with the prepared execution details
- * @param buf_size number of bytes in @a buf
- * @param cc function to call upon success
- * @param cc_cls closure for @a cc
- * @return NULL on error
- */
 struct TALER_BANK_TransferHandle *
 TALER_BANK_transfer (
   struct GNUNET_CURL_Context *ctx,
@@ -366,21 +344,6 @@ TALER_BANK_transfer (
 }
 
 
-/**
- * Abort execution of a wire transfer. For example, because we are shutting
- * down.  Note that if an execution is aborted, it may or may not still
- * succeed.
- *
- * The caller MUST run #TALER_BANK_transfer() again for the same request as
- * soon as possible, to ensure that the request either ultimately succeeds or
- * ultimately fails. Until this has been done, the transaction is in limbo
- * (i.e. may or may not have been committed).
- *
- * This function cannot be used on a request handle if a response is already
- * served for it.
- *
- * @param th the wire transfer request handle
- */
 void
 TALER_BANK_transfer_cancel (struct TALER_BANK_TransferHandle *th)
 {
diff --git a/src/exchange/taler-exchange-httpd_keys.h 
b/src/exchange/taler-exchange-httpd_keys.h
index b4a14828..07925f7f 100644
--- a/src/exchange/taler-exchange-httpd_keys.h
+++ b/src/exchange/taler-exchange-httpd_keys.h
@@ -200,7 +200,7 @@ TEH_keys_denomination_cs_r_pub (
 
 
 /**
- * Revoke the public key associated with @param h_denom_pub .
+ * Revoke the public key associated with @a h_denom_pub.
  * This function should be called AFTER the database was
  * updated, as it also triggers #TEH_keys_update_states().
  *
diff --git a/src/exchange/taler-exchange-httpd_kyc-check.h 
b/src/exchange/taler-exchange-httpd_kyc-check.h
index 52fe5f16..b6434b60 100644
--- a/src/exchange/taler-exchange-httpd_kyc-check.h
+++ b/src/exchange/taler-exchange-httpd_kyc-check.h
@@ -29,7 +29,7 @@
  * Handle a "/kyc-check" request.  Checks the KYC
  * status of the given account and returns it.
  *
- * @param connection request to handle
+ * @param rc details about the request to handle
  * @param args one argument with the payment_target_uuid
  * @return MHD result code
  */
diff --git a/src/exchangedb/exchangedb_transactions.c 
b/src/exchangedb/exchangedb_transactions.c
index aaf28a9e..81a33b17 100644
--- a/src/exchangedb/exchangedb_transactions.c
+++ b/src/exchangedb/exchangedb_transactions.c
@@ -22,17 +22,7 @@
 #include "taler_exchangedb_lib.h"
 
 
-/**
- * Calculate the total value of all transactions performed.
- * Stores @a off plus the cost of all transactions in @a tl
- * in @a ret.
- *
- * @param tl transaction list to process
- * @param off offset to use as the starting value
- * @param[out] ret where the resulting total is to be stored (may alias @a off)
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on errors
- */
-int
+enum GNUNET_GenericReturnValue
 TALER_EXCHANGEDB_calculate_transaction_list_totals (
   struct TALER_EXCHANGEDB_TransactionList *tl,
   const struct TALER_Amount *off,
diff --git a/src/exchangedb/plugin_exchangedb_postgres.c 
b/src/exchangedb/plugin_exchangedb_postgres.c
index ecfa3359..19b0c83a 100644
--- a/src/exchangedb/plugin_exchangedb_postgres.c
+++ b/src/exchangedb/plugin_exchangedb_postgres.c
@@ -3882,7 +3882,6 @@ postgres_select_kyc_status (void *cls,
  *
  * @param pg the plugin-specific state
  * @param payto_uri the payto URI to check
- * @param oauth_username user ID to store
  * @param[out] kyc set to the KYC status of the wallet
  * @return transaction status
  */
@@ -7194,11 +7193,10 @@ postgres_lookup_wire_transfer (
  * @param merchant_pub merchant public key
  * @param[out] pending set to true if the transaction is still pending
  * @param[out] wtid wire transfer identifier, only set if @a pending is false
- * @param[out] coin_contribution how much did the coin we asked about
- *        contribute to the total transfer value? (deposit value including fee)
- * @param[out] coin_fee how much did the exchange charge for the deposit fee
- * @param[out] execution_time when was the transaction done, or
+ * @param[out] exec_time when was the transaction done, or
  *         when we expect it to be done (if @a pending is false)
+ * @param[out] amount_with_fee set to the total deposited amount
+ * @param[out] deposit_fee set to how much the exchange did charge for the 
deposit
  * @param[out] kyc set to the kyc status of the receiver (if @a pending)
  * @return transaction status code
  */
@@ -9406,6 +9404,7 @@ postgres_get_reserve_by_h_blind (void *cls,
  * @param cls closure
  * @param h_blind_ev hash of the blinded coin
  * @param[out] old_coin_pub set to information about the old coin (on success 
only)
+ * @param[out] rrc_serial set to serial number of the entry in the database
  * @return transaction status code
  */
 static enum GNUNET_DB_QueryStatus
diff --git a/src/include/taler_auditor_service.h 
b/src/include/taler_auditor_service.h
index f7152034..1d252f9d 100644
--- a/src/include/taler_auditor_service.h
+++ b/src/include/taler_auditor_service.h
@@ -259,7 +259,7 @@ TALER_AUDITOR_deposit_confirmation (
   const struct TALER_MerchantWireHash *h_wire,
   const struct TALER_ExtensionContractHash *h_extensions,
   const struct TALER_PrivateContractHash *h_contract_terms,
-  struct GNUNET_TIME_Timestamp timestamp,
+  struct GNUNET_TIME_Timestamp exchange_timestamp,
   struct GNUNET_TIME_Timestamp wire_deadline,
   struct GNUNET_TIME_Timestamp refund_deadline,
   const struct TALER_Amount *amount_without_fee,
diff --git a/src/include/taler_crypto_lib.h b/src/include/taler_crypto_lib.h
index 62a958f7..dc721436 100644
--- a/src/include/taler_crypto_lib.h
+++ b/src/include/taler_crypto_lib.h
@@ -1126,7 +1126,6 @@ TALER_denom_sign_blinded (struct 
TALER_BlindedDenominationSignature *denom_sig,
  * Unblind blinded signature.
  *
  * @param[out] denom_sig where to write the unblinded signature
- * @param dk denomination public key
  * @param bdenom_sig the blinded signature
  * @param bks blinding secret to use
  * @param c_hash hash of the coin's public key for verification of the 
signature
@@ -1242,8 +1241,8 @@ TALER_blinded_denom_sig_cmp (
 /**
  * Compare two blinded planchets.
  *
- * @param sig1 first blinded planchet
- * @param sig2 second blinded planchet
+ * @param bp1 first blinded planchet
+ * @param bp2 second blinded planchet
  * @return 0 if the keys are equal, otherwise -1 or 1
  */
 int
@@ -1299,7 +1298,7 @@ TALER_test_coin_valid (const struct TALER_CoinPublicInfo 
*coin_public_info,
  * Compute the hash of a blinded coin.
  *
  * @param blinded_planchet blinded planchet
- * @param denom_pub denomination publick key
+ * @param denom_hash hash of the denomination publick key
  * @param[out] bch where to write the hash
  * @return #GNUNET_OK when successful, #GNUNET_SYSERR if an internal error 
occured
  */
@@ -1806,7 +1805,7 @@ TALER_CRYPTO_helper_rsa_sign (
 
 
 /**
- * Ask the helper to revoke the public key associated with @param h_denom_pub .
+ * Ask the helper to revoke the public key associated with @a h_denom_pub.
  * Will cause the helper to tell all clients that the key is now unavailable,
  * and to create a replacement key.
  *
@@ -1926,7 +1925,7 @@ TALER_CRYPTO_helper_cs_sign (
 
 
 /**
- * Ask the helper to revoke the public key associated with @param h_cs .
+ * Ask the helper to revoke the public key associated with @a h_cs.
  * Will cause the helper to tell all clients that the key is now unavailable,
  * and to create a replacement key.
  *
@@ -1947,8 +1946,8 @@ TALER_CRYPTO_helper_cs_revoke (
 
 
 /**
- * Ask the helper to derive R using the @param nonce and denomination key
- * associated with @param h_cs.
+ * Ask the helper to derive R using the @a nonce and denomination key
+ * associated with @a h_cs.
  *
  * This operation will block until the R has been obtained.  Should
  * this process receive a signal (that is not ignored) while the operation is
diff --git a/src/include/taler_exchange_service.h 
b/src/include/taler_exchange_service.h
index ca5f2ae8..72990dc3 100644
--- a/src/include/taler_exchange_service.h
+++ b/src/include/taler_exchange_service.h
@@ -1669,8 +1669,7 @@ typedef void
  *
  * This API is typically used by a wallet.  Note that to ensure that
  * no money is lost in case of hardware failures, the provided
- * argument should have been constructed using
- * #TALER_EXCHANGE_refresh_prepare and committed to persistent storage
+ * argument @a rd should be committed to persistent storage
  * prior to calling this function.
  *
  * @param exchange the exchange handle; the exchange must be ready to operate
@@ -2414,7 +2413,7 @@ struct TALER_EXCHANGE_KycProofResponse
  * Function called with the result of a KYC check.
  *
  * @param cls closure
- * @param ks the account's KYC status details
+ * @param kpr the account's KYC status details
  */
 typedef void
 (*TALER_EXCHANGE_KycProofCallback)(
diff --git a/src/include/taler_exchangedb_plugin.h 
b/src/include/taler_exchangedb_plugin.h
index 13ba7405..844de585 100644
--- a/src/include/taler_exchangedb_plugin.h
+++ b/src/include/taler_exchangedb_plugin.h
@@ -1886,7 +1886,6 @@ typedef void
  * @param cls closure
  * @param rowid which row in the table 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 h_wire hash of wire transfer details of the merchant (should be same 
for all callbacks with the same @e cls)
  * @param account_payto_uri which account did the transfer go to?
  * @param exec_time execution time of the wire transfer (should be same for 
all callbacks with the same @e cls)
  * @param h_contract_terms which proposal was this payment about
diff --git a/src/include/taler_mhd_lib.h b/src/include/taler_mhd_lib.h
index b0012a64..dc68df06 100644
--- a/src/include/taler_mhd_lib.h
+++ b/src/include/taler_mhd_lib.h
@@ -547,7 +547,7 @@ struct TALER_MHD_Legal;
 
 /**
  * Load set of legal documents as specified in @a cfg in section @a section
- * where the Etag is given under the @param tagoption and the directory under
+ * where the Etag is given under the @a tagoption and the directory under
  * the @a diroption.
  *
  * @param cfg configuration to use
diff --git a/src/include/taler_pq_lib.h b/src/include/taler_pq_lib.h
index 81f5c987..fdc17ca5 100644
--- a/src/include/taler_pq_lib.h
+++ b/src/include/taler_pq_lib.h
@@ -58,7 +58,7 @@ TALER_PQ_query_param_amount (const struct TALER_Amount *x);
  * public key will be serialized into on variable-size
  * BLOB.
  *
- * @param x pointer to the query parameter to pass
+ * @param denom_pub pointer to the query parameter to pass
  */
 struct GNUNET_PQ_QueryParam
 TALER_PQ_query_param_denom_pub (
@@ -70,7 +70,7 @@ TALER_PQ_query_param_denom_pub (
  * various attributes of the signature will be serialized into on
  * variable-size BLOB.
  *
- * @param x pointer to the query parameter to pass
+ * @param denom_sig pointer to the query parameter to pass
  */
 struct GNUNET_PQ_QueryParam
 TALER_PQ_query_param_denom_sig (
@@ -83,7 +83,7 @@ TALER_PQ_query_param_denom_sig (
  * planchet will be serialized into on
  * variable-size BLOB.
  *
- * @param x pointer to the query parameter to pass
+ * @param bp pointer to the query parameter to pass
  */
 struct GNUNET_PQ_QueryParam
 TALER_PQ_query_param_blinded_planchet (
@@ -95,7 +95,7 @@ TALER_PQ_query_param_blinded_planchet (
  * the various attributes of the signature will be serialized into on
  * variable-size BLOB.
  *
- * @param x pointer to the query parameter to pass
+ * @param denom_sig pointer to the query parameter to pass
  */
 struct GNUNET_PQ_QueryParam
 TALER_PQ_query_param_blinded_denom_sig (
@@ -107,7 +107,7 @@ TALER_PQ_query_param_blinded_denom_sig (
  * withdraw. Internally, the various attributes of the @a alg_values will be
  * serialized into on variable-size BLOB.
  *
- * @param x pointer to the query parameter to pass
+ * @param alg_values pointer to the query parameter to pass
  */
 struct GNUNET_PQ_QueryParam
 TALER_PQ_query_param_exchange_withdraw_values (
diff --git a/src/include/taler_testing_lib.h b/src/include/taler_testing_lib.h
index a0385a85..271302ae 100644
--- a/src/include/taler_testing_lib.h
+++ b/src/include/taler_testing_lib.h
@@ -1709,14 +1709,13 @@ TALER_TESTING_cmd_check_bank_empty (const char *label);
  *        provide a coin to be refunded.
  * @param refund_transaction_id transaction id to use
  *        in the request.
- *
  * @return the command.
  */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_refund_with_id (const char *label,
                                   unsigned int expected_response_code,
                                   const char *refund_amount,
-                                  const char *deposit_reference,
+                                  const char *coin_reference,
                                   uint64_t refund_transaction_id);
 
 
@@ -1728,14 +1727,13 @@ TALER_TESTING_cmd_refund_with_id (const char *label,
  * @param refund_amount the amount to ask a refund for.
  * @param coin_reference reference to a command that can
  *        provide a coin to be refunded.
- *
  * @return the command.
  */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_refund (const char *label,
                           unsigned int expected_response_code,
                           const char *refund_amount,
-                          const char *deposit_reference);
+                          const char *coin_reference);
 
 
 /**
@@ -2084,6 +2082,7 @@ TALER_TESTING_cmd_auditor_add_denom_sig (const char 
*label,
                                          const char *denom_ref,
                                          bool bad_sig);
 
+
 /**
  * Add statement about wire fees of the exchange. This is always
  * done for a few hours around the current time (for the test).
@@ -2208,26 +2207,6 @@ TALER_TESTING_cmd_revoke_sign_key (
   const char *signkey_ref);
 
 
-/**
- * Have the auditor affirm that it is auditing the given
- * denomination key and upload the auditor's signature to
- * the exchange.
- *
- * @param label command label.
- * @param expected_http_status expected HTTP status from exchange
- * @param denom_ref reference to a command that identifies
- *        a denomination key (i.e. because it was used to
- *        withdraw a coin).
- * @param bad_sig should we use a bogus signature?
- * @return the command
- */
-struct TALER_TESTING_Command
-TALER_TESTING_cmd_auditor_add_denom_sig (const char *label,
-                                         unsigned int expected_http_status,
-                                         const char *denom_ref,
-                                         bool bad_sig);
-
-
 /**
  * Create a request for a wallet's KYC UUID.
  *
diff --git a/src/lib/exchange_api_deposits_get.c 
b/src/lib/exchange_api_deposits_get.c
index 18fb9b7b..30f3ee7f 100644
--- a/src/lib/exchange_api_deposits_get.c
+++ b/src/lib/exchange_api_deposits_get.c
@@ -258,19 +258,6 @@ handle_deposit_wtid_finished (void *cls,
 }
 
 
-/**
- * Obtain wire transfer details about an existing deposit operation.
- *
- * @param exchange the exchange to query
- * @param merchant_priv the merchant's private key
- * @param h_wire hash of merchant's wire transfer details
- * @param h_contract_terms hash of the proposal data from the contract
- *                        between merchant and customer
- * @param coin_pub public key of the coin
- * @param cb function to call with the result
- * @param cb_cls closure for @a cb
- * @return handle to abort request
- */
 struct TALER_EXCHANGE_DepositGetHandle *
 TALER_EXCHANGE_deposits_get (
   struct TALER_EXCHANGE_Handle *exchange,
@@ -387,12 +374,6 @@ TALER_EXCHANGE_deposits_get (
 }
 
 
-/**
- * Cancel /deposits/$WTID request.  This function cannot be used on a request
- * handle if a response is already served for it.
- *
- * @param dwh the wire deposits request handle
- */
 void
 TALER_EXCHANGE_deposits_get_cancel (struct TALER_EXCHANGE_DepositGetHandle 
*dwh)
 {
diff --git a/src/mhd/mhd_parsing.c b/src/mhd/mhd_parsing.c
index 4415c82a..bae10e72 100644
--- a/src/mhd/mhd_parsing.c
+++ b/src/mhd/mhd_parsing.c
@@ -27,29 +27,6 @@
 #include "taler_mhd_lib.h"
 
 
-/**
- * Process a POST request containing a JSON object.  This function
- * realizes an MHD POST processor that will (incrementally) process
- * JSON data uploaded to the HTTP server.  It will store the required
- * state in the @a con_cls, which must be cleaned up using
- * #TALER_MHD_parse_post_cleanup_callback().
- *
- * @param connection the MHD connection
- * @param con_cls the closure (points to a `struct Buffer *`)
- * @param upload_data the POST data
- * @param upload_data_size number of bytes in @a upload_data
- * @param json the JSON object for a completed request
- * @return
- *    #GNUNET_YES if json object was parsed or at least
- *               may be parsed in the future (call again);
- *               `*json` will be NULL if we need to be called again,
- *                and non-NULL if we are done.
- *    #GNUNET_NO is request incomplete or invalid
- *               (error message was generated)
- *    #GNUNET_SYSERR on internal error
- *               (we could not even queue an error message,
- *                close HTTP session with MHD_NO)
- */
 enum GNUNET_GenericReturnValue
 TALER_MHD_parse_post_json (struct MHD_Connection *connection,
                            void **con_cls,
@@ -102,13 +79,6 @@ TALER_MHD_parse_post_json (struct MHD_Connection 
*connection,
 }
 
 
-/**
- * Function called whenever we are done with a request
- * to clean up our state.
- *
- * @param con_cls value as it was left by
- *        #TALER_MHD_parse_post_json(), to be cleaned up
- */
 void
 TALER_MHD_parse_post_cleanup_callback (void *con_cls)
 {
@@ -116,22 +86,7 @@ TALER_MHD_parse_post_cleanup_callback (void *con_cls)
 }
 
 
-/**
- * Extract base32crockford encoded data from request.
- *
- * Queues an error response to the connection if the parameter is
- * missing or invalid.
- *
- * @param connection the MHD connection
- * @param param_name the name of the parameter with the key
- * @param[out] out_data pointer to store the result
- * @param out_size expected size of data
- * @return
- *   #GNUNET_YES if the the argument is present
- *   #GNUNET_NO if the argument is absent or malformed
- *   #GNUNET_SYSERR on internal error (error response could not be sent)
- */
-int
+enum GNUNET_GenericReturnValue
 TALER_MHD_parse_request_arg_data (struct MHD_Connection *connection,
                                   const char *param_name,
                                   void *out_data,
@@ -166,20 +121,6 @@ TALER_MHD_parse_request_arg_data (struct MHD_Connection 
*connection,
 }
 
 
-/**
- * Parse JSON object into components based on the given field
- * specification.  Generates error response on parse errors.
- *
- * @param connection the connection to send an error response to
- * @param root the JSON node to start the navigation at.
- * @param[in,out] spec field specification for the parser
- * @return
- *    #GNUNET_YES if navigation was successful (caller is responsible
- *                for freeing allocated variable-size data using
- *                GNUNET_JSON_parse_free() when done)
- *    #GNUNET_NO if json is malformed, error response was generated
- *    #GNUNET_SYSERR on internal error
- */
 enum GNUNET_GenericReturnValue
 TALER_MHD_parse_json_data (struct MHD_Connection *connection,
                            const json_t *root,
@@ -217,24 +158,6 @@ TALER_MHD_parse_json_data (struct MHD_Connection 
*connection,
 }
 
 
-/**
- * Parse JSON object that we (the server!) generated into components based on
- * the given field specification.  The difference to
- * #TALER_MHD_parse_json_data() is that this function will fail
- * with an HTTP failure of 500 (internal server error) in case
- * parsing fails, instead of blaming it on the client with a
- * 400 (#MHD_HTTP_BAD_REQUEST).
- *
- * @param connection the connection to send an error response to
- * @param root the JSON node to start the navigation at.
- * @param spec field specification for the parser
- * @return
- *    #GNUNET_YES if navigation was successful (caller is responsible
- *                for freeing allocated variable-size data using
- *                GNUNET_JSON_parse_free() when done)
- *    #GNUNET_NO if json is malformed, error response was generated
- *    #GNUNET_SYSERR on internal error
- */
 enum GNUNET_GenericReturnValue
 TALER_MHD_parse_internal_json_data (struct MHD_Connection *connection,
                                     const json_t *root,
@@ -272,21 +195,6 @@ TALER_MHD_parse_internal_json_data (struct MHD_Connection 
*connection,
 }
 
 
-/**
- * Parse JSON array into components based on the given field
- * specification.  Generates error response on parse errors.
- *
- * @param connection the connection to send an error response to
- * @param root the JSON node to start the navigation at.
- * @param[in,out] spec field specification for the parser
- * @param ... -1-terminated list of array offsets of type 'int'
- * @return
- *    #GNUNET_YES if navigation was successful (caller is responsible
- *                for freeing allocated variable-size data using
- *                GNUNET_JSON_parse_free() when done)
- *    #GNUNET_NO if json is malformed, error response was generated
- *    #GNUNET_SYSERR on internal error
- */
 enum GNUNET_GenericReturnValue
 TALER_MHD_parse_json_array (struct MHD_Connection *connection,
                             const json_t *root,
diff --git a/src/testing/testing_api_cmd_bank_check.c 
b/src/testing/testing_api_cmd_bank_check.c
index ed4cde46..be4ad318 100644
--- a/src/testing/testing_api_cmd_bank_check.c
+++ b/src/testing/testing_api_cmd_bank_check.c
@@ -228,19 +228,6 @@ check_bank_transfer_traits (void *cls,
 }
 
 
-/**
- * Make a "bank check" CMD.  It checks whether a
- * particular wire transfer has been made or not.
- *
- * @param label the command label.
- * @param exchange_base_url base url of the exchange involved in
- *        the wire transfer.
- * @param amount the amount expected to be transferred.
- * @param debit_payto the account that gave money.
- * @param credit_payto the account that received money.
- *
- * @return the command
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_check_bank_transfer (const char *label,
                                        const char *exchange_base_url,
@@ -270,19 +257,9 @@ TALER_TESTING_cmd_check_bank_transfer (const char *label,
 }
 
 
-/**
- * Define a "bank check" CMD that takes the input
- * data from another CMD that offers it.
- *
- * @param label command label.
- * @param deposit_reference reference to a CMD that is
- *        able to provide the "check bank transfer" operation
- *        input data.
- * @return the command.
- */
 struct TALER_TESTING_Command
-TALER_TESTING_cmd_check_bank_transfer_with_ref
-  (const char *label,
+TALER_TESTING_cmd_check_bank_transfer_with_ref (
+  const char *label,
   const char *deposit_reference)
 {
   struct BankCheckState *bcs;
diff --git a/src/testing/testing_api_cmd_oauth.c 
b/src/testing/testing_api_cmd_oauth.c
index eaf7f906..045b5eef 100644
--- a/src/testing/testing_api_cmd_oauth.c
+++ b/src/testing/testing_api_cmd_oauth.c
@@ -131,16 +131,17 @@ handle_post (void *cls,
  *
  * @param cls argument given together with the function
  *        pointer when the handler was registered with MHD
+ * @param connection the connection being handled
  * @param url the requested url
  * @param method the HTTP method used (#MHD_HTTP_METHOD_GET,
  *        #MHD_HTTP_METHOD_PUT, etc.)
  * @param version the HTTP version string (i.e.
- *        #MHD_HTTP_VERSION_1_1)
+ *        MHD_HTTP_VERSION_1_1)
  * @param upload_data the data being uploaded (excluding HEADERS,
  *        for a POST that fits into memory and that is encoded
  *        with a supported encoding, the POST data will NOT be
  *        given in upload_data and is instead available as
- *        part of #MHD_get_connection_values; very large POST
+ *        part of MHD_get_connection_values(); very large POST
  *        data *will* be made available incrementally in
  *        @a upload_data)
  * @param[in,out] upload_data_size set initially to the size of the
@@ -153,7 +154,7 @@ handle_post (void *cls,
  *        with plenty of upload data) this allows the application
  *        to easily associate some request-specific state.
  *        If necessary, this state can be cleaned up in the
- *        global #MHD_RequestCompletedCallback (which
+ *        global MHD_RequestCompletedCallback (which
  *        can be set with the #MHD_OPTION_NOTIFY_COMPLETED).
  *        Initially, `*con_cls` will be NULL.
  * @return #MHD_YES if the connection was handled successfully,
diff --git a/src/testing/testing_api_cmd_refund.c 
b/src/testing/testing_api_cmd_refund.c
index c288e9e1..5dae9e57 100644
--- a/src/testing/testing_api_cmd_refund.c
+++ b/src/testing/testing_api_cmd_refund.c
@@ -235,7 +235,6 @@ TALER_TESTING_cmd_refund (const char *label,
   struct RefundState *rs;
 
   rs = GNUNET_new (struct RefundState);
-
   rs->expected_response_code = expected_response_code;
   rs->refund_amount = refund_amount;
   rs->coin_reference = coin_reference;
diff --git a/src/testing/testing_api_cmd_serialize_keys.c 
b/src/testing/testing_api_cmd_serialize_keys.c
index d3b34a93..ef912bf5 100644
--- a/src/testing/testing_api_cmd_serialize_keys.c
+++ b/src/testing/testing_api_cmd_serialize_keys.c
@@ -233,14 +233,6 @@ connect_with_state_cleanup (void *cls,
 }
 
 
-/**
- * Make a serialize-keys CMD.  It will ask for
- * keys serialization __and__ disconnect from the
- * exchange.
- *
- * @param label CMD label
- * @return the CMD.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_serialize_keys (const char *label)
 {
@@ -261,16 +253,6 @@ TALER_TESTING_cmd_serialize_keys (const char *label)
 }
 
 
-/**
- * Make a connect-with-state CMD.  This command
- * will use a serialized key state to reconnect
- * to the exchange.
- *
- * @param label command label
- * @param state_reference label of a CMD offering
- *        a serialized key state.
- * @return the CMD.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_connect_with_state (const char *label,
                                       const char *state_reference)
diff --git a/src/testing/testing_api_helpers_exchange.c 
b/src/testing/testing_api_helpers_exchange.c
index ba0e5a0f..8e0e0298 100644
--- a/src/testing/testing_api_helpers_exchange.c
+++ b/src/testing/testing_api_helpers_exchange.c
@@ -371,17 +371,6 @@ fail:
 }
 
 
-/**
- * Prepare launching an exchange.  Checks that the configured
- * port is available, runs taler-exchange-dbinit.  Does NOT
- * launch the exchange process itself.
- *
- * @param config_filename configuration file to use
- * @param reset_db should we reset the database?
- * @param[out] ec will be set to the exchange configuration data
- * @return #GNUNET_OK on success, #GNUNET_NO if test should be
- *         skipped, #GNUNET_SYSERR on test failure
- */
 enum GNUNET_GenericReturnValue
 TALER_TESTING_prepare_exchange (const char *config_filename,
                                 int reset_db,
diff --git a/src/testing/testing_api_loop.c b/src/testing/testing_api_loop.c
index 9ce20112..784d3c9e 100644
--- a/src/testing/testing_api_loop.c
+++ b/src/testing/testing_api_loop.c
@@ -36,13 +36,7 @@
  */
 static struct GNUNET_DISK_PipeHandle *sigpipe;
 
-/**
- * Lookup command by label.
- *
- * @param is interpreter state to search
- * @param label label to look for
- * @return NULL if command was not found
- */
+
 const struct TALER_TESTING_Command *
 TALER_TESTING_interpreter_lookup_command (struct TALER_TESTING_Interpreter *is,
                                           const char *label)
@@ -229,11 +223,6 @@ TALER_TESTING_interpreter_get_current_label (struct
 }
 
 
-/**
- * Run the main interpreter loop that performs exchange operations.
- *
- * @param cls contains the `struct TALER_TESTING_Interpreter`
- */
 static void
 interpreter_run (void *cls)
 {
diff --git a/src/util/config.c b/src/util/config.c
index d368d346..8123b734 100644
--- a/src/util/config.c
+++ b/src/util/config.c
@@ -23,15 +23,6 @@
 #include "taler_util.h"
 
 
-/**
- * Obtain denomination amount from configuration file.
- *
- * @param cfg configuration to use
- * @param section section of the configuration to access
- * @param option option of the configuration to access
- * @param[out] denom set to the amount found in configuration
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
- */
 enum GNUNET_GenericReturnValue
 TALER_config_get_amount (const struct GNUNET_CONFIGURATION_Handle *cfg,
                          const char *section,
@@ -67,14 +58,6 @@ TALER_config_get_amount (const struct 
GNUNET_CONFIGURATION_Handle *cfg,
 }
 
 
-/**
- * Load our currency from the @a cfg (in section [taler]
- * the option "CURRENCY").
- *
- * @param cfg configuration to use
- * @param[out] currency where to write the result
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
- */
 enum GNUNET_GenericReturnValue
 TALER_config_get_currency (const struct GNUNET_CONFIGURATION_Handle *cfg,
                            char **currency)
diff --git a/src/util/taler-exchange-secmod-cs.c 
b/src/util/taler-exchange-secmod-cs.c
index ab3a86fa..976880e7 100644
--- a/src/util/taler-exchange-secmod-cs.c
+++ b/src/util/taler-exchange-secmod-cs.c
@@ -229,7 +229,7 @@ static uint64_t key_gen;
 /**
  * Generate the announcement message for @a dk.
  *
- * @param[in,out] denomination key to generate the announcement for
+ * @param[in,out] dk denomination key to generate the announcement for
  */
 static void
 generate_response (struct DenominationKey *dk)
@@ -538,12 +538,12 @@ handle_revoke_request (struct TES_Client *client,
 
 
 /**
- * Handle @a client request @a sr to create signature. Create the
+ * Handle @a client request @a rdr to create signature. Create the
  * signature using the respective key and return the result to
  * the client.
  *
  * @param client the client making the request
- * @param sr the request details
+ * @param rdr the request details
  * @return #GNUNET_OK on success
  */
 static enum GNUNET_GenericReturnValue
@@ -1070,8 +1070,7 @@ update_denominations (void *cls)
  *
  * @param[out] denom denomination of the key
  * @param filename name of the file we are parsing, for logging
- * @param buf key material
- * @param buf_size number of bytes in @a buf
+ * @param priv key material
  */
 static void
 parse_key (struct Denomination *denom,
diff --git a/src/util/url.c b/src/util/url.c
index 19986344..a76d2f88 100644
--- a/src/util/url.c
+++ b/src/util/url.c
@@ -102,12 +102,6 @@ buffer_write_urlencode (struct GNUNET_Buffer *buf,
 }
 
 
-/**
- * URL-encode a string according to rfc3986.
- *
- * @param s string to encode
- * @returns the urlencoded string, the caller must free it with #GNUNET_free()
- */
 char *
 TALER_urlencode (const char *s)
 {
@@ -212,20 +206,6 @@ serialize_arguments (struct GNUNET_Buffer *buf,
 }
 
 
-/**
- * Make an absolute URL with query parameters.
- *
- * If a 'value' is given as NULL, both the key and the value are skipped. Note
- * that a NULL value does not terminate the list, only a NULL key signals the
- * end of the list of arguments.
- *
- * @param base_url absolute base URL to use
- * @param path path of the url
- * @param ... NULL-terminated key-value pairs (char *) for query parameters,
- *        the value will be url-encoded
- * @returns the URL (must be freed with #GNUNET_free) or
- *          NULL if an error occurred.
- */
 char *
 TALER_url_join (const char *base_url,
                 const char *path,
@@ -282,21 +262,6 @@ TALER_url_join (const char *base_url,
 }
 
 
-/**
- * Make an absolute URL for the given parameters.
- *
- * If a 'value' is given as NULL, both the key and the value are skipped. Note
- * that a NULL value does not terminate the list, only a NULL key signals the
- * end of the list of arguments.
- *
- * @param proto protocol for the URL (typically https)
- * @param host hostname for the URL
- * @param prefix prefix for the URL
- * @param path path for the URL
- * @param args NULL-terminated key-value pairs (char *) for query parameters,
- *        the value will be url-encoded
- * @returns the URL, must be freed with #GNUNET_free
- */
 char *
 TALER_url_absolute_raw_va (const char *proto,
                            const char *host,
@@ -329,21 +294,6 @@ TALER_url_absolute_raw_va (const char *proto,
 }
 
 
-/**
- * Make an absolute URL for the given parameters.
- *
- * If a 'value' is given as NULL, both the key and the value are skipped. Note
- * that a NULL value does not terminate the list, only a NULL key signals the
- * end of the list of arguments.
- *
- * @param proto protocol for the URL (typically https)
- * @param host hostname for the URL
- * @param prefix prefix for the URL
- * @param path path for the URL
- * @param ... NULL-terminated key-value pairs (char *) for query parameters,
- *        the value will be url-encoded
- * @return the URL, must be freed with #GNUNET_free
- */
 char *
 TALER_url_absolute_raw (const char *proto,
                         const char *host,

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]