[taler-merchant] 02/08: Doxygen fixes

[gnunet]

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

ms pushed a commit to branch master
in repository merchant.

commit 875611bddc13935f5cb34c37720f7fa1661296cd
Author: MS <ms@taler.net>
AuthorDate: Thu Oct 15 12:00:19 2020 +0200

    Doxygen fixes
---
 src/testing/testing_api_cmd_get_transfers.c      | 13 -------
 src/testing/testing_api_cmd_lock_product.c       | 12 ------
 src/testing/testing_api_cmd_merchant_get_order.c | 38 -------------------
 src/testing/testing_api_cmd_merchant_get_tip.c   | 23 ------------
 src/testing/testing_api_cmd_patch_instance.c     | 20 ----------
 src/testing/testing_api_cmd_patch_product.c      | 26 -------------
 src/testing/testing_api_cmd_pay_order.c          | 16 --------
 src/testing/testing_api_cmd_post_instances.c     | 32 ----------------
 src/testing/testing_api_cmd_post_orders.c        | 48 ------------------------
 src/testing/testing_api_cmd_post_orders_paid.c   | 10 -----
 src/testing/testing_api_cmd_post_products.c      | 23 ------------
 src/testing/testing_api_cmd_post_reserves.c      | 18 ---------
 src/testing/testing_api_cmd_post_transfers.c     | 18 ---------
 13 files changed, 297 deletions(-)

diff --git a/src/testing/testing_api_cmd_get_transfers.c 
b/src/testing/testing_api_cmd_get_transfers.c
index c6dc19c..19e198a 100644
--- a/src/testing/testing_api_cmd_get_transfers.c
+++ b/src/testing/testing_api_cmd_get_transfers.c
@@ -302,19 +302,6 @@ get_transfers_cleanup (void *cls,
 }
 
 
-/**
- * Define a GET /transfers CMD.
- *
- * @param label command label.
- * @param merchant_url base URL of the backend serving the
- *        "refund increase" request.
- * @param payto_uri payto URI to filter by, NULL for no filter
- * @param http_code expected HTTP response code
- * @param ... NULL-terminated list of labels (const char *) of
- *        transfer (commands) we expect to be returned in the list
- *        (assuming @a http_code is #MHD_HTTP_OK)
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_get_transfers (const char *label,
                                           const char *merchant_url,
diff --git a/src/testing/testing_api_cmd_lock_product.c 
b/src/testing/testing_api_cmd_lock_product.c
index 070a6f8..d99c25e 100644
--- a/src/testing/testing_api_cmd_lock_product.c
+++ b/src/testing/testing_api_cmd_lock_product.c
@@ -192,18 +192,6 @@ lock_product_traits (void *cls,
 }
 
 
-/**
- * Define a "LOCK /products/$ID" CMD.
- *
- * @param label command label.
- * @param merchant_url base URL of the merchant serving the
- *        LOCK /product request.
- * @param product_id the ID of the product to lock.
- * @param duration how long the lock should last.
- * @param quantity how money units to lock.
- * @param http_status expected HTTP response code.
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_lock_product (
   const char *label,
diff --git a/src/testing/testing_api_cmd_merchant_get_order.c 
b/src/testing/testing_api_cmd_merchant_get_order.c
index b9ee013..56162b2 100644
--- a/src/testing/testing_api_cmd_merchant_get_order.c
+++ b/src/testing/testing_api_cmd_merchant_get_order.c
@@ -604,21 +604,6 @@ merchant_get_order_cleanup (void *cls,
 }
 
 
-/**
- * Define a GET /private/orders/$ORDER_ID CMD.
- *
- * @param label the command label
- * @param merchant_url base URL of the merchant which will
- *        serve the request.
- * @param order_reference reference to a command that created an order.
- * @param osc expected order status code
- * @param refunded whether the order has been refunded.
- * @param http_status expected HTTP response code for the request.
- * @param ... NULL-terminated list of labels (const char *) of
- *        refunds (commands) we expect to be aggregated in the transfer
- *        (assuming @a http_code is #MHD_HTTP_OK). If @e refunded is false,
- *        this parameter is ignored.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_get_order (const char *label,
                                       const char *merchant_url,
@@ -663,29 +648,6 @@ TALER_TESTING_cmd_merchant_get_order (const char *label,
 }
 
 
-/**
- * Define a GET /private/orders/$ORDER_ID CMD.
- *
- * @param label the command label
- * @param merchant_url base URL of the merchant which will
- *        serve the request.
- * @param order_reference reference to a command that created an order.
- * @param osc expected order status
- * @param wired whether the order has been wired or not.
- * @param transfers NULL-terminated list of labels (const char *) of
- *        wire transfers (commands) we expect to be aggregated in the order
- *        (assuming @a http_code is #MHD_HTTP_OK). If @e paid is fale, this
- *        parameter is ignored.
- * @param refunded whether the order has been refunded.
- * @param refunds NULL-terminated list of labels (const char *) of
- *        refunds (commands) we expect to be aggregated in the order
- *        (assuming @a http_code is #MHD_HTTP_OK). If @e refunded is false,
- *        this parameter is ignored.
- * @param forgets a NULL-terminated list of references to forget commands
- *        that apply to the order we are querying. If NULL, this is
- *        interpreted as no forgets are expected.
- * @param http_status expected HTTP response code for the request.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_get_order2 (const char *label,
                                        const char *merchant_url,
diff --git a/src/testing/testing_api_cmd_merchant_get_tip.c 
b/src/testing/testing_api_cmd_merchant_get_tip.c
index f1d79ee..5d0ba00 100644
--- a/src/testing/testing_api_cmd_merchant_get_tip.c
+++ b/src/testing/testing_api_cmd_merchant_get_tip.c
@@ -308,15 +308,6 @@ merchant_get_tip_cleanup (void *cls,
 }
 
 
-/**
- * Define a GET /private/tips/$TIP_IDE CMD.
- *
- * @param label the command label
- * @param merchant_url base URL of the merchant which will
- *        serve the request.
- * @param tip_reference reference to a command that created a tip.
- * @param http_status expected HTTP response code for the request.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_get_tip (const char *label,
                                     const char *merchant_url,
@@ -342,20 +333,6 @@ TALER_TESTING_cmd_merchant_get_tip (const char *label,
 }
 
 
-/**
- * Define a GET /private/tips/$TIP_ID CMD.
- *
- * @param label the command label
- * @param merchant_url base URL of the merchant which will
- *        serve the request.
- * @param tip_reference reference to a command that created a tip.
- * @param pickup_refs a NULL-terminated list of pickup commands
- *        associated with the tip.
- * @param http_status expected HTTP response code for the request.
- * @param ... NULL-terminated list of labels (const char *) of
- *        pickup (commands) we expect to be returned in the list
- *        (assuming @a http_code is #MHD_HTTP_OK)
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_get_tip_with_pickups (const char *label,
                                                  const char *merchant_url,
diff --git a/src/testing/testing_api_cmd_patch_instance.c 
b/src/testing/testing_api_cmd_patch_instance.c
index eb09c02..5bb5548 100644
--- a/src/testing/testing_api_cmd_patch_instance.c
+++ b/src/testing/testing_api_cmd_patch_instance.c
@@ -263,26 +263,6 @@ patch_instance_cleanup (void *cls,
 }
 
 
-/**
- * Define a "PATCH /instances/$ID" CMD.
- *
- * @param label command label.
- * @param merchant_url base URL of the merchant serving the
- *        PATCH /instance request.
- * @param instance_id the ID of the instance to query
- * @param payto_uris_length length of the @a accounts array
- * @param payto_uris URIs of the bank accounts of the merchant instance
- * @param name name of the merchant instance
- * @param address physical address of the merchant instance
- * @param jurisdiction jurisdiction of the merchant instance
- * @param default_max_wire_fee default maximum wire fee merchant is willing to 
fully pay
- * @param default_wire_fee_amortization default amortization factor for excess 
wire fees
- * @param default_max_deposit_fee default maximum deposit fee merchant is 
willing to pay
- * @param default_wire_transfer_delay default wire transfer delay merchant 
will ask for
- * @param default_pay_delay default validity period for offers merchant makes
- * @param http_status expected HTTP response code.
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_patch_instance (
   const char *label,
diff --git a/src/testing/testing_api_cmd_patch_product.c 
b/src/testing/testing_api_cmd_patch_product.c
index 29c8c18..87e63a4 100644
--- a/src/testing/testing_api_cmd_patch_product.c
+++ b/src/testing/testing_api_cmd_patch_product.c
@@ -247,32 +247,6 @@ patch_product_cleanup (void *cls,
 }
 
 
-/**
- * Define a "PATCH /products/$ID" CMD.
- *
- * @param label command label.
- * @param merchant_url base URL of the merchant serving the
- *        PATCH /product request.
- * @param product_id the ID of the product to query
- * @param description description of the product
- * @param description_i18n Map from IETF BCP 47 language tags to localized 
descriptions
- * @param unit unit in which the product is measured (liters, kilograms, 
packages, etc.)
- * @param price the price for one @a unit of the product, zero is used to 
imply that
- *              this product is not sold separately or that the price is not 
fixed and
- *              must be supplied by the front-end.  If non-zero, price must 
include
- *              applicable taxes.
- * @param image base64-encoded product image
- * @param taxes list of taxes paid by the merchant
- * @param total_stock in @a units, -1 to indicate "infinite" (i.e. electronic 
books)
- * @param total_lost in @a units, must be larger than previous values, and may
- *               not exceed total_stock minus total_sold; if it does, the 
transaction
- *               will fail with a #MHD_HTTP_CONFLICT HTTP status code
- * @param address where the product is in stock
- * @param next_restock when the next restocking is expected to happen, 0 for 
unknown,
- *                     #GNUNET_TIME_UNIT_FOREVER_ABS for 'never'.
- * @param http_status expected HTTP response code.
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_patch_product (
   const char *label,
diff --git a/src/testing/testing_api_cmd_pay_order.c 
b/src/testing/testing_api_cmd_pay_order.c
index 64cb32a..0efa9b4 100644
--- a/src/testing/testing_api_cmd_pay_order.c
+++ b/src/testing/testing_api_cmd_pay_order.c
@@ -479,22 +479,6 @@ pay_traits (void *cls,
 }
 
 
-/**
- * Make a "pay" test command.
- *
- * @param label command label.
- * @param merchant_url merchant base url
- * @param http_status expected HTTP response code.
- * @param proposal_reference the proposal whose payment status
- *        is going to be checked.
- * @param coin_reference reference to any command which is able
- *        to provide coins to use for paying.
- * @param amount_with_fee amount to pay, including the deposit
- *        fee
- * @param amount_without_fee amount to pay, no fees included.
- * @param session_id the session id to use for the payment (can be NULL).
- * @return the command
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_pay_order (const char *label,
                                       const char *merchant_url,
diff --git a/src/testing/testing_api_cmd_post_instances.c 
b/src/testing/testing_api_cmd_post_instances.c
index 6c21b4d..bea5cfb 100644
--- a/src/testing/testing_api_cmd_post_instances.c
+++ b/src/testing/testing_api_cmd_post_instances.c
@@ -266,26 +266,6 @@ post_instances_cleanup (void *cls,
 }
 
 
-/**
- * Define a "POST /instances" CMD.
- *
- * @param label command label.
- * @param merchant_url base URL of the merchant serving the
- *        POST /instances request.
- * @param instance_id the ID of the instance to query
- * @param payto_uris_length length of the @a accounts array
- * @param payto_uris URIs of the bank accounts of the merchant instance
- * @param name name of the merchant instance
- * @param address physical address of the merchant instance
- * @param jurisdiction jurisdiction of the merchant instance
- * @param default_max_wire_fee default maximum wire fee merchant is willing to 
fully pay
- * @param default_wire_fee_amortization default amortization factor for excess 
wire fees
- * @param default_max_deposit_fee default maximum deposit fee merchant is 
willing to pay
- * @param default_wire_transfer_delay default wire transfer delay merchant 
will ask for
- * @param default_pay_delay default validity period for offers merchant makes
- * @param http_status expected HTTP response code.
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_instances2 (
   const char *label,
@@ -341,18 +321,6 @@ TALER_TESTING_cmd_merchant_post_instances2 (
 }
 
 
-/**
- * Define a "POST /instances" CMD, simple version
- *
- * @param label command label.
- * @param merchant_url base URL of the merchant serving the
- *        POST /instances request.
- * @param instance_id the ID of the instance to create
- * @param payto_uri payment URI to use
- * @param currency currency to use for default fees
- * @param http_status expected HTTP response code.
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_instances (const char *label,
                                            const char *merchant_url,
diff --git a/src/testing/testing_api_cmd_post_orders.c 
b/src/testing/testing_api_cmd_post_orders.c
index f7a8dbb..a7ecc1c 100644
--- a/src/testing/testing_api_cmd_post_orders.c
+++ b/src/testing/testing_api_cmd_post_orders.c
@@ -679,19 +679,6 @@ make_order_json (const char *order_id,
 }
 
 
-/**
- * Make the "proposal" command AVOIDING claiming the order.
- *
- * @param label command label
- * @param merchant_url base URL of the merchant serving
- *        the proposal request.
- * @param http_status expected HTTP status.
- * @param order_id the name of the order to add.
- * @param refund_deadline the deadline for refunds on this order.
- * @param pay_deadline the deadline for payment on this order.
- * @param amount the amount this order is for.
- * @return the command
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_orders_no_claim (const char *label,
                                                  const char *merchant_url,
@@ -729,19 +716,6 @@ TALER_TESTING_cmd_merchant_post_orders_no_claim (const 
char *label,
 }
 
 
-/**
- * Make the "proposal" command.
- *
- * @param label command label
- * @param merchant_url base URL of the merchant serving
- *        the proposal request.
- * @param http_status expected HTTP status.
- * @param order_id the name of the order to add.
- * @param refund_deadline the deadline for refunds on this order.
- * @param pay_deadline the deadline for payment on this order.
- * @param amount the amount this order is for.
- * @return the command
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_orders (const char *label,
                                         const char *merchant_url,
@@ -779,28 +753,6 @@ TALER_TESTING_cmd_merchant_post_orders (const char *label,
 }
 
 
-/**
- * Make the "proposal" command.
- *
- * @param label command label
- * @param merchant_url base URL of the merchant serving
- *        the proposal request.
- * @param http_status expected HTTP status.
- * @param order_id the name of the order to add.
- * @param refund_deadline the deadline for refunds on this order.
- * @param pay_deadline the deadline for payment on this order.
- * @param claim_token whether to generate a claim token.
- * @param amount the amount this order is for.
- * @param payment_target payment target for the order.
- * @param products a string indicating the products this order will be
- *        purchasing. Should be formatted as
- *        "[product_id]/[quantity];...".
- * @param locks a string of references to lock product commands that should
- *        be formatted as "[lock_1];[lock_2];...".
- * @param duplicate_of if not NULL, a reference to a previous order command
- *        that should be duplicated and checked for an identical response.
- * @return the command
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_orders2 (const char *label,
                                          const char *merchant_url,
diff --git a/src/testing/testing_api_cmd_post_orders_paid.c 
b/src/testing/testing_api_cmd_post_orders_paid.c
index b6f60da..713e250 100644
--- a/src/testing/testing_api_cmd_post_orders_paid.c
+++ b/src/testing/testing_api_cmd_post_orders_paid.c
@@ -221,16 +221,6 @@ paid_cleanup (void *cls,
 }
 
 
-/**
- * Make an "order paid" test command.
- *
- * @param label command label
- * @param merchant_url merchant base URL
- * @param pay_reference reference to the payment to verify
- * @param session_id the session to use for the verification.
- * @param http_status expected HTTP response code
- * @return the command
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_orders_paid (const char *label,
                                              const char *merchant_url,
diff --git a/src/testing/testing_api_cmd_post_products.c 
b/src/testing/testing_api_cmd_post_products.c
index f728629..6326b79 100644
--- a/src/testing/testing_api_cmd_post_products.c
+++ b/src/testing/testing_api_cmd_post_products.c
@@ -244,29 +244,6 @@ post_products_cleanup (void *cls,
 }
 
 
-/**
- * Define a "POST /products" CMD.
- *
- * @param label command label.
- * @param merchant_url base URL of the merchant serving the
- *        POST /products request.
- * @param product_id the ID of the product to query
- * @param description description of the product
- * @param description_i18n Map from IETF BCP 47 language tags to localized 
descriptions
- * @param unit unit in which the product is measured (liters, kilograms, 
packages, etc.)
- * @param price the price for one @a unit of the product, zero is used to 
imply that
- *              this product is not sold separately or that the price is not 
fixed and
- *              must be supplied by the front-end.  If non-zero, price must 
include
- *              applicable taxes.
- * @param image base64-encoded product image
- * @param taxes list of taxes paid by the merchant
- * @param total_stock in @a units, -1 to indicate "infinite" (i.e. electronic 
books)
- * @param address where the product is in stock
- * @param next_restock when the next restocking is expected to happen, 0 for 
unknown,
- *                     #GNUNET_TIME_UNIT_FOREVER_ABS for 'never'.
- * @param http_status expected HTTP response code.
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_products2 (
   const char *label,
diff --git a/src/testing/testing_api_cmd_post_reserves.c 
b/src/testing/testing_api_cmd_post_reserves.c
index 950ea9b..dbd0c21 100644
--- a/src/testing/testing_api_cmd_post_reserves.c
+++ b/src/testing/testing_api_cmd_post_reserves.c
@@ -227,17 +227,6 @@ post_reserves_cleanup (void *cls,
 }
 
 
-/**
- * Define a "POST /reserves" CMD
- *
- * @param label command label.
- * @param merchant_url url to the merchant.
- * @param initial_balance initial amount in the reserve.
- * @param exchange_url url to the exchange
- * @param wire_method wire transfer method to use for this reserve
- * @param http_status expected HTTP response code.
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_reserves (const char *label,
                                           const char *merchant_url,
@@ -270,13 +259,6 @@ TALER_TESTING_cmd_merchant_post_reserves (const char 
*label,
 }
 
 
-/**
- * This commands does not query the backend at all,
- * but just makes up a fake reserve.
- *
- * @param label command label.
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_reserves_fake (const char *label)
 {
diff --git a/src/testing/testing_api_cmd_post_transfers.c 
b/src/testing/testing_api_cmd_post_transfers.c
index c051ce4..3bfd694 100644
--- a/src/testing/testing_api_cmd_post_transfers.c
+++ b/src/testing/testing_api_cmd_post_transfers.c
@@ -457,24 +457,6 @@ post_transfers_cleanup (void *cls,
 }
 
 
-/**
- * Define a POST /transfers CMD.  Details like the WTID and
- * other required parameters will be extracted from the bank
- * history, using the latest transfer of the specified
- * @a credit_amount to the @a merchant_url.
- *
- * @param label command label.
- * @param merchant_url base URL of the backend serving the
- *        "refund increase" request.
- * @param auth credentials to access the exchange's bank account
- * @param payto_rui URL of the exchange's bank account
- * @param credit_amount amount credited
- * @param http_code expected HTTP response code
- * @param ... NULL-terminated list of labels (const char *) of
- *        deposit (commands) we expect to be aggregated in the transfer
- *        (assuming @a http_code is #MHD_HTTP_OK)
- * @return the command.
- */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_merchant_post_transfer (
   const char *label,

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