[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 d1642d0  doxygen fixes
d1642d0 is described below

commit d1642d0fd0937d87a56914263361dc5985da0247
Author: MS <ms@taler.net>
AuthorDate: Tue Oct 13 12:18:53 2020 +0200

    doxygen fixes
---
 src/lib/merchant_api_common.c          | 44 ----------------------------------
 src/lib/merchant_api_delete_instance.c | 31 ------------------------
 src/lib/merchant_api_delete_order.c    | 16 -------------
 src/lib/merchant_api_delete_product.c  | 17 -------------
 src/lib/merchant_api_delete_reserve.c  | 27 ---------------------
 src/lib/merchant_api_get_config.c      | 18 --------------
 src/lib/merchant_api_get_instance.c    | 19 ---------------
 src/lib/merchant_api_get_instances.c   | 18 --------------
 src/lib/merchant_api_get_orders.c      |  9 -------
 src/lib/merchant_api_get_product.c     | 11 ---------
 src/lib/merchant_api_patch_instance.c  | 27 ---------------------
 11 files changed, 237 deletions(-)

diff --git a/src/lib/merchant_api_common.c b/src/lib/merchant_api_common.c
index 88e6007..255b498 100644
--- a/src/lib/merchant_api_common.c
+++ b/src/lib/merchant_api_common.c
@@ -29,16 +29,6 @@
 #include <taler/taler_json_lib.h>
 
 
-/**
- * Take a @a response from the merchant API that (presumably) contains
- * error details and setup the corresponding @a hr structure. Internally
- * used to convert merchant's responses in to @a hr.
- *
- * @param response, if NULL we will report #TALER_EC_INVALID_RESPONSE in `ec
- * @param http_status http status to use
- * @param[out] hr response object to initialize, fields will
- *        only be valid as long as @a response is valid as well
- */
 void
 TALER_MERCHANT_parse_error_details_ (const json_t *response,
                                      unsigned int http_status,
@@ -118,16 +108,6 @@ TALER_MERCHANT_parse_error_details_ (const json_t 
*response,
 }
 
 
-/**
- * Construct a new base URL using the existing @a base_url
- * and the given @a instance_id.  The result WILL end with
- * '/'.
- *
- * @param base_url a merchant base URL without "/instances/" in it,
- *         must not be the empty string; MAY end with '/'.
- * @param instance_id ID of an instance
- * @return "${base_url}/instances/${instance_id}/"
- */
 char *
 TALER_MERCHANT_baseurl_add_instance (const char *base_url,
                                      const char *instance_id)
@@ -216,13 +196,6 @@ parse_taler_uri_scheme_action (const char *uri,
 }
 
 
-/**
- * Extracts information from a taler://pay URI.
- *
- * @param pay_uri the URI to parse.
- * @param[out] parse_data data extracted from the URI. Must be free'd.
- * @return #GNUNET_SYSERR if @e pay_uri is malformed, #GNUNET_OK otherwise.
- */
 int
 TALER_MERCHANT_parse_pay_uri (const char *pay_uri,
                               struct TALER_MERCHANT_PayUriData *parse_data)
@@ -344,11 +317,6 @@ TALER_MERCHANT_parse_pay_uri (const char *pay_uri,
 }
 
 
-/**
- * Frees data contained in the result of parsing a taler://pay URI.
- *
- * @param parse_data the data to free.
- */
 void
 TALER_MERCHANT_parse_pay_uri_free (
   struct TALER_MERCHANT_PayUriData *parse_data)
@@ -362,13 +330,6 @@ TALER_MERCHANT_parse_pay_uri_free (
 }
 
 
-/**
- * Extracts information from a taler://refund URI.
- *
- * @param refund_uri the URI to parse.
- * @param[out] parse_data data extracted from the URI. Must be free'd.
- * @return #GNUNET_SYSERR if @e refund_uri is malformed, #GNUNET_OK otherwise.
- */
 int
 TALER_MERCHANT_parse_refund_uri (
   const char *refund_uri,
@@ -455,11 +416,6 @@ TALER_MERCHANT_parse_refund_uri (
 }
 
 
-/**
- * Frees data contained in the result of parsing a taler://refund URI.
- *
- * @param parse_data the data to free.
- */
 void
 TALER_MERCHANT_parse_refund_uri_free (
   struct TALER_MERCHANT_RefundUriData *parse_data)
diff --git a/src/lib/merchant_api_delete_instance.c 
b/src/lib/merchant_api_delete_instance.c
index 6147cca..7dab16d 100644
--- a/src/lib/merchant_api_delete_instance.c
+++ b/src/lib/merchant_api_delete_instance.c
@@ -184,19 +184,6 @@ instance_delete (struct GNUNET_CURL_Context *ctx,
 }
 
 
-/**
- * Delete the private key of an instance of a backend, thereby disabling the
- * instance for future requests.  Will preserve the other instance data
- * (i.e. for taxation).
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param instance_id which instance should be deleted
- * @param instances_cb function to call with the
- *        backend's return
- * @param instances_cb_cls closure for @a config_cb
- * @return the instances handle; NULL upon error
- */
 struct TALER_MERCHANT_InstanceDeleteHandle *
 TALER_MERCHANT_instance_delete (struct GNUNET_CURL_Context *ctx,
                                 const char *backend_url,
@@ -213,18 +200,6 @@ TALER_MERCHANT_instance_delete (struct GNUNET_CURL_Context 
*ctx,
 }
 
 
-/**
- * Purge all data associated with an instance. Use with
- * extreme caution.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param instance_id which instance should be deleted
- * @param instances_cb function to call with the
- *        backend's return
- * @param instances_cb_cls closure for @a config_cb
- * @return the instances handle; NULL upon error
- */
 struct TALER_MERCHANT_InstanceDeleteHandle *
 TALER_MERCHANT_instance_purge (struct GNUNET_CURL_Context *ctx,
                                const char *backend_url,
@@ -241,12 +216,6 @@ TALER_MERCHANT_instance_purge (struct GNUNET_CURL_Context 
*ctx,
 }
 
 
-/**
- * Cancel DELETE /instance/$ID request.  Must not be called by clients after
- * the callback was invoked.
- *
- * @param idh request to cancel.
- */
 void
 TALER_MERCHANT_instance_delete_cancel (
   struct TALER_MERCHANT_InstanceDeleteHandle *idh)
diff --git a/src/lib/merchant_api_delete_order.c 
b/src/lib/merchant_api_delete_order.c
index a10b49c..40f4f95 100644
--- a/src/lib/merchant_api_delete_order.c
+++ b/src/lib/merchant_api_delete_order.c
@@ -105,17 +105,6 @@ handle_delete_order_finished (void *cls,
 }
 
 
-/**
- * Make a DELETE /orders/$ID request to delete a order from our
- * inventory.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param order_id identifier of the order
- * @param cb function to call with the backend's deletion status
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
 struct TALER_MERCHANT_OrderDeleteHandle *
 TALER_MERCHANT_order_delete (
   struct GNUNET_CURL_Context *ctx,
@@ -171,11 +160,6 @@ TALER_MERCHANT_order_delete (
 }
 
 
-/**
- * Cancel DELETE /orders/$ID operation.
- *
- * @param odh operation to cancel
- */
 void
 TALER_MERCHANT_order_delete_cancel (
   struct TALER_MERCHANT_OrderDeleteHandle *odh)
diff --git a/src/lib/merchant_api_delete_product.c 
b/src/lib/merchant_api_delete_product.c
index dd4f432..def4de7 100644
--- a/src/lib/merchant_api_delete_product.c
+++ b/src/lib/merchant_api_delete_product.c
@@ -115,17 +115,6 @@ handle_delete_product_finished (void *cls,
 }
 
 
-/**
- * Make a DELETE /products/$ID request to delete a product from our
- * inventory.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param product_id identifier of the product
- * @param cb function to call with the backend's deletion status
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
 struct TALER_MERCHANT_ProductDeleteHandle *
 TALER_MERCHANT_product_delete (
   struct GNUNET_CURL_Context *ctx,
@@ -182,12 +171,6 @@ TALER_MERCHANT_product_delete (
 }
 
 
-/**
- * Cancel DELETE /product/$ID request.  Must not be called by clients after
- * the callback was invoked.
- *
- * @param pdh request to cancel.
- */
 void
 TALER_MERCHANT_product_delete_cancel (
   struct TALER_MERCHANT_ProductDeleteHandle *pdh)
diff --git a/src/lib/merchant_api_delete_reserve.c 
b/src/lib/merchant_api_delete_reserve.c
index d257b43..c46d8ac 100644
--- a/src/lib/merchant_api_delete_reserve.c
+++ b/src/lib/merchant_api_delete_reserve.c
@@ -190,17 +190,6 @@ reserve_delete (struct GNUNET_CURL_Context *ctx,
 }
 
 
-/**
- * Issue a DELETE /reserve/$RESERVE_ID request to the backend.  Only
- * deletes the private key of the reserve, preserves tipping data.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param reserve_pub which reserve should be queried
- * @param cb function to call with the result
- * @param cb_cls closure for @a cb
- * @return handle for this operation, NULL upon errors
- */
 struct TALER_MERCHANT_ReserveDeleteHandle *
 TALER_MERCHANT_reserve_delete (
   struct GNUNET_CURL_Context *ctx,
@@ -218,17 +207,6 @@ TALER_MERCHANT_reserve_delete (
 }
 
 
-/**
- * Issue a DELETE /reserve/$RESERVE_ID request to the backend.
- * Purges the reserve, deleting all associated data. DANGEROUS.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param reserve_pub which reserve should be queried
- * @param cb function to call with the result
- * @param cb_cls closure for @a cb
- * @return handle for this operation, NULL upon errors
- */
 struct TALER_MERCHANT_ReserveDeleteHandle *
 TALER_MERCHANT_reserve_purge (struct GNUNET_CURL_Context *ctx,
                               const char *backend_url,
@@ -245,11 +223,6 @@ TALER_MERCHANT_reserve_purge (struct GNUNET_CURL_Context 
*ctx,
 }
 
 
-/**
- * Cancel a DELETE (or purge) /reserve/$RESERVE_ID request.
- *
- * @param rdh handle to the request to be canceled
- */
 void
 TALER_MERCHANT_reserve_delete_cancel (
   struct TALER_MERCHANT_ReserveDeleteHandle *rdh)
diff --git a/src/lib/merchant_api_get_config.c 
b/src/lib/merchant_api_get_config.c
index f24b089..022364d 100644
--- a/src/lib/merchant_api_get_config.c
+++ b/src/lib/merchant_api_get_config.c
@@ -179,18 +179,6 @@ handle_config_finished (void *cls,
 }
 
 
-/**
- * Get the config data of a merchant. Will connect to the merchant backend
- * and obtain information about the backend.  The respective information will
- * be passed to the @a config_cb once available.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param config_cb function to call with the
- *        backend's config information
- * @param config_cb_cls closure for @a config_cb
- * @return the config check handle; NULL upon error
- */
 struct TALER_MERCHANT_ConfigGetHandle *
 TALER_MERCHANT_config_get (struct GNUNET_CURL_Context *ctx,
                            const char *backend_url,
@@ -231,12 +219,6 @@ TALER_MERCHANT_config_get (struct GNUNET_CURL_Context *ctx,
 }
 
 
-/**
- * Cancel /config request.  Must not be called by clients after
- * the callback was invoked.
- *
- * @param vgh request to cancel.
- */
 void
 TALER_MERCHANT_config_get_cancel (struct TALER_MERCHANT_ConfigGetHandle *vgh)
 {
diff --git a/src/lib/merchant_api_get_instance.c 
b/src/lib/merchant_api_get_instance.c
index 1a60a6a..4ba3c86 100644
--- a/src/lib/merchant_api_get_instance.c
+++ b/src/lib/merchant_api_get_instance.c
@@ -214,19 +214,6 @@ handle_get_instance_finished (void *cls,
 }
 
 
-/**
- * Get the instance data of a backend. Will connect to the merchant backend
- * and obtain information about the instances.  The respective information will
- * be passed to the @a cb once available.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param instance_id identity of the instance to get information about
- * @param cb function to call with the
- *        backend's instances information
- * @param cb_cls closure for @a cb
- * @return the instances handle; NULL upon error
- */
 struct TALER_MERCHANT_InstanceGetHandle *
 TALER_MERCHANT_instance_get (struct GNUNET_CURL_Context *ctx,
                              const char *backend_url,
@@ -275,12 +262,6 @@ TALER_MERCHANT_instance_get (struct GNUNET_CURL_Context 
*ctx,
 }
 
 
-/**
- * Cancel GET /instance/$ID request.  Must not be called by clients after
- * the callback was invoked.
- *
- * @param igh request to cancel.
- */
 void
 TALER_MERCHANT_instance_get_cancel (
   struct TALER_MERCHANT_InstanceGetHandle *igh)
diff --git a/src/lib/merchant_api_get_instances.c 
b/src/lib/merchant_api_get_instances.c
index e7fbc1b..b7a8240 100644
--- a/src/lib/merchant_api_get_instances.c
+++ b/src/lib/merchant_api_get_instances.c
@@ -223,18 +223,6 @@ handle_instances_finished (void *cls,
 }
 
 
-/**
- * Get the instance data of a backend. Will connect to the merchant backend
- * and obtain information about the instances.  The respective information will
- * be passed to the @a instances_cb once available.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param instances_cb function to call with the
- *        backend's instances information
- * @param instances_cb_cls closure for @a config_cb
- * @return the instances handle; NULL upon error
- */
 struct TALER_MERCHANT_InstancesGetHandle *
 TALER_MERCHANT_instances_get (struct GNUNET_CURL_Context *ctx,
                               const char *backend_url,
@@ -274,12 +262,6 @@ TALER_MERCHANT_instances_get (struct GNUNET_CURL_Context 
*ctx,
 }
 
 
-/**
- * Cancel /instances request.  Must not be called by clients after
- * the callback was invoked.
- *
- * @param igh request to cancel.
- */
 void
 TALER_MERCHANT_instances_get_cancel (
   struct TALER_MERCHANT_InstancesGetHandle *igh)
diff --git a/src/lib/merchant_api_get_orders.c 
b/src/lib/merchant_api_get_orders.c
index 631e872..2399cb4 100644
--- a/src/lib/merchant_api_get_orders.c
+++ b/src/lib/merchant_api_get_orders.c
@@ -210,15 +210,6 @@ handle_get_orders_finished (void *cls,
 }
 
 
-/**
- * Make a GET /orders request.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param cb function to call with the backend's inventory information
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
 struct TALER_MERCHANT_OrdersGetHandle *
 TALER_MERCHANT_orders_get (
   struct GNUNET_CURL_Context *ctx,
diff --git a/src/lib/merchant_api_get_product.c 
b/src/lib/merchant_api_get_product.c
index b64f77e..be54d08 100644
--- a/src/lib/merchant_api_get_product.c
+++ b/src/lib/merchant_api_get_product.c
@@ -200,17 +200,6 @@ handle_get_product_finished (void *cls,
 }
 
 
-/**
- * Make a GET /product/$ID request to get details about an
- * individual product.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param product_id identifier of the product to inquire about
- * @param cb function to call with the backend's product information
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
 struct TALER_MERCHANT_ProductGetHandle *
 TALER_MERCHANT_product_get (
   struct GNUNET_CURL_Context *ctx,
diff --git a/src/lib/merchant_api_patch_instance.c 
b/src/lib/merchant_api_patch_instance.c
index 962545c..157714c 100644
--- a/src/lib/merchant_api_patch_instance.c
+++ b/src/lib/merchant_api_patch_instance.c
@@ -149,27 +149,6 @@ handle_patch_instance_finished (void *cls,
 }
 
 
-/**
- * Update instance configuration.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param instance_id identity of the instance to get information about
- * @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 cb function to call with the
- *        backend's instances information
- * @param cb_cls closure for @a config_cb
- * @return the instances handle; NULL upon error
- */
 struct TALER_MERCHANT_InstancePatchHandle *
 TALER_MERCHANT_instance_patch (
   struct GNUNET_CURL_Context *ctx,
@@ -291,12 +270,6 @@ TALER_MERCHANT_instance_patch (
 }
 
 
-/**
- * Cancel PATCH /instances/$ID request.  Must not be called by clients after
- * the callback was invoked.
- *
- * @param iph request to cancel.
- */
 void
 TALER_MERCHANT_instance_patch_cancel (
   struct TALER_MERCHANT_InstancePatchHandle *iph)

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