From 01126ed1389937fe6f4d2fe7c0a4ca27026bb57c Mon Sep 17 00:00:00 2001 From: MS Date: Thu, 15 Oct 2020 16:20:25 +0200 Subject: Doxygen fixes --- src/lib/merchant_api_get_orders.c | 6 ----- src/lib/merchant_api_get_reserves.c | 19 -------------- src/lib/merchant_api_get_transfers.c | 33 ------------------------ src/lib/merchant_api_lock_product.c | 6 ----- src/lib/merchant_api_merchant_get_tip.c | 5 ---- src/lib/merchant_api_post_order_paid.c | 22 ---------------- src/lib/merchant_api_post_order_refund.c | 16 ------------ src/lib/merchant_api_post_reserves.c | 12 --------- src/lib/merchant_api_post_transfers.c | 15 ----------- src/lib/merchant_api_tip_authorize.c | 34 ------------------------- src/lib/merchant_api_wallet_post_order_refund.c | 15 ----------- 11 files changed, 183 deletions(-) (limited to 'src/lib') diff --git a/src/lib/merchant_api_get_orders.c b/src/lib/merchant_api_get_orders.c index ef853983..d1f2843b 100644 --- a/src/lib/merchant_api_get_orders.c +++ b/src/lib/merchant_api_get_orders.c @@ -349,12 +349,6 @@ TALER_MERCHANT_orders_get2 ( } -/** - * Cancel /orders request. Must not be called by clients after - * the callback was invoked. - * - * @param ogh request to cancel. - */ void TALER_MERCHANT_orders_get_cancel ( struct TALER_MERCHANT_OrdersGetHandle *ogh) diff --git a/src/lib/merchant_api_get_reserves.c b/src/lib/merchant_api_get_reserves.c index b64d76d6..524f3b68 100644 --- a/src/lib/merchant_api_get_reserves.c +++ b/src/lib/merchant_api_get_reserves.c @@ -208,20 +208,6 @@ handle_reserves_get_finished (void *cls, } -/** - * Issue a GET /reserves request to the backend. Informs the backend - * that a customer wants to pick up a reserves. - * - * @param ctx execution context - * @param backend_url base URL of the merchant backend - * @param after filter for reserves created after this date, use 0 for no filtering - * @param active filter for reserves that are active - * @param failures filter for reserves where we disagree about the balance with - * the exchange - * @param cb function to call with the result(s) - * @param cb_cls closure for @a cb - * @return handle for this operation, NULL upon errors - */ struct TALER_MERCHANT_ReservesGetHandle * TALER_MERCHANT_reserves_get (struct GNUNET_CURL_Context *ctx, const char *backend_url, @@ -277,11 +263,6 @@ TALER_MERCHANT_reserves_get (struct GNUNET_CURL_Context *ctx, } -/** - * Cancel a GET /reserves request. - * - * @param rgh handle to the request to be canceled - */ void TALER_MERCHANT_reserves_get_cancel ( struct TALER_MERCHANT_ReservesGetHandle *rgh) diff --git a/src/lib/merchant_api_get_transfers.c b/src/lib/merchant_api_get_transfers.c index a9fc5fd1..481f7abd 100644 --- a/src/lib/merchant_api_get_transfers.c +++ b/src/lib/merchant_api_get_transfers.c @@ -216,33 +216,6 @@ handle_transfers_get_finished (void *cls, } -/** - * Request backend to return list of all wire transfers that - * we received (or that the exchange claims we should have received). - * - * Note that when filtering by timestamp (using “before” and/or “after”), we - * use the time reported by the exchange and thus will ONLY return results for - * which we already have a response from the exchange. This should be - * virtually all transfers, however it is conceivable that for some transfer - * the exchange responded with a temporary error (i.e. HTTP status 500+) and - * then we do not yet have an execution time to filter by. Thus, IF timestamp - * filters are given, transfers for which we have no response from the - * exchange yet are automatically excluded. - * - * @param ctx execution context - * @param backend_url base URL of the backend - * @param payto_uri filter by this credit account of the merchant - * @param before limit to transactions before this timestamp, use - * #GNUNET_TIME_UNIT_FOREVER_ABS to not filter by @a before - * @param after limit to transactions after this timestamp, use - * #GNUNET_TIME_UNIT_ZERO_ABS to not filter by @a after - * @param limit return at most this number of results; negative to descend in execution time - * @param offset start at this "credit serial" number (exclusive) - * @param verified filter results by verification status - * @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_GetTransfersHandle * TALER_MERCHANT_transfers_get ( struct GNUNET_CURL_Context *ctx, @@ -327,12 +300,6 @@ TALER_MERCHANT_transfers_get ( } -/** - * Cancel a GET /transfers request. This function cannot be used - * on a request handle if a response is already served for it. - * - * @param gth handle to the tracking operation being cancelled - */ void TALER_MERCHANT_transfers_get_cancel ( struct TALER_MERCHANT_GetTransfersHandle *gth) diff --git a/src/lib/merchant_api_lock_product.c b/src/lib/merchant_api_lock_product.c index fba0a029..906ca68c 100644 --- a/src/lib/merchant_api_lock_product.c +++ b/src/lib/merchant_api_lock_product.c @@ -227,12 +227,6 @@ TALER_MERCHANT_product_lock ( } -/** - * Cancel POST /products/$ID/lock request. Must not be called by clients after - * the callback was invoked. - * - * @param plh request to cancel. - */ void TALER_MERCHANT_product_lock_cancel ( struct TALER_MERCHANT_ProductLockHandle *plh) diff --git a/src/lib/merchant_api_merchant_get_tip.c b/src/lib/merchant_api_merchant_get_tip.c index deb6272c..09c9fb76 100644 --- a/src/lib/merchant_api_merchant_get_tip.c +++ b/src/lib/merchant_api_merchant_get_tip.c @@ -305,11 +305,6 @@ TALER_MERCHANT_merchant_tip_get (struct GNUNET_CURL_Context *ctx, } -/** - * Cancel a GET /private/tips/$TIP_ID request. - * - * @param tgh handle to the request to be canceled - */ void TALER_MERCHANT_merchant_tip_get_cancel (struct TALER_MERCHANT_TipMerchantGetHandle *tgh) diff --git a/src/lib/merchant_api_post_order_paid.c b/src/lib/merchant_api_post_order_paid.c index 42f27ccd..5424ad8b 100644 --- a/src/lib/merchant_api_post_order_paid.c +++ b/src/lib/merchant_api_post_order_paid.c @@ -159,23 +159,6 @@ handle_paid_finished (void *cls, } -/** - * Send proof of payment to a merchant. - * - * This is a PUBLIC API, albeit in this form useful for the frontend, - * in case the frontend is proxying the request. - * - * @param ctx execution context - * @param merchant_url base URL of the merchant - * @param order_id which order should be paid - * @param session_id session to pay for, or NULL for none - * @param h_contract_terms hash of the contract terms - * @param merchant_sig signature from the merchant - * affirming payment, or NULL on errors - * @param paid_cb the callback to call when a reply for this request is available - * @param paid_cb_cls closure for @a paid_cb - * @return a handle for this request - */ struct TALER_MERCHANT_OrderPaidHandle * TALER_MERCHANT_order_paid ( struct GNUNET_CURL_Context *ctx, @@ -254,11 +237,6 @@ TALER_MERCHANT_order_paid ( } -/** - * Cancel POST /orders/$ID/paid operation. - * - * @param oph operation to cancel - */ void TALER_MERCHANT_order_paid_cancel ( struct TALER_MERCHANT_OrderPaidHandle *oph) diff --git a/src/lib/merchant_api_post_order_refund.c b/src/lib/merchant_api_post_order_refund.c index a67279ae..c40fb7a7 100644 --- a/src/lib/merchant_api_post_order_refund.c +++ b/src/lib/merchant_api_post_order_refund.c @@ -155,11 +155,6 @@ handle_refund_finished (void *cls, } -/** - * Cancel a POST /orders/ID/refund request. - * - * @param orh the refund increasing operation to cancel - */ void TALER_MERCHANT_post_order_refund_cancel ( struct TALER_MERCHANT_OrderRefundHandle *orh) @@ -175,17 +170,6 @@ TALER_MERCHANT_post_order_refund_cancel ( } -/** - * Increase the refund granted for an order - * - * @param ctx the CURL context used to connect to the backend - * @param backend_url backend's base URL, including final "/" - * @param order_id id of the order whose refund is to be increased - * @param refund amount to which increase the refund - * @param reason human-readable reason justifying the refund - * @param cb callback processing the response from /refund - * @param cb_cls closure for cb - */ struct TALER_MERCHANT_OrderRefundHandle * TALER_MERCHANT_post_order_refund (struct GNUNET_CURL_Context *ctx, const char *backend_url, diff --git a/src/lib/merchant_api_post_reserves.c b/src/lib/merchant_api_post_reserves.c index 68761000..fa471984 100644 --- a/src/lib/merchant_api_post_reserves.c +++ b/src/lib/merchant_api_post_reserves.c @@ -164,18 +164,6 @@ handle_post_reserves_finished (void *cls, } -/** - * Request backend to create a reserve. - * - * @param ctx execution context - * @param backend_url base URL of the backend - * @param initial_balance desired initial balance for the reserve - * @param exchange_url what is the URL of the exchange where the reserve should be set up - * @param wire_method desired wire method, for example "iban" or "x-taler-bank" - * @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_PostReservesHandle * TALER_MERCHANT_reserves_post ( struct GNUNET_CURL_Context *ctx, diff --git a/src/lib/merchant_api_post_transfers.c b/src/lib/merchant_api_post_transfers.c index ae288a8e..5d35f6e8 100644 --- a/src/lib/merchant_api_post_transfers.c +++ b/src/lib/merchant_api_post_transfers.c @@ -227,21 +227,6 @@ handle_post_transfers_finished (void *cls, } -/** - * Request backend to remember that we received the given - * wire transfer and to request details about the aggregated - * transactions from the exchange. - * - * @param ctx execution context - * @param backend_url base URL of the backend - * @param credit_amount how much money did we receive (without wire fee) - * @param wtid base32 string indicating a wtid - * @param payto_uri which account was credited by the wire transfer - * @param exchange_url what is the URL of the exchange that made the transfer - * @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_PostTransfersHandle * TALER_MERCHANT_transfers_post ( struct GNUNET_CURL_Context *ctx, diff --git a/src/lib/merchant_api_tip_authorize.c b/src/lib/merchant_api_tip_authorize.c index 2418ff2d..57f2e2c0 100644 --- a/src/lib/merchant_api_tip_authorize.c +++ b/src/lib/merchant_api_tip_authorize.c @@ -206,20 +206,6 @@ handle_tip_authorize_finished (void *cls, } -/** - * Issue a /tip-authorize request to the backend. Informs the backend - * that a tip should be created. - * - * @param ctx execution context - * @param backend_url base URL of the merchant backend - * @param reserve_pub public key of the reserve - * @param next_url where the browser should proceed after picking up the tip - * @param amount amount to be handed out as a tip - * @param justification which justification should be stored (human-readable reason for the tip) - * @param authorize_cb callback which will work the response gotten from the backend - * @param authorize_cb_cls closure to pass to @a authorize_cb - * @return handle for this operation, NULL upon errors - */ struct TALER_MERCHANT_TipAuthorizeHandle * TALER_MERCHANT_tip_authorize2 ( struct GNUNET_CURL_Context *ctx, @@ -310,20 +296,6 @@ TALER_MERCHANT_tip_authorize2 ( } -/** - * Issue a POST /tips request to the backend. Informs the backend that a tip - * should be created. In contrast to #TALER_MERCHANT_tip_authorize2(), the - * backend gets to pick the reserve with this API. - * - * @param ctx execution context - * @param backend_url base URL of the merchant backend - * @param next_url where the browser should proceed after picking up the tip - * @param amount amount to be handed out as a tip - * @param justification which justification should be stored (human-readable reason for the tip) - * @param authorize_cb callback which will work the response gotten from the backend - * @param authorize_cb_cls closure to pass to @a authorize_cb - * @return handle for this operation, NULL upon errors - */ struct TALER_MERCHANT_TipAuthorizeHandle * TALER_MERCHANT_tip_authorize (struct GNUNET_CURL_Context *ctx, const char *backend_url, @@ -397,12 +369,6 @@ TALER_MERCHANT_tip_authorize (struct GNUNET_CURL_Context *ctx, } -/** - * Cancel a /track/transaction request. This function cannot be used - * on a request handle if a response is already served for it. - * - * @param tao handle to the tracking operation being cancelled - */ void TALER_MERCHANT_tip_authorize_cancel ( struct TALER_MERCHANT_TipAuthorizeHandle *tao) diff --git a/src/lib/merchant_api_wallet_post_order_refund.c b/src/lib/merchant_api_wallet_post_order_refund.c index 4f83ad4c..ad56b6d3 100644 --- a/src/lib/merchant_api_wallet_post_order_refund.c +++ b/src/lib/merchant_api_wallet_post_order_refund.c @@ -343,16 +343,6 @@ handle_refund_finished (void *cls, } -/** - * Obtain the refunds that have been granted for an order. - * - * @param ctx the CURL context used to connect to the backend - * @param backend_url backend's base URL, including final "/" - * @param order_id id of the order whose refund is to be increased - * @param h_contract_terms hash of the contract terms of the order - * @param cb callback processing the response from /refund - * @param cb_cls closure for cb - */ struct TALER_MERCHANT_WalletOrderRefundHandle * TALER_MERCHANT_wallet_post_order_refund ( struct GNUNET_CURL_Context *ctx, @@ -425,11 +415,6 @@ TALER_MERCHANT_wallet_post_order_refund ( } -/** - * Cancel a (public) POST /refund request. - * - * @param orh the refund operation to cancel - */ void TALER_MERCHANT_wallet_post_order_refund_cancel ( struct TALER_MERCHANT_WalletOrderRefundHandle *orh) -- cgit v1.2.3