commit eab45e7e81269eca0426b24ae56f443c438bb2bf
parent 8358eb0b86f0fa5c4a413d9cd107cb971d0b256c
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 18 Feb 2024 16:12:38 +0100
-more doxygen fixes
Diffstat:
9 files changed, 38 insertions(+), 12 deletions(-)
diff --git a/contrib/microhttpd.tag b/contrib/microhttpd.tag
@@ -24,6 +24,18 @@
</member>
<member kind="define">
<type>#define</type>
+ <name>MHD_HTTP_NOT_FOUND</name>
+ <anchorfile>microhttpd.h</anchorfile>
+ <arglist></arglist>
+ </member>
+ <member kind="define">
+ <type>#define</type>
+ <name>MHD_HTTP_CONFLICT</name>
+ <anchorfile>microhttpd.h</anchorfile>
+ <arglist></arglist>
+ </member>
+ <member kind="define">
+ <type>#define</type>
<name>MHD_HTTP_NO_CONTENT</name>
<anchorfile>microhttpd.h</anchorfile>
<arglist></arglist>
@@ -70,11 +82,23 @@
<anchorfile>microhttpd.h</anchorfile>
<arglist></arglist>
</member>
+ <member kind="define">
+ <type>function</type>
+ <name>MHD_get_connection_values</name>
+ <anchorfile>microhttpd.h</anchorfile>
+ <arglist></arglist>
+ </member>
<member kind="typedef">
<type>int</type>
<name>MHD_AccessHandlerCallback</name>
<anchorfile>microhttpd.h</anchorfile>
- <arglist>)(void *cls, struct MHD_Connection *connection, const char *url, const char *method, const char *version, const char *upload_data, size_t *upload_data_size, void **con_cls)</arglist>
+ <arglist></arglist>
+ </member>
+ <member kind="typedef">
+ <type>int</type>
+ <name>MHD_RequestCompletedCallback</name>
+ <anchorfile>microhttpd.h</anchorfile>
+ <arglist></arglist>
</member>
</compound>
</tagfile>
diff --git a/src/include/sync_service.h b/src/include/sync_service.h
@@ -277,8 +277,8 @@ enum SYNC_PaymentOptions
* @param backup_size number of bytes in @a backup
* @param backup the encrypted backup, must remain in
* memory until we are done with the operation!
- * @param payment_requested #GNUNET_YES if the client wants to pay more for the account now
* @param po payment options
+ * @param paid_order_id ID of the paid order, NULL if no payment was made so far
* @param cb function to call with the result
* @param cb_cls closure for @a cb
* @return handle for the operation
@@ -301,7 +301,7 @@ SYNC_upload (struct GNUNET_CURL_Context *ctx,
* that it did not complete, it is possible that the server did
* receive the full request before the upload is aborted.
*
- * @param uo operation to cancel.
+ * @param[in] uo operation to cancel.
*/
void
SYNC_upload_cancel (struct SYNC_UploadOperation *uo);
@@ -399,7 +399,7 @@ SYNC_download (struct GNUNET_CURL_Context *ctx,
/**
* Cancel the download.
*
- * @param do operation to cancel.
+ * @param[in] download operation to cancel.
*/
void
SYNC_download_cancel (struct SYNC_DownloadOperation *download);
diff --git a/src/lib/sync_api_download.c b/src/lib/sync_api_download.c
@@ -91,7 +91,8 @@ struct SYNC_DownloadOperation
*
* @param cls the `struct SYNC_DownloadOperation`
* @param response_code HTTP response code, 0 on error
- * @param response
+ * @param data data we downloaded
+ * @param data_size number of bytes in @a data
*/
static void
handle_download_finished (void *cls,
diff --git a/src/lib/sync_api_upload.c b/src/lib/sync_api_upload.c
@@ -83,7 +83,8 @@ struct SYNC_UploadOperation
*
* @param cls the `struct SYNC_UploadOperation`
* @param response_code HTTP response code, 0 on error
- * @param response
+ * @param data data we downloaded
+ * @param data_size number of bytes in @a data
*/
static void
handle_upload_finished (void *cls,
diff --git a/src/sync/sync-httpd.c b/src/sync/sync-httpd.c
@@ -136,6 +136,7 @@ struct TALER_Amount SH_insurance;
*
* @param cls argument given together with the function
* pointer when the handler was registered with MHD
+ * @param connection connection handle
* @param url the requested url
* @param method the HTTP method used (#MHD_HTTP_METHOD_GET,
* #MHD_HTTP_METHOD_PUT, etc.)
@@ -465,7 +466,7 @@ SH_trigger_curl ()
* Function that queries MHD's select sets and
* starts the task waiting for them.
*
- * @param daemon_handle HTTP server to prepare to run
+ * @return task that runs the HTTP server
*/
static struct GNUNET_SCHEDULER_Task *
prepare_daemon (void)
diff --git a/src/sync/sync-httpd_backup.h b/src/sync/sync-httpd_backup.h
@@ -59,8 +59,10 @@ SH_backup_get (struct MHD_Connection *connection,
/**
+ * Handle POST /backup requests.
+ *
* @param connection the MHD connection to handle
- * @param[in,out] connection_cls the connection's closure (can be updated)
+ * @param[in,out] con_cls the connection's closure (can be updated)
* @param account public key of the account the request is for
* @param upload_data upload data
* @param[in,out] upload_data_size number of bytes (left) in @a upload_data
diff --git a/src/sync/sync-httpd_backup_post.c b/src/sync/sync-httpd_backup_post.c
@@ -215,7 +215,6 @@ cleanup_ctx (struct TM_HandlerContext *hc)
/**
* Transmit a payment request for @a order_id on @a connection
*
- * @param connection MHD connection
* @param order_id our backend's order ID
* @param token the claim token generated by the merchant (NULL if
* it wasn't generated).
diff --git a/src/sync/sync-httpd_mhd.h b/src/sync/sync-httpd_mhd.h
@@ -37,7 +37,6 @@
* @param[in,out] connection_cls the connection's closure (can be updated)
* @param upload_data upload data
* @param[in,out] upload_data_size number of bytes (left) in @a upload_data
- * @param mi merchant backend instance, NULL is allowed in this case!
* @return MHD result code
*/
MHD_RESULT
@@ -57,7 +56,6 @@ SH_MHD_handler_static_response (struct SH_RequestHandler *rh,
* @param[in,out] connection_cls the connection's closure (can be updated)
* @param upload_data upload data
* @param[in,out] upload_data_size number of bytes (left) in @a upload_data
- * @param mi merchant backend instance, never NULL
* @return MHD result code
*/
MHD_RESULT
diff --git a/src/syncdb/plugin_syncdb_postgres.c b/src/syncdb/plugin_syncdb_postgres.c
@@ -571,7 +571,7 @@ struct PaymentIteratorContext
*
* @param cls closure of type `struct PaymentIteratorContext *`
* @param result the postgres result
- * @param num_result the number of results in @a result
+ * @param num_results the number of results in @a result
*/
static void
payment_by_account_cb (void *cls,
