From c383b89f3d108fc10a06e3afcf03e44eafe838eb Mon Sep 17 00:00:00 2001 From: MS Date: Fri, 9 Oct 2020 19:27:00 +0200 Subject: address doxygen warnings (double definitions of @param) --- src/backend/taler-merchant-httpd_auditors.c | 21 ----------- src/backend/taler-merchant-httpd_config.c | 9 ----- src/backend/taler-merchant-httpd_exchanges.c | 43 ---------------------- src/backend/taler-merchant-httpd_get-orders-ID.c | 31 ---------------- src/backend/taler-merchant-httpd_get-tips-ID.c | 27 -------------- src/backend/taler-merchant-httpd_mhd.c | 24 ------------ .../taler-merchant-httpd_post-orders-ID-abort.c | 13 ------- .../taler-merchant-httpd_post-orders-ID-claim.c | 10 ----- .../taler-merchant-httpd_post-orders-ID-paid.c | 9 ----- 9 files changed, 187 deletions(-) diff --git a/src/backend/taler-merchant-httpd_auditors.c b/src/backend/taler-merchant-httpd_auditors.c index b75952f6..1609e2b1 100644 --- a/src/backend/taler-merchant-httpd_auditors.c +++ b/src/backend/taler-merchant-httpd_auditors.c @@ -61,19 +61,6 @@ static unsigned int nauditors; */ json_t *j_auditors; - -/** - * Check if the given @a dk issued by exchange @a mh is audited by - * an auditor that is acceptable for this merchant. (And if the - * denomination is not yet expired or something silly like that.) - * - * @param mh exchange issuing @a dk - * @param dk a denomination issued by @a mh - * @param exchange_trusted true if the exchange of @a dk is trusted by config - * @param[out] hc HTTP status code to return (on error) - * @param[out] ec Taler error code to return (on error) - * @return #GNUNET_OK - */ int TMH_AUDITORS_check_dk (struct TALER_EXCHANGE_Handle *mh, const struct TALER_EXCHANGE_DenomPublicKey *dk, @@ -229,14 +216,6 @@ parse_auditors (void *cls, auditor); } - -/** - * Parses auditor information from the configuration. - * - * @param cfg the configuration - * @return the number of auditors found; #GNUNET_SYSERR upon error in - * parsing. - */ int TMH_AUDITORS_init (const struct GNUNET_CONFIGURATION_Handle *cfg) { diff --git a/src/backend/taler-merchant-httpd_config.c b/src/backend/taler-merchant-httpd_config.c index 654087ff..a4d6d0f8 100644 --- a/src/backend/taler-merchant-httpd_config.c +++ b/src/backend/taler-merchant-httpd_config.c @@ -44,15 +44,6 @@ */ #define MERCHANT_PROTOCOL_VERSION "1:0:0" - -/** - * Handle a "/config" request. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @param[in,out] hc handler context (can be updated) - * @return MHD result code - */ MHD_RESULT MH_handler_config (struct TMH_RequestHandler *rh, struct MHD_Connection *connection, diff --git a/src/backend/taler-merchant-httpd_exchanges.c b/src/backend/taler-merchant-httpd_exchanges.c index 9dc0829d..1d5db7e5 100644 --- a/src/backend/taler-merchant-httpd_exchanges.c +++ b/src/backend/taler-merchant-httpd_exchanges.c @@ -604,15 +604,6 @@ process_find_operations (struct Exchange *exchange) return need_wire; } - -/** - * Check if we have any remaining pending requests for the - * given @a exchange, and if we have the required data, call - * the callback. If requests without /wire data remain, - * retry the /wire request after some delay. - * - * @param cls a `struct Exchange` to check - */ static void wire_task_cb (void *cls); @@ -949,23 +940,6 @@ return_result (void *cls) } } - -/** - * Find a exchange that matches @a chosen_exchange. If we cannot connect - * to the exchange, or if it is not acceptable, @a fc is called with - * NULL for the exchange. - * - * @param chosen_exchange URL of the exchange we would like to talk to - * @param wire_method the wire method we will use with @a chosen_exchange, NULL for none - * @param force_reload try to force reloading /keys from the exchange ASAP; note - * that IF the forced reload fails, it is possible @a fc won't be called at all - * until a /keys download succeeds; only use #GNUNET_YES if a new /keys request - * is mandatory. If the force reload request is not allowed due to our rate limiting, - * then @a fc will be called immediately with the existing /keys data - * @param fc function to call with the handles for the exchange - * @param fc_cls closure for @a fc - * @return NULL on error - */ struct TMH_EXCHANGES_FindOperation * TMH_EXCHANGES_find_exchange (const char *chosen_exchange, const char *wire_method, @@ -1082,11 +1056,6 @@ TMH_EXCHANGES_find_exchange (const char *chosen_exchange, } -/** - * Abort pending find operation. - * - * @param fo handle to operation to abort - */ void TMH_EXCHANGES_find_exchange_cancel (struct TMH_EXCHANGES_FindOperation *fo) { @@ -1200,14 +1169,6 @@ accept_exchanges (void *cls, exchange); } - -/** - * Parses "trusted" exchanges listed in the configuration. - * - * @param cfg the configuration - * @return number of trusted exchanges on success; #GNUNET_SYSERR upon error in - * parsing. - */ int TMH_EXCHANGES_init (const struct GNUNET_CONFIGURATION_Handle *cfg) { @@ -1247,10 +1208,6 @@ TMH_EXCHANGES_init (const struct GNUNET_CONFIGURATION_Handle *cfg) return json_array_size (TMH_trusted_exchanges); } - -/** - * Function called to shutdown the exchanges subsystem. - */ void TMH_EXCHANGES_done () { diff --git a/src/backend/taler-merchant-httpd_get-orders-ID.c b/src/backend/taler-merchant-httpd_get-orders-ID.c index d905bb02..a6f0c3b2 100644 --- a/src/backend/taler-merchant-httpd_get-orders-ID.c +++ b/src/backend/taler-merchant-httpd_get-orders-ID.c @@ -270,18 +270,6 @@ make_taler_refund_uri (struct MHD_Connection *con, } -/** - * Create a http(s) URL for the given @a con and @a order_id - * and @a instance_id to display the /orders/{order_id} page. - * - * @param con HTTP connection - * @param order_id the order id - * @param session_id the session id - * @param instance_id instance, may be "default" - * @param claim_token claim token for the order, may be NULL - * @param h_contract contract hash for authentication, may be NULL - * @return corresponding http(s):// URL, or NULL on missing "host" - */ char * TMH_make_order_status_url (struct MHD_Connection *con, const char *order_id, @@ -384,17 +372,6 @@ TMH_make_order_status_url (struct MHD_Connection *con, } -/** - * Create a taler://pay/ URI for the given @a con and @a order_id - * and @a session_id and @a instance_id. - * - * @param con HTTP connection - * @param order_id the order id - * @param session_id session, may be NULL - * @param instance_id instance, may be "default" - * @param claim_token claim token for the order, may be NULL - * @return corresponding taler://pay/ URI, or NULL on missing "host" - */ char * TMH_make_taler_pay_uri (struct MHD_Connection *con, const char *order_id, @@ -687,14 +664,6 @@ god_cleanup (void *cls) } -/** - * Handle a GET "/orders/$ID" request. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @param[in,out] hc context with further information about the request - * @return MHD result code - */ MHD_RESULT TMH_get_orders_ID (const struct TMH_RequestHandler *rh, struct MHD_Connection *connection, diff --git a/src/backend/taler-merchant-httpd_get-tips-ID.c b/src/backend/taler-merchant-httpd_get-tips-ID.c index e7ae703c..5fa257fc 100644 --- a/src/backend/taler-merchant-httpd_get-tips-ID.c +++ b/src/backend/taler-merchant-httpd_get-tips-ID.c @@ -28,16 +28,6 @@ #include "taler-merchant-httpd_qr.h" #include "taler-merchant-httpd_templating.h" - -/** - * Create a taler://tip/ URI for the given @a con and @a tip_id - * and @a instance_id. - * - * @param con HTTP connection - * @param tip_id the tip id - * @param instance_id instance, may be "default" - * @return corresponding taler://tip/ URI, or NULL on missing "host" - */ char * TMH_make_taler_tip_uri (struct MHD_Connection *con, const struct GNUNET_HashCode *tip_id, @@ -100,15 +90,6 @@ TMH_make_taler_tip_uri (struct MHD_Connection *con, } -/** - * Create a http(s):// URL for the given @a con and @a tip_id - * and @a instance_id. - * - * @param con HTTP connection - * @param tip_id the tip id - * @param instance_id instance, may be "default" - * @return corresponding taler://tip/ URI, or NULL on missing "host" - */ char * TMH_make_tip_status_url (struct MHD_Connection *con, const struct GNUNET_HashCode *tip_id, @@ -169,14 +150,6 @@ TMH_make_tip_status_url (struct MHD_Connection *con, } -/** - * Handle a GET "/tips/$ID" request. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @param[in,out] hc context with further information about the request - * @return MHD result code - */ MHD_RESULT TMH_get_tips_ID (const struct TMH_RequestHandler *rh, struct MHD_Connection *connection, diff --git a/src/backend/taler-merchant-httpd_mhd.c b/src/backend/taler-merchant-httpd_mhd.c index edcb3a7b..e96acca5 100644 --- a/src/backend/taler-merchant-httpd_mhd.c +++ b/src/backend/taler-merchant-httpd_mhd.c @@ -27,15 +27,6 @@ #include "taler-merchant-httpd_mhd.h" -/** - * Function to call to handle the request by sending - * back static data from the @a rh. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @param[in,out] hc handler context (can be updated) - * @return MHD result code - */ MHD_RESULT TMH_MHD_handler_static_response (const struct TMH_RequestHandler *rh, struct MHD_Connection *connection, @@ -50,15 +41,6 @@ TMH_MHD_handler_static_response (const struct TMH_RequestHandler *rh, } -/** - * Function to call to handle the request by sending - * back a redirect to the AGPL source code. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @param[in,out] hc handler context (can be updated) - * @return MHD result code - */ MHD_RESULT TMH_MHD_handler_agpl_redirect (const struct TMH_RequestHandler *rh, struct MHD_Connection *connection, @@ -71,12 +53,6 @@ TMH_MHD_handler_agpl_redirect (const struct TMH_RequestHandler *rh, } -/** - * Test if the client requested HTML output. - * - * @param connection client to test - * @return true if HTML was requested - */ bool TMH_MHD_test_html_desired (struct MHD_Connection *connection) { diff --git a/src/backend/taler-merchant-httpd_post-orders-ID-abort.c b/src/backend/taler-merchant-httpd_post-orders-ID-abort.c index c11ff1c8..ad191020 100644 --- a/src/backend/taler-merchant-httpd_post-orders-ID-abort.c +++ b/src/backend/taler-merchant-httpd_post-orders-ID-abort.c @@ -257,11 +257,6 @@ abort_refunds (struct AbortContext *ac) } } - -/** - * Force all abort contexts to be resumed as we are about - * to shut down MHD. - */ void TMH_force_ac_resume () { @@ -966,14 +961,6 @@ handle_abort_timeout (void *cls) } -/** - * Abort payment for a claimed order. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @param[in,out] hc context with further information about the request - * @return MHD result code - */ MHD_RESULT TMH_post_orders_ID_abort (const struct TMH_RequestHandler *rh, struct MHD_Connection *connection, diff --git a/src/backend/taler-merchant-httpd_post-orders-ID-claim.c b/src/backend/taler-merchant-httpd_post-orders-ID-claim.c index 2668786c..60aadf4b 100644 --- a/src/backend/taler-merchant-httpd_post-orders-ID-claim.c +++ b/src/backend/taler-merchant-httpd_post-orders-ID-claim.c @@ -154,16 +154,6 @@ claim_order (const char *instance_id, } -/** - * Manage a POST /orders/$ID/claim request. Allows the client to - * claim the order (unless already claims) and creates the respective - * contract. Returns the contract terms. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @param[in,out] hc context with further information about the request - * @return MHD result code - */ MHD_RESULT TMH_post_orders_ID_claim (const struct TMH_RequestHandler *rh, struct MHD_Connection *connection, diff --git a/src/backend/taler-merchant-httpd_post-orders-ID-paid.c b/src/backend/taler-merchant-httpd_post-orders-ID-paid.c index a2dbaa33..effc4e12 100644 --- a/src/backend/taler-merchant-httpd_post-orders-ID-paid.c +++ b/src/backend/taler-merchant-httpd_post-orders-ID-paid.c @@ -28,15 +28,6 @@ #include #include "taler-merchant-httpd_post-orders-ID-paid.h" - -/** - * Process a proof of payment for a paid contract. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @param[in,out] hc context with further information about the request - * @return MHD result code - */ MHD_RESULT TMH_post_orders_ID_paid (const struct TMH_RequestHandler *rh, struct MHD_Connection *connection, -- cgit v1.2.3