[taler-merchant] branch master updated: 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.

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

commit a80452b0a0f41cf24b3582dcf7c2cf9b2cb9fdf9
Author: MS <ms@taler.net>
AuthorDate: Tue Oct 13 16:22:48 2020 +0200

    Doxygen fixes
---
 src/lib/merchant_api_get_products.c       |  6 ----
 src/lib/merchant_api_merchant_get_order.c |  5 ----
 src/lib/merchant_api_patch_order_forget.c | 20 -------------
 src/lib/merchant_api_post_order_abort.c   | 21 --------------
 src/lib/merchant_api_post_order_claim.c   | 20 -------------
 src/lib/merchant_api_post_order_pay.c     | 47 -------------------------------
 src/lib/merchant_api_post_orders.c        |  6 ----
 src/lib/merchant_api_tip_pickup.c         | 18 ------------
 src/lib/merchant_api_tip_pickup2.c        | 19 -------------
 9 files changed, 162 deletions(-)

diff --git a/src/lib/merchant_api_get_products.c 
b/src/lib/merchant_api_get_products.c
index 36da7a5..7a74320 100644
--- a/src/lib/merchant_api_get_products.c
+++ b/src/lib/merchant_api_get_products.c
@@ -238,12 +238,6 @@ TALER_MERCHANT_products_get (
 }
 
 
-/**
- * Cancel /products request.  Must not be called by clients after
- * the callback was invoked.
- *
- * @param pgh request to cancel.
- */
 void
 TALER_MERCHANT_products_get_cancel (
   struct TALER_MERCHANT_ProductsGetHandle *pgh)
diff --git a/src/lib/merchant_api_merchant_get_order.c 
b/src/lib/merchant_api_merchant_get_order.c
index e0ffe03..007d419 100644
--- a/src/lib/merchant_api_merchant_get_order.c
+++ b/src/lib/merchant_api_merchant_get_order.c
@@ -547,11 +547,6 @@ TALER_MERCHANT_merchant_order_get (struct 
GNUNET_CURL_Context *ctx,
 }
 
 
-/**
- * Cancel a GET /private/orders/$ORDER request.
- *
- * @param omgh handle to the request to be canceled
- */
 void
 TALER_MERCHANT_merchant_order_get_cancel (
   struct TALER_MERCHANT_OrderMerchantGetHandle *omgh)
diff --git a/src/lib/merchant_api_patch_order_forget.c 
b/src/lib/merchant_api_patch_order_forget.c
index ea65be1..a006c42 100644
--- a/src/lib/merchant_api_patch_order_forget.c
+++ b/src/lib/merchant_api_patch_order_forget.c
@@ -138,19 +138,6 @@ handle_forget_finished (void *cls,
 }
 
 
-/**
- * Run a payment forget operation, which forgets certain fields in an order's
- * contract terms without changing the hash of the contract terms.
- *
- * @param ctx execution context.
- * @param merchant_url base URL of the merchant.
- * @param order_id order to forget.
- * @param fields_length length of @e fields.
- * @param fields the fields in the contract terms to forget.
- * @param cb the callback to call when a reply for this request is available.
- * @param cb_cls closure for @a cb.
- * @return a handle for this request.
- */
 struct TALER_MERCHANT_OrderForgetHandle *
 TALER_MERCHANT_order_forget (struct GNUNET_CURL_Context *ctx,
                              const char *merchant_url,
@@ -245,13 +232,6 @@ TALER_MERCHANT_order_forget (struct GNUNET_CURL_Context 
*ctx,
 }
 
 
-/**
- * Cancel a PATCH /orders/$ID/forget request.  Note that if you cancel a 
request
- * like this, you have no assurance that the request has not yet been
- * forwarded to the merchant.
- *
- * @param ofh the forget request handle
- */
 void
 TALER_MERCHANT_order_forget_cancel (struct
                                     TALER_MERCHANT_OrderForgetHandle *ofh)
diff --git a/src/lib/merchant_api_post_order_abort.c 
b/src/lib/merchant_api_post_order_abort.c
index 162fe57..31c589b 100644
--- a/src/lib/merchant_api_post_order_abort.c
+++ b/src/lib/merchant_api_post_order_abort.c
@@ -321,21 +321,6 @@ handle_abort_finished (void *cls,
 }
 
 
-/**
- * Run an abort operation, asking for refunds for coins
- * that were previously spend on a/pay that failed to go through.
- *
- * @param ctx execution context
- * @param merchant_url base URL of the merchant
- * @param order_id order to abort
- * @param h_contract hash of the contact of the merchant with the customer
- * @param merchant_pub the public key of the merchant (used to identify the 
merchant for refund requests)
- * @param num_coins number of coins used to pay
- * @param coins array of coins we use to pay
- * @param cb the callback to call when a reply for this request is available
- * @param cb_cls closure for @a pay_cb
- * @return a handle for this request
- */
 struct TALER_MERCHANT_OrderAbortHandle *
 TALER_MERCHANT_order_abort (struct GNUNET_CURL_Context *ctx,
                             const char *merchant_url,
@@ -452,12 +437,6 @@ TALER_MERCHANT_order_abort (struct GNUNET_CURL_Context 
*ctx,
 }
 
 
-/**
- * Cancel an abort request.  This function cannot be used on a request handle
- * if a response is already served for it.
- *
- * @param oah the pay permission request handle
- */
 void
 TALER_MERCHANT_order_abort_cancel (struct TALER_MERCHANT_OrderAbortHandle *oah)
 {
diff --git a/src/lib/merchant_api_post_order_claim.c 
b/src/lib/merchant_api_post_order_claim.c
index 2fa6e87..7b88784 100644
--- a/src/lib/merchant_api_post_order_claim.c
+++ b/src/lib/merchant_api_post_order_claim.c
@@ -165,21 +165,6 @@ handle_post_order_claim_finished (void *cls,
 }
 
 
-/**
- * Calls the POST /orders/$ID/claim API at the backend.  That is,
- * retrieve the final contract terms including the client nonce.
- *
- * This is a PUBLIC API for wallets.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param order_id order id used to perform the lookup
- * @param nonce nonce to use to claim the proposal
- * @param claim_token the token used to verify the claim
- * @param cb callback which will work the response gotten from the backend
- * @param cb_cls closure to pass to @a cb
- * @return handle for this handle, NULL upon errors
- */
 struct TALER_MERCHANT_OrderClaimHandle *
 TALER_MERCHANT_order_claim (struct GNUNET_CURL_Context *ctx,
                             const char *backend_url,
@@ -258,11 +243,6 @@ TALER_MERCHANT_order_claim (struct GNUNET_CURL_Context 
*ctx,
 }
 
 
-/**
- * Cancel a POST /orders/$ID/claim request.
- *
- * @param och handle to the request to be canceled
- */
 void
 TALER_MERCHANT_order_claim_cancel (struct TALER_MERCHANT_OrderClaimHandle *och)
 {
diff --git a/src/lib/merchant_api_post_order_pay.c 
b/src/lib/merchant_api_post_order_pay.c
index 05c798c..a9abdfa 100644
--- a/src/lib/merchant_api_post_order_pay.c
+++ b/src/lib/merchant_api_post_order_pay.c
@@ -406,22 +406,6 @@ handle_pay_finished (void *cls,
 }
 
 
-/**
- * PAY a merchant.  API for frontends talking to backends. Here,
- * the frontend does not have the coin's private keys, but just
- * the public keys and signatures.  Note the subtle difference
- * in the type of @a coins compared to #TALER_MERCHANT_pay().
- *
- * @param ctx the execution loop context
- * @param merchant_url base URL of the merchant's backend
- * @param order_id order to pay
- * @param session_id session to pay for, or NULL for none
- * @param num_coins number of coins used to pay
- * @param coins array of coins we use to pay
- * @param pay_cb the callback to call when a reply for this request is 
available
- * @param pay_cb_cls closure for @a pay_cb
- * @return a handle for this request
- */
 struct TALER_MERCHANT_OrderPayHandle *
 TALER_MERCHANT_order_pay_frontend (
   struct GNUNET_CURL_Context *ctx,
@@ -592,31 +576,6 @@ TALER_MERCHANT_order_pay_frontend (
 }
 
 
-/**
- * Pay a merchant.  API for wallets that have the coin's private keys.
- * _NOTE_: this function does NOT calculate each coin amount in order
- * to match the contract total price.  This calculation is to be made
- * by the logic using this library.
- *
- * @param ctx the execution loop context
- * @param merchant_url base URL of the merchant's backend
- * @param session_id session to pay for, or NULL for none
- * @param h_contract_terms hashcode of the proposal being paid
- * @param amount total value of the contract to be paid to the merchant
- * @param max_fee maximum fee covered by the merchant (according to the 
contract)
- * @param merchant_pub the public key of the merchant (used to identify the 
merchant for refund requests)
- * @param merchant_sig signature from the merchant over the original contract
- * @param timestamp timestamp when the contract was finalized, must match 
approximately the current time of the merchant
- * @param refund_deadline date until which the merchant can issue a refund to 
the customer via the merchant (can be zero if refunds are not allowed)
- * @param pay_deadline maximum time limit to pay for this contract
- * @param h_wire hash of the merchant’s account details
- * @param order_id order id of the proposal being paid
- * @param num_coins number of coins used to pay
- * @param coins array of coins we use to pay
- * @param pay_cb the callback to call when a reply for this request is 
available
- * @param pay_cb_cls closure for @a pay_cb
- * @return a handle for this request
- */
 struct TALER_MERCHANT_OrderPayHandle *
 TALER_MERCHANT_order_pay (struct GNUNET_CURL_Context *ctx,
                           const char *merchant_url,
@@ -717,12 +676,6 @@ TALER_MERCHANT_order_pay (struct GNUNET_CURL_Context *ctx,
 }
 
 
-/**
- * Cancel a pay request.  This function cannot be used on a request handle if
- * a response is already served for it.
- *
- * @param oph the pay request handle
- */
 void
 TALER_MERCHANT_order_pay_cancel (struct TALER_MERCHANT_OrderPayHandle *oph)
 {
diff --git a/src/lib/merchant_api_post_orders.c 
b/src/lib/merchant_api_post_orders.c
index 587a059..77b140d 100644
--- a/src/lib/merchant_api_post_orders.c
+++ b/src/lib/merchant_api_post_orders.c
@@ -328,12 +328,6 @@ TALER_MERCHANT_orders_post2 (
 }
 
 
-/**
- * Cancel a POST /proposal request.  This function cannot be used
- * on a request handle if a response is already served for it.
- *
- * @param po the proposal operation request handle
- */
 void
 TALER_MERCHANT_orders_post_cancel (
   struct TALER_MERCHANT_PostOrdersOperation *po)
diff --git a/src/lib/merchant_api_tip_pickup.c 
b/src/lib/merchant_api_tip_pickup.c
index 24ab7eb..9cd5fb5 100644
--- a/src/lib/merchant_api_tip_pickup.c
+++ b/src/lib/merchant_api_tip_pickup.c
@@ -167,19 +167,6 @@ pickup_done_cb (void *cls,
 }
 
 
-/**
- * Issue a /tip-pickup request to the backend.  Informs the backend
- * that a customer wants to pick up a tip.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param tip_id unique identifier for the tip
- * @param num_planches number of planchets provided in @a pds
- * @param pds array of planchet secrets to be signed into existence for the tip
- * @param pickup_cb callback which will work the response gotten from the 
backend
- * @param pickup_cb_cls closure to pass to @a pickup_cb
- * @return handle for this operation, NULL upon errors
- */
 struct TALER_MERCHANT_TipPickupHandle *
 TALER_MERCHANT_tip_pickup (struct GNUNET_CURL_Context *ctx,
                            const char *backend_url,
@@ -243,11 +230,6 @@ TALER_MERCHANT_tip_pickup (struct GNUNET_CURL_Context *ctx,
 }
 
 
-/**
- * Cancel a pending /tip-pickup request
- *
- * @param tp handle from the operation to cancel
- */
 void
 TALER_MERCHANT_tip_pickup_cancel (struct TALER_MERCHANT_TipPickupHandle *tp)
 {
diff --git a/src/lib/merchant_api_tip_pickup2.c 
b/src/lib/merchant_api_tip_pickup2.c
index ec916f8..8009687 100644
--- a/src/lib/merchant_api_tip_pickup2.c
+++ b/src/lib/merchant_api_tip_pickup2.c
@@ -222,19 +222,6 @@ handle_tip_pickup_finished (void *cls,
 }
 
 
-/**
- * Issue a /tips/$ID/tip-pickup request to the backend.  Informs the backend
- * that a customer wants to pick up a tip.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param tip_id unique identifier for the tip
- * @param num_planches number of planchets provided in @a planchets
- * @param planchets array of planchets to be signed into existence for the tip
- * @param pickup_cb callback which will work the response gotten from the 
backend
- * @param pickup_cb_cls closure to pass to @a pickup_cb
- * @return handle for this operation, NULL upon errors
- */
 struct TALER_MERCHANT_TipPickup2Handle *
 TALER_MERCHANT_tip_pickup2 (struct GNUNET_CURL_Context *ctx,
                             const char *backend_url,
@@ -350,12 +337,6 @@ TALER_MERCHANT_tip_pickup2 (struct GNUNET_CURL_Context 
*ctx,
 }
 
 
-/**
- * Cancel a /tips/$TIP_ID/pickup request.  This function cannot be used
- * on a request handle if a response is already served for it.
- *
- * @param tpo handle to the tracking operation being cancelled
- */
 void
 TALER_MERCHANT_tip_pickup2_cancel (
   struct TALER_MERCHANT_TipPickup2Handle *tpo)

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