commit 1fc2c46ed83e94780028583b2de7bbf6f4f3d60e parent 31f2fb117d6da0acb109754f92ee2729e4ca2739 Author: Christian Grothoff <christian@grothoff.org> Date: Wed, 27 May 2026 00:16:38 +0200 fix doxygen errors Diffstat:
55 files changed, 122 insertions(+), 129 deletions(-)
diff --git a/src/donau/donau-httpd_get-charities.c b/src/donau/donau-httpd_get-charities.c @@ -38,7 +38,14 @@ /** * Return charities information. * - * @param cls closure + * @param cls closure, JSON array to append charity records to + * @param charity_id unique identifier of the charity + * @param charity_pub public key of the charity + * @param charity_name human-readable name of the charity + * @param max_per_year maximum donation amount per year + * @param current_year current donation year + * @param receipts_to_date total receipts issued so far this year + * @return #GNUNET_OK to continue iteration */ static enum GNUNET_GenericReturnValue charities_cb ( diff --git a/src/donau/donau-httpd_get-history.c b/src/donau/donau-httpd_get-history.c @@ -37,7 +37,11 @@ /** * Return history information. * - * @param cls closure + * @param cls closure, JSON array to append history records to + * @param charity_id unique identifier of the charity + * @param final_amount aggregated donation amount for the year + * @param donation_year year of the donations + * @return #GNUNET_OK to continue iteration */ static enum GNUNET_GenericReturnValue history_cb ( diff --git a/src/donau/donau-httpd_get-keys.c b/src/donau/donau-httpd_get-keys.c @@ -126,8 +126,8 @@ static struct TALER_SecurityModulePublicKeyP esign_sm_pub; /** * Counter incremented whenever we have a reason to re-build the keys because - * something external changed. See #DH_keys_get_state() and - * #DH_keys_update_states() for uses of this variable. + * something external changed. See #DH_keys_get_state() for uses of this + * variable. */ static uint64_t key_generation; @@ -469,7 +469,7 @@ CLEANUP: * Free donation unit key data. * * @param cls a `struct DH_KeyStateHandle`, unused - * @param h_donation_unit_pub hash of the donation unit public key, unused + * @param h_du_pub hash of the donation unit public key, unused * @param value a `struct DH_DonationUnitKey` to free * @return #GNUNET_OK (continue to iterate) */ @@ -762,8 +762,9 @@ helper_rsa_cb ( * @param validity_duration how long does the key remain available for signing; * zero if the key has been revoked or purged * @param h_cs hash of the @a donation_unit_pub that is available (or was purged) - * @param sm_pub the public key itself, NULL if the key was revoked or purged - * @param sm_pub signature by the security module + * @param bs_pub the public key itself, NULL if the key was revoked or purged + * @param sm_pub the public key of the security module + * @param sm_sig signature by the security module */ static void helper_cs_cb ( diff --git a/src/donau/donau-httpd_get-keys.h b/src/donau/donau-httpd_get-keys.h @@ -85,7 +85,7 @@ struct DH_BlindSignData * The @a purpose data is the beginning of the data of which the signature is * to be created. The `size` field in @a purpose must correctly indicate the * number of bytes of the data structure, including its header. Use - * #DH_keys_doanu_sign() instead of calling this function directly! + * #DH_keys_donau_sign() instead of calling this function directly! * * @param purpose the message to sign * @param[out] pub set to the current public signing key of the doanu diff --git a/src/donau/donau-httpd_post-batch-issue-CHARITY_ID.c b/src/donau/donau-httpd_post-batch-issue-CHARITY_ID.c @@ -94,8 +94,6 @@ free_bkps (size_t num_bkps, * @param num_sig number of signatures * @param signatures Blinded donation unit signatures * @param[out] j_signatures JSON object - * @return #GNUNET_OK if all is fine, #GNUNET_SYSERR if we could not parse - * is malformed. */ static void signatures_to_json (const size_t num_sig, diff --git a/src/donau/donau-httpd_post-batch-issue-CHARITY_ID.h b/src/donau/donau-httpd_post-batch-issue-CHARITY_ID.h @@ -28,8 +28,9 @@ /** * Handle a POST "/batch-issue" request. * - * @param connection the MHD connection to handle + * @param rc context of the request being handled * @param root uploaded JSON data + * @param args one-element array containing the charity id from the URL * @return MHD result code */ enum MHD_Result diff --git a/src/donau/donau-httpd_post-batch-submit.h b/src/donau/donau-httpd_post-batch-submit.h @@ -28,8 +28,9 @@ /** * Handle a POST "/submit" request. * - * @param connection the MHD connection to handle + * @param rc context of the request being handled * @param root uploaded JSON data + * @param args remaining URL arguments (unused) * @return MHD result code */ enum MHD_Result diff --git a/src/donaudb/commit.c b/src/donaudb/commit.c @@ -26,7 +26,7 @@ /** * Commit the current transaction of a database connection. * - * @param cls the `struct DONAUDB_PostgresContext` with the plugin-specific state + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state * @return final transaction status */ enum GNUNET_DB_QueryStatus diff --git a/src/donaudb/drop_tables.c b/src/donaudb/drop_tables.c @@ -29,7 +29,7 @@ /** * Drop all Taler tables. This should only be used by testcases. * - * @param cls the `struct DONAUDB_PostgresContext` with the plugin-specific state + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state * @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure */ enum GNUNET_GenericReturnValue diff --git a/src/donaudb/event_listen.c b/src/donaudb/event_listen.c @@ -28,7 +28,7 @@ /** * Register callback to be invoked on events of type @a es. * - * @param cls database context to use + * @param ctx database context to use * @param timeout how long until to generate a timeout event * @param es specification of the event to listen for * @param cb function to call when the event happens, possibly diff --git a/src/donaudb/lookup_charity.c b/src/donaudb/lookup_charity.c @@ -14,8 +14,8 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file donaudb/pg_lookup_donation_unit_key.c - * @brief Implementation of the lookup_donation_unit_key function for Postgres + * @file src/donaudb/lookup_charity.c + * @brief Implementation of the lookup_charity function for Postgres * @author Johannes Casaburi */ #include <donau_config.h> diff --git a/src/include/donau-database/commit.h b/src/include/donau-database/commit.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/commit.h + * @file donau-database/commit.h * @brief implementation of the commit function for Postgres * @author Christian Grothoff */ @@ -27,7 +27,7 @@ /** * Commit the current transaction of a database connection. * - * @param cls the `struct PostgresClosure` with the plugin-specific state + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state * @return final transaction status */ enum GNUNET_DB_QueryStatus diff --git a/src/include/donau-database/create_tables.h b/src/include/donau-database/create_tables.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/create_tables.h + * @file donau-database/create_tables.h * @brief implementation of the create_tables function for Postgres * @author Johannes Casaburi */ @@ -27,11 +27,7 @@ /** * Create the necessary tables if they are not present * - * @param cls the `struct PostgresClosure` with the plugin-specific state - * @param support_partitions true to enable partitioning support (disables foreign key constraints) - * @param num_partitions number of partitions to create, - * (0 to not actually use partitions, 1 to only - * setup a default partition, >1 for real partitions) + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state * @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure */ enum GNUNET_GenericReturnValue diff --git a/src/include/donau-database/do_charity_delete.h b/src/include/donau-database/do_charity_delete.h @@ -27,7 +27,7 @@ /** * Function called to explicitly delete a charity. * - * @param cls the @e cls of this struct with the plugin-specific state + * @param ctx the @e cls of this struct with the plugin-specific state * @param charity_id charity to delete * @return transaction status code */ diff --git a/src/include/donau-database/drop_tables.h b/src/include/donau-database/drop_tables.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/drop_tables.h + * @file donau-database/drop_tables.h * @brief implementation of the drop_tables function for Postgres * @author Christian Grothoff */ @@ -27,7 +27,7 @@ /** * Drop all Taler tables. This should only be used by testcases. * - * @param cls the `struct PostgresClosure` with the plugin-specific state + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state * @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure */ enum GNUNET_GenericReturnValue diff --git a/src/include/donau-database/event_listen.h b/src/include/donau-database/event_listen.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/event_listen.h + * @file donau-database/event_listen.h * @brief implementation of the event_listen function for Postgres * @author Christian Grothoff */ @@ -27,7 +27,7 @@ /** * Register callback to be invoked on events of type @a es. * - * @param cls database context to use + * @param ctx database context to use * @param timeout how long until to generate a timeout event * @param es specification of the event to listen for * @param cb function to call when the event happens, possibly diff --git a/src/include/donau-database/event_listen_cancel.h b/src/include/donau-database/event_listen_cancel.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/event_listen_cancel.h + * @file donau-database/event_listen_cancel.h * @brief implementation of the event_listen_cancel function for Postgres * @author Christian Grothoff */ @@ -27,7 +27,7 @@ /** * Stop notifications. * - * @param cls the plugin's `struct PostgresClosure` + * @param ctx the plugin's `struct DONAUDB_PostgresContext` * @param eh handle to unregister. */ void diff --git a/src/include/donau-database/event_notify.h b/src/include/donau-database/event_notify.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/event_notify.h + * @file donau-database/event_notify.h * @brief implementation of the event_notify function for Postgres * @author Christian Grothoff */ @@ -27,7 +27,7 @@ /** * Notify all that listen on @a es of an event. * - * @param cls database context to use + * @param ctx database context to use * @param es specification of the event to generate * @param extra additional event data provided * @param extra_size number of bytes in @a extra diff --git a/src/include/donau-database/get_charities.h b/src/include/donau-database/get_charities.h @@ -43,7 +43,7 @@ typedef enum GNUNET_GenericReturnValue /** * Obtain information about the enabled wire accounts of the exchange. * - * @param cls closure + * @param ctx database context to use * @param cb function to call on each account * @param cb_cls closure for @a cb * @return transaction status code diff --git a/src/include/donau-database/get_history.h b/src/include/donau-database/get_history.h @@ -40,7 +40,7 @@ typedef enum GNUNET_GenericReturnValue /** * Obtain history of charities. * - * @param cls closure + * @param ctx database context to use * @param cb function to call on each result * @param cb_cls closure for @a cb * @return transaction status code diff --git a/src/include/donau-database/insert_charity.h b/src/include/donau-database/insert_charity.h @@ -27,7 +27,7 @@ /** * Add a new charity * - * @param cls closure + * @param ctx closure * @param charity_pub charity public key * @param charity_name charity name * @param charity_url Web site of the charity diff --git a/src/include/donau-database/insert_donation_unit.h b/src/include/donau-database/insert_donation_unit.h @@ -27,8 +27,8 @@ /** * Add donation unit key. * - * @param cls closure - * @param donation_unit_hash hash of the public key + * @param ctx closure + * @param h_donation_unit_pub hash of the public key * @param donation_unit_pub the actual donation_unit key * @param validity_year validity year * @param value value that the donation unit represents diff --git a/src/include/donau-database/insert_history_entry.h b/src/include/donau-database/insert_history_entry.h @@ -27,7 +27,7 @@ /** * Insert history entry of a charity * - * @param cls closure + * @param ctx closure * @param charity_id charity id * @param final_amount final donation amount at the end of the donation year * @param donation_year year of the donations diff --git a/src/include/donau-database/insert_issued_receipt.h b/src/include/donau-database/insert_issued_receipt.h @@ -27,7 +27,7 @@ /** * Insert issued blinded donation receipt to the charity. * - * @param cls closure + * @param ctx closure * @param num_blinded_sig * @param signatures blinded signatures * @param charity_id identifier of the charity diff --git a/src/include/donau-database/insert_signing_key.h b/src/include/donau-database/insert_signing_key.h @@ -27,7 +27,7 @@ /** * Add signing key. * - * @param cls closure + * @param ctx closure * @param donau_pub the donau online signing public key * @param meta meta data about @a donau_pub * @return transaction status code diff --git a/src/include/donau-database/insert_submitted_receipts.h b/src/include/donau-database/insert_submitted_receipts.h @@ -27,7 +27,7 @@ /** * Insert submitted donation receipt from the donor. * - * @param cls closure + * @param ctx closure * @param h_donor_tax_id salted hash of the donors tax number * @param num_dr number of donation receipts * @param donation_receipts array of donation receipts diff --git a/src/include/donau-database/iterate_active_signing_keys.h b/src/include/donau-database/iterate_active_signing_keys.h @@ -40,7 +40,7 @@ typedef void /** * Obtain information about the enabled wire accounts of the exchange. * - * @param cls closure + * @param ctx database context to use * @param cb function to call on each account * @param cb_cls closure for @a cb * @return transaction status code diff --git a/src/include/donau-database/iterate_donation_units.h b/src/include/donau-database/iterate_donation_units.h @@ -40,7 +40,7 @@ typedef enum GNUNET_GenericReturnValue /** * Obtain information about the enabled wire accounts of the exchange. * - * @param cls closure + * @param ctx database context to use * @param cb function to call on each account * @param cb_cls closure for @a cb * @return transaction status code diff --git a/src/include/donau-database/iterate_submitted_receipts.h b/src/include/donau-database/iterate_submitted_receipts.h @@ -14,8 +14,8 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file donaudb/pg_iterate_donation_units.h - * @brief implementation of the iterate_donation_units function for Postgres + * @file donau-database/iterate_submitted_receipts.h + * @brief implementation of the iterate_submitted_receipts function for Postgres * @author Johannes Casaburi */ #ifndef DONAU_DATABASE_ITERATE_SUBMITTED_RECEIPTS_H @@ -27,7 +27,7 @@ /** * Obtain information about the enabled wire accounts of the exchange. * - * @param cls closure + * @param ctx closure * @param donation_year donation year * @param h_donor_tax_id hash of donor tax id * @param[out] total_donations amount of total donations diff --git a/src/include/donau-database/lookup_charity.h b/src/include/donau-database/lookup_charity.h @@ -27,7 +27,7 @@ /** * Fetch information about a charity. * - * @param cls the @e cls of this struct with the plugin-specific state + * @param ctx the @e cls of this struct with the plugin-specific state * @param charity_id the charity id * @param meta charity meta data information * @return transaction status code diff --git a/src/include/donau-database/lookup_donation_unit_amount.h b/src/include/donau-database/lookup_donation_unit_amount.h @@ -27,7 +27,7 @@ /** * Look up the face value of one donation-unit entry. * - * @param cls plugin’s `struct PostgresClosure *` + * @param ctx plugin’s `struct DONAUDB_PostgresContext *` * @param h_donation_unit_pub hash of the donation-unit public key (PRIMARY KEY) * @param[out] value amount stored in the table * @return same semantics as every other DONAUDB_* lookup: diff --git a/src/include/donau-database/lookup_issued_receipts.h b/src/include/donau-database/lookup_issued_receipts.h @@ -27,7 +27,7 @@ /** * Fetch information about an issued receipts request. * - * @param cls the @e cls of this struct with the plugin-specific state + * @param ctx the @e cls of this struct with the plugin-specific state * @param h_receipts hash over the issued receipt * @param meta information with value and other info about the issued receipts * @return transaction status code diff --git a/src/include/donau-database/lookup_signing_key.h b/src/include/donau-database/lookup_signing_key.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/lookup_signing_key.h + * @file donau-database/lookup_signing_key.h * @brief implementation of the lookup_signing_key function for Postgres * @author Johannes Casaburi */ @@ -27,7 +27,7 @@ /** * Lookup signing key meta data. * - * @param cls closure + * @param ctx closure * @param donau_pub the donau signing public key * @param[out] meta meta data about @a donau_pub * @return transaction status code diff --git a/src/include/donau-database/preflight.h b/src/include/donau-database/preflight.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/preflight.h + * @file donau-database/preflight.h * @brief implementation of the preflight function for Postgres * @author Christian Grothoff */ @@ -29,7 +29,7 @@ * If we are, try to commit the previous transaction and output a warning. * Does not return anything, as we will continue regardless of the outcome. * - * @param cls the `struct PostgresClosure` with the plugin-specific state + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state * @return #GNUNET_OK if everything is fine * #GNUNET_NO if a transaction was rolled back * #GNUNET_SYSERR on hard errors diff --git a/src/include/donau-database/rollback.h b/src/include/donau-database/rollback.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/rollback.h + * @file donau-database/rollback.h * @brief implementation of the rollback function for Postgres * @author Christian Grothoff */ @@ -27,7 +27,7 @@ /** * Roll back the current transaction of a database connection. * - * @param cls the `struct PostgresClosure` with the plugin-specific state + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state */ void DONAUDB_rollback (struct DONAUDB_PostgresContext *ctx); diff --git a/src/include/donau-database/start.h b/src/include/donau-database/start.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/start.h + * @file donau-database/start.h * @brief implementation of the start function for Postgres * @author Christian Grothoff */ @@ -27,7 +27,7 @@ /** * Start a transaction. * - * @param cls the `struct PostgresClosure` with the plugin-specific state + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state * @param name unique name identifying the transaction (for debugging) * must point to a constant * @return #GNUNET_OK on success diff --git a/src/include/donau-database/start_read_committed.h b/src/include/donau-database/start_read_committed.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/start_read_committed.h + * @file donau-database/start_read_committed.h * @brief implementation of the start_read_committed function for Postgres * @author Christian Grothoff */ @@ -27,7 +27,7 @@ /** * Start a READ COMMITTED transaction. * - * @param cls the `struct PostgresClosure` with the plugin-specific state + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state * @param name unique name identifying the transaction (for debugging) * must point to a constant * @return #GNUNET_OK on success diff --git a/src/include/donau-database/start_read_only.h b/src/include/donau-database/start_read_only.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/start_read_only.h + * @file donau-database/start_read_only.h * @brief implementation of the start_read_only function for Postgres * @author Christian Grothoff */ @@ -27,7 +27,7 @@ /** * Start a READ ONLY serializable transaction. * - * @param cls the `struct PostgresClosure` with the plugin-specific state + * @param ctx the `struct DONAUDB_PostgresContext` with the plugin-specific state * @param name unique name identifying the transaction (for debugging) * must point to a constant * @return #GNUNET_OK on success diff --git a/src/include/donau-database/update_charity.h b/src/include/donau-database/update_charity.h @@ -27,7 +27,7 @@ /** * Update an existing charity entry. * - * @param cls closure + * @param ctx closure * @param charity_id identifier of the charity to update * @param charity_pub new public key for the charity * @param charity_name new name diff --git a/src/include/donau_crypto_lib.h b/src/include/donau_crypto_lib.h @@ -14,8 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file include/donau_crypto_lib.h - * @file include/gnunet_crypto_lib.h + * @file donau_crypto_lib.h * @brief taler-specific crypto functions * @author Sree Harsha Totakura <sreeharsha@totakura.in> * @author Christian Grothoff <christian@grothoff.org> @@ -384,12 +383,12 @@ struct DONAU_DonationStatement const struct DONAU_HashDonorTaxId *h_donor_tax_id; /** - * The salt used for @h_donor_tax_id. + * The salt used for @a h_donor_tax_id. */ const char *donor_tax_id; /** - * The cleartext tax id of the user used for @h_donor_tax_id. + * The cleartext tax id of the user used for @a h_donor_tax_id. */ const char *salt; @@ -399,7 +398,7 @@ struct DONAU_DonationStatement struct TALER_Amount total_amount; /** - * The donation statement signature over @year, @h_donor_tax_id and @total_amount. + * The donation statement signature over @a year, @a h_donor_tax_id and @a total_amount. */ struct DONAU_DonauSignatureP donation_statement_sig; @@ -493,7 +492,7 @@ typedef enum TALER_ErrorCode * * @param scb function to call to create the signature * @param amount_tot total donated amount of @a year - * @param year + * @param year donation year for the statement * @param i hash value, the identifier of the donor * @param donau_pub public key of the donau * @param[out] donau_sig where to write the signature @@ -512,9 +511,9 @@ DONAU_donation_statement_sign ( * Verify donau eddsa signature/donation statement. * * @param amount_tot total donated amount of @a year - * @param year + * @param year donation year for the statement * @param i hash value, the identifier of the donor - * @param donau_priv private key of the donau + * @param donau_pub public key of the donau * @param statement_sig signature to verify * @return #GNUNET_OK if the signature is valid */ diff --git a/src/include/donau_service.h b/src/include/donau_service.h @@ -382,22 +382,6 @@ void DONAU_keys_decref (struct DONAU_Keys *keys); /** - * Test if the given @a pub is a current signing key from the donau - * according to @a keys. (-> // always current, revocation not yet supported) - * - * @param keys the donau's key set - * @param pub claimed online signing key for the donau - * @param year given year - * @return #GNUNET_OK if @a pub is (according to /keys and @a year) the corresponding signing key - */ -// enum GNUNET_GenericReturnValue -// DONAU_test_signing_key ( -// const struct DONAU_Keys *keys, -// const uint32_t year, -// const struct DONAU_DonauPublicKeyP *pub); - - -/** * Obtain the donation unit key details from the donau. * * @param keys the donau's key set @@ -468,7 +452,7 @@ DONAU_get_donation_unit_key_by_hash ( * @param bkps array of blinded unique donor identifiers * @param num_bkps length of the @a bkps array * @param year year of the donation - * @param[out] sum_out result amount (initialized to zero in @keys->currency) + * @param[out] sum_out result amount (initialized to zero in @a keys->currency) * @return #GNUNET_OK on success; * #GNUNET_NO on invalid input, duplication, year mismatch; * #GNUNET_SYSERR on math errors. @@ -595,11 +579,11 @@ typedef void * @param url donau base URL * @param charity_priv private key of the charity * @param charity_id unique (row ID) of the charity at the DONAU + * @param year donation year for which receipts are issued * @param num_bkp length of the @a bkp array * @param bkp array with details about the blinded donation envelopes * @param cb the callback to call when a reply for this request is available * @param cb_cls closure for the above callback - * @param[out] ec if NULL is returned, set to the error code explaining why the operation failed * @return a handle for this request; NULL if the inputs are invalid (i.e. * signatures fail to verify). In this case, the callback is not called. */ @@ -695,7 +679,6 @@ typedef void * @param h_donor_tax_id salted and hashed tax id * @param cb the callback to call when a reply for this request is available * @param cls closure for the above callback - * @param[out] ec if NULL is returned, set to the error code explaining why the operation failed * @return a handle for this request; NULL if the inputs are invalid (i.e. * signatures fail to verify). In this case, the callback is not called. */ @@ -714,11 +697,11 @@ DONAU_donor_receipts_to_statement ( * Cancel a batch permission request. This function cannot be used * on a request handle if a response is already served for it. * - * @param[in] the Batch Submit receipts handle + * @param[in] drsh the Batch Submit receipts handle */ void DONAU_donor_receipts_to_statement_cancel ( - struct DONAU_DonorReceiptsToStatementHandle *); + struct DONAU_DonorReceiptsToStatementHandle *drsh); /* ********************* GET /donation-statement *********************** */ @@ -797,8 +780,7 @@ typedef void * @param year corresponding year * @param h_donor_tax_id salted and hashed tax id * @param cb the callback to call when a reply for this request is available - * @param cls closure for the above callback - * @param[out] ec if NULL is returned, set to the error code explaining why the operation failed + * @param cb_cls closure for the above callback * @return a handle for this request; NULL if the inputs are invalid (i.e. * signatures fail to verify). In this case, the callback is not called. */ @@ -815,11 +797,11 @@ DONAU_donation_statement_get ( * Cancel a batch permission request. This function cannot be used * on a request handle if a response is already served for it. * - * @param[in] the Batch Submit receipts handle + * @param[in] dsgh the Batch Submit receipts handle */ void DONAU_donation_statement_get_cancel ( - struct DONAU_DonationStatementGetHandle *); + struct DONAU_DonationStatementGetHandle *dsgh); /* ********************* POST /csr batch-issue *********************** */ @@ -887,12 +869,12 @@ typedef void /** * Get a CS R using a /csr-batch-issue request. * - * @param curl_ctx The curl context to use for the requests - * @param donau_url Base-URL to the donau + * @param ctx The curl context to use for the requests + * @param url Base-URL to the donau * @param pk Which donation unit key is the /csr request for * @param nonce client nonce for the request - * @param res_cb the callback to call when the final result for this request is available - * @param res_cb_cls closure for the above callback + * @param cb the callback to call when the final result for this request is available + * @param cb_cls closure for the above callback * @return handle for the operation on success, NULL on error, i.e. * if the inputs are invalid (i.e.donation unit key not with this donau). * In this case, the callback is not called. @@ -1330,6 +1312,7 @@ typedef void * @param charity_url Web site of the charity * @param max_per_year max donation amount allowed for the charity per year * @param charity_pub public key of the charity + * @param bearer bearer token authorizing the request * @param cb the callback to call when a reply for this request is available * @param cb_cls closure for the above callback * @return a handle for this request; NULL if the inputs are invalid (i.e. diff --git a/src/include/donau_testing_lib.h b/src/include/donau_testing_lib.h @@ -67,6 +67,7 @@ TALER_TESTING_cmd_charity_get (const char *label, * @param label the command label. * @param name of the charity * @param url of the charity + * @param max_per_year per-year donation limit as amount string * @param bearer authorization token * @param expected_response_code expected HTTP response code. * @return the command. @@ -137,6 +138,7 @@ TALER_TESTING_cmd_charities_get (const char *label, * @param year current year (mostly) * @param donor_tax_id tax id of the donor * @param salt for tax id hash + * @param issue_amount donation amount string used for the receipt batch * @param expected_response_code expected HTTP response code. * @return the command. */ @@ -219,24 +221,24 @@ TALER_TESTING_get_donau_url ( * Call #op on all simple traits. */ #define DONAU_TESTING_SIMPLE_TRAITS(op) \ - op (charity_priv, const struct DONAU_CharityPrivateKeyP) \ - op (charity_pub, const struct DONAU_CharityPublicKeyP) \ - op (charity_id, const uint64_t) \ - op (donau_url, const char) \ - op (donau_keys, struct DONAU_Keys) \ - op (donor_salt, const char) \ - op (donor_tax_id, const char) \ - op (salted_tax_id_hash, const struct DONAU_HashDonorTaxId) \ - op (donation_receipts, const struct DONAU_DonationReceipt*) \ - op (number_receipts, const size_t) + op (charity_priv, const struct DONAU_CharityPrivateKeyP) \ + op (charity_pub, const struct DONAU_CharityPublicKeyP) \ + op (charity_id, const uint64_t) \ + op (donau_url, const char) \ + op (donau_keys, struct DONAU_Keys) \ + op (donor_salt, const char) \ + op (donor_tax_id, const char) \ + op (salted_tax_id_hash, const struct DONAU_HashDonorTaxId) \ + op (donation_receipts, const struct DONAU_DonationReceipt*) \ + op (number_receipts, const size_t) /** * Call #op on all indexed traits. */ #define DONAU_TESTING_INDEXED_TRAITS(op) \ - op (donation_unit_pub, const struct DONAU_DonationUnitInformation) \ - op (donau_pub, const struct TALER_ExchangePublicKeyP) + op (donation_unit_pub, const struct DONAU_DonationUnitInformation) \ + op (donau_pub, const struct TALER_ExchangePublicKeyP) DONAU_TESTING_SIMPLE_TRAITS (TALER_TESTING_MAKE_DECL_SIMPLE_TRAIT) DONAU_TESTING_INDEXED_TRAITS (TALER_TESTING_MAKE_DECL_INDEXED_TRAIT) diff --git a/src/json/json.c b/src/json/json.c @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file json/json.c + * @file donau/src/json/json.c * @brief helper functions for JSON processing using libjansson * @author Sree Harsha Totakura <sreeharsha@totakura.in> * @author Christian Grothoff diff --git a/src/json/json_helper.c b/src/json/json_helper.c @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file json/json_helper.c + * @file donau/src/json/json_helper.c * @brief helper functions to generate specifications to parse * Taler-specific JSON objects with libgnunetjson * @author Sree Harsha Totakura <sreeharsha@totakura.in> diff --git a/src/json/json_pack.c b/src/json/json_pack.c @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file json/json_pack.c + * @file donau/src/json/json_pack.c * @brief helper functions for JSON object packing * @author Christian Grothoff * @author Lukas Matyja diff --git a/src/lib/donau_api_batch_issue_receipts.c b/src/lib/donau_api_batch_issue_receipts.c @@ -167,10 +167,10 @@ handle_batch_issue_ok (const json_t *resp_obj, /** * Transform issue receipt request into JSON. * - * @param num_bkp number of budi-key-pairs in @bkp + * @param num_bkp number of budi-key-pairs in @a bkp * @param bkp budi-key-pair array * @param year corresponding year - * @param charity_sig signature from charity over @bkp + * @param charity_sig signature from charity over @a bkp */ static json_t * issue_receipt_body_to_json ( diff --git a/src/lib/donau_api_batch_submit_receipts.c b/src/lib/donau_api_batch_submit_receipts.c @@ -71,7 +71,7 @@ struct DONAU_DonorReceiptsToStatementHandle /** * Transform submit receipt request into JSON. * - * @param num_drs number of donation receipts in @drs + * @param num_drs number of donation receipts in @a drs * @param drs donation receipts array * @param year corresponding year * @param h_tax_id salted and hashed tax id diff --git a/src/lib/donau_api_charity_get.c b/src/lib/donau_api_charity_get.c @@ -63,10 +63,11 @@ struct DONAU_CharityGetHandle /** * Decode the JSON in @a resp_obj from the /charities/$ID response - * and store the data in the @a charity_data. + * and store the data in @a gcresp. * * @param[in] resp_obj JSON object to parse - * @param[out] charity_data where to store the results we decoded + * @param cgh handle for the GET /charities/$ID request + * @param[out] gcresp where to store the results we decoded * @return #GNUNET_OK on success, #GNUNET_SYSERR on error * (malformed JSON) */ diff --git a/src/lib/donau_api_donation_statement_get.c b/src/lib/donau_api_donation_statement_get.c @@ -164,9 +164,9 @@ handle_donation_statement_get_finished (void *cls, /** - * Prepares the request URL for the age-withdraw request + * Prepares the request URL for the donation-statement-get request * - * @param awbh The handler + * @param dsgh The handler * @param donau_url The base-URL to the donau */ static diff --git a/src/pq/pq_common.h b/src/pq/pq_common.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file pq/pq_common.h + * @file donau/src/pq/pq_common.h * @brief common defines for the pq functions * @author Johannes Casaburi */ diff --git a/src/pq/pq_query_helper.c b/src/pq/pq_query_helper.c @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file pq/pq_query_helper.c + * @file donau/src/pq/pq_query_helper.c * @brief helper functions for Taler-specific libpq (PostGres) interactions * @author Johannes Casaburi */ diff --git a/src/pq/pq_result_helper.c b/src/pq/pq_result_helper.c @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file pq/pq_result_helper.c + * @file donau/src/pq/pq_result_helper.c * @brief functions to initialize parameter arrays * @author Johannes Casaburi */ diff --git a/src/testing/testing_api_loop.c b/src/testing/testing_api_loop.c @@ -18,7 +18,7 @@ */ /** - * @file testing/testing_api_loop.c + * @file donau/src/testing/testing_api_loop.c * @brief main interpreter loop for testcases * @author Lukas Matyja */ diff --git a/src/testing/testing_api_misc.c b/src/testing/testing_api_misc.c @@ -17,7 +17,7 @@ <http://www.gnu.org/licenses/> */ /** - * @file testing/testing_api_misc.c + * @file donau/src/testing/testing_api_misc.c * @brief non-command functions useful for writing tests * @author Christian Grothoff */ diff --git a/src/testing/testing_api_traits.c b/src/testing/testing_api_traits.c @@ -17,7 +17,7 @@ <http://www.gnu.org/licenses/> */ /** - * @file testing/testing_api_traits.c + * @file donau/src/testing/testing_api_traits.c * @brief loop for trait resolution * @author Christian Grothoff * @author Marcello Stanisci