[taler-exchange] 01/02: doxygen

[gnunet]

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

grothoff pushed a commit to branch master
in repository exchange.

commit dac255329f4f385d3ccfb544e259d2fae76325df
Author: Christian Grothoff <address@hidden>
AuthorDate: Sat Jan 18 13:07:29 2020 +0100

    doxygen
---
 src/bank-lib/bank_api_transfer.c            |  3 ++-
 src/exchangedb/plugin_exchangedb_postgres.c | 13 ++++++++-----
 src/include/taler_bank_service.h            |  1 +
 src/include/taler_exchangedb_plugin.h       | 24 ++++++++++++++----------
 4 files changed, 25 insertions(+), 16 deletions(-)

diff --git a/src/bank-lib/bank_api_transfer.c b/src/bank-lib/bank_api_transfer.c
index 61f99970..94ad58fd 100644
--- a/src/bank-lib/bank_api_transfer.c
+++ b/src/bank-lib/bank_api_transfer.c
@@ -240,7 +240,8 @@ handle_transfer_finished (void *cls,
 /**
  * Execute a wire transfer.
  *
- * @param cls the @e cls of this struct with the plugin-specific state
+ * @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
diff --git a/src/exchangedb/plugin_exchangedb_postgres.c 
b/src/exchangedb/plugin_exchangedb_postgres.c
index 3958117a..955ced58 100644
--- a/src/exchangedb/plugin_exchangedb_postgres.c
+++ b/src/exchangedb/plugin_exchangedb_postgres.c
@@ -43,7 +43,7 @@
  * when fetching amounts from the database.
  *
  * @param field name of the database field to fetch amount from
- * @param amountp[out] pointer to amount to set
+ * @param[out] amountp pointer to amount to set
  */
 #define TALER_PQ_RESULT_SPEC_AMOUNT(field,amountp) TALER_PQ_result_spec_amount 
( \
     field,pg->currency,amountp)
@@ -53,7 +53,7 @@
  * when fetching amounts from the database.  NBO variant.
  *
  * @param field name of the database field to fetch amount from
- * @param amountp[out] pointer to amount to set
+ * @param[out] amountp pointer to amount to set
  */
 #define TALER_PQ_RESULT_SPEC_AMOUNT_NBO(field,                          \
                                         amountp) 
TALER_PQ_result_spec_amount_nbo ( \
@@ -1990,7 +1990,7 @@ postgres_reserves_in_insert (void *cls,
  * @param session the database session handle
  * @param exchange_account_name name of the section in the exchange's 
configuration
  *                       for the account that we are tracking here
- * @param[out] wire_ref set to unique reference identifying the wire transfer
+ * @param[out] wire_reference set to unique reference identifying the wire 
transfer
  * @return transaction status code
  */
 static enum GNUNET_DB_QueryStatus
@@ -3015,7 +3015,7 @@ postgres_get_known_coin (void *cls,
  * @param cls the plugin closure
  * @param session the database session handle
  * @param coin_pub the public key of the coin to search for
- * @param denom_hash[out] where to store the hash of the coins denomination
+ * @param[out] denom_hash where to store the hash of the coins denomination
  * @return transaction status code
  */
 static enum GNUNET_DB_QueryStatus
@@ -3422,7 +3422,9 @@ postgres_get_melt (void *cls,
  * @param cls the `struct PostgresClosure` with the plugin-specific state
  * @param session database handle to use
  * @param rc commitment hash to use to locate the operation
- * @param[out] refresh_melt where to store the result
+ * @param[out] noreveal_index returns the "gamma" value selected by the
+ *             exchange which is the index of the transfer key that is
+ *             not to be revealed to the exchange
  * @return transaction status
  */
 static enum GNUNET_DB_QueryStatus
@@ -4388,6 +4390,7 @@ struct Work
  * @param cls the `struct PostgresClosure` with the plugin-specific state
  * @param session database connection
  * @param coin_pub coin to investigate
+ * @param include_payback should payback transactions be included in the @a tlp
  * @param[out] tlp set to list of transactions, NULL if coin is fresh
  * @return database transaction status
  */
diff --git a/src/include/taler_bank_service.h b/src/include/taler_bank_service.h
index 1f91a389..6829cf71 100644
--- a/src/include/taler_bank_service.h
+++ b/src/include/taler_bank_service.h
@@ -210,6 +210,7 @@ typedef void
  * Execute a wire transfer.
  *
  * @param ctx context for HTTP interaction
+ * @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
diff --git a/src/include/taler_exchangedb_plugin.h 
b/src/include/taler_exchangedb_plugin.h
index e3798c53..80deec3a 100644
--- a/src/include/taler_exchangedb_plugin.h
+++ b/src/include/taler_exchangedb_plugin.h
@@ -1713,7 +1713,7 @@ struct TALER_EXCHANGEDB_Plugin
    * Get the summary of a reserve.
    *
    * @param cls the @e cls of this struct with the plugin-specific state
-   * @param db the database connection handle
+   * @param session the database connection handle
    * @param[in,out] reserve the reserve data.  The public key of the reserve 
should be set
    *          in this structure; it is used to query the database.  The balance
    *          and expiration are then filled accordingly.
@@ -1721,7 +1721,7 @@ struct TALER_EXCHANGEDB_Plugin
    */
   enum GNUNET_DB_QueryStatus
   (*reserve_get)(void *cls,
-                 struct TALER_EXCHANGEDB_Session *db,
+                 struct TALER_EXCHANGEDB_Session *session,
                  struct TALER_EXCHANGEDB_Reserve *reserve);
 
 
@@ -1730,7 +1730,7 @@ struct TALER_EXCHANGEDB_Plugin
    * also created through this function.
    *
    * @param cls the @e cls of this struct with the plugin-specific state
-   * @param db the database connection handle
+   * @param session the database session handle
    * @param reserve_pub public key of the reserve
    * @param balance the amount that has to be added to the reserve
    * @param execution_time when was the amount added
@@ -1740,7 +1740,7 @@ struct TALER_EXCHANGEDB_Plugin
    */
   enum GNUNET_DB_QueryStatus
   (*reserves_in_insert)(void *cls,
-                        struct TALER_EXCHANGEDB_Session *db,
+                        struct TALER_EXCHANGEDB_Session *session,
                         const struct TALER_ReservePublicKeyP *reserve_pub,
                         const struct TALER_Amount *balance,
                         struct GNUNET_TIME_Absolute execution_time,
@@ -1753,15 +1753,17 @@ struct TALER_EXCHANGEDB_Plugin
    * Obtain the most recent @a wire_reference that was inserted via @e 
reserves_in_insert.
    *
    * @param cls the @e cls of this struct with the plugin-specific state
-   * @param db the database connection handle
-   * @param[out] wire_ref set to unique reference identifying the wire transfer
+   * @param session the database connection handle
+   * @param exchange_account_name name of the section in the exchange's 
configuration
+   *                       for the account that we are tracking here
+   * @param[out] wire_reference set to unique reference identifying the wire 
transfer
    * @return transaction status code
    */
   enum GNUNET_DB_QueryStatus
   (*get_latest_reserve_in_reference)(void *cls,
-                                     struct TALER_EXCHANGEDB_Session *db,
+                                     struct TALER_EXCHANGEDB_Session *session,
                                      const char *exchange_account_name,
-                                     uint64_t *wire_ref);
+                                     uint64_t *wire_reference);
 
 
   /**
@@ -1877,7 +1879,7 @@ struct TALER_EXCHANGEDB_Plugin
    * @param cls the plugin closure
    * @param session the database session handle
    * @param coin_pub the public key of the coin to search for
-   * @param denom_hash[out] where to store the hash of the coins denomination
+   * @param[out] denom_hash where to store the hash of the coins denomination
    * @return transaction status code
    */
   enum GNUNET_DB_QueryStatus
@@ -2104,7 +2106,9 @@ struct TALER_EXCHANGEDB_Plugin
    * @param cls the `struct PostgresClosure` with the plugin-specific state
    * @param session database handle to use
    * @param rc commitment hash to use to locate the operation
-   * @param[out] refresh_melt where to store the result
+   * @param[out] noreveal_index returns the "gamma" value selected by the
+   *             exchange which is the index of the transfer key that is
+   *             not to be revealed to the exchange
    * @return transaction status
    */
   enum GNUNET_DB_QueryStatus

-- 
To stop receiving notification emails like this one, please contact
address@hidden.