[taler-sync] branch master updated: doxygen fixes

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository sync.

The following commit(s) were added to refs/heads/master by this push:
     new 7f8aa4a  doxygen fixes
7f8aa4a is described below

commit 7f8aa4ae77ba01de45ea323ea4c89065577cac1b
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Sun Feb 18 15:41:11 2024 +0100

    doxygen fixes
---
 src/include/sync_database_lib.h               |  2 +-
 src/lib/sync_api_curl_defaults.c              |  7 +------
 src/lib/sync_api_download.c                   | 15 ---------------
 src/lib/sync_api_upload.c                     |  7 -------
 src/sync/sync-httpd_backup.h                  |  2 +-
 src/sync/sync-httpd_backup_post.c             | 10 ----------
 src/sync/sync-httpd_config.c                  | 13 +------------
 src/sync/sync-httpd_config.h                  |  2 +-
 src/sync/sync-httpd_mhd.c                     | 22 ----------------------
 src/syncdb/plugin_syncdb_postgres.c           |  2 +-
 src/syncdb/sync-dbinit.c                      |  2 +-
 src/syncdb/sync_db_plugin.c                   | 11 -----------
 src/testing/testing_api_cmd_backup_download.c |  2 +-
 src/testing/testing_api_cmd_backup_upload.c   |  2 +-
 src/testing/testing_api_helpers.c             |  2 +-
 src/util/sync-config.c                        |  2 +-
 16 files changed, 11 insertions(+), 92 deletions(-)

diff --git a/src/include/sync_database_lib.h b/src/include/sync_database_lib.h
index 2a67ec3..3311ce2 100644
--- a/src/include/sync_database_lib.h
+++ b/src/include/sync_database_lib.h
@@ -35,7 +35,7 @@ SYNC_DB_plugin_load (const struct GNUNET_CONFIGURATION_Handle 
*cfg);
 /**
  * Shutdown the plugin.
  *
- * @param plugin plugin to unload
+ * @param[in] plugin plugin to unload
  */
 void
 SYNC_DB_plugin_unload (struct SYNC_DatabasePlugin *plugin);
diff --git a/src/lib/sync_api_curl_defaults.c b/src/lib/sync_api_curl_defaults.c
index 7305580..0827bc3 100644
--- a/src/lib/sync_api_curl_defaults.c
+++ b/src/lib/sync_api_curl_defaults.c
@@ -23,12 +23,7 @@
 #include <taler/taler_curl_lib.h>
 #include "sync_api_curl_defaults.h"
 
-/**
- * Get a curl handle with the right defaults
- * for the sync lib.
- *
- * @param url URL to query
- */
+
 CURL *
 SYNC_curl_easy_get_ (const char *url)
 {
diff --git a/src/lib/sync_api_download.c b/src/lib/sync_api_download.c
index a5515dd..50c138d 100644
--- a/src/lib/sync_api_download.c
+++ b/src/lib/sync_api_download.c
@@ -247,16 +247,6 @@ handle_header (char *buffer,
 }
 
 
-/**
- * Download the latest version of a backup for account @a pub.
- *
- * @param ctx for HTTP client request processing
- * @param base_url base URL of the Sync server
- * @param pub account public key
- * @param cb function to call with the backup
- * @param cb_cls closure for @a cb
- * @return handle for the operation
- */
 struct SYNC_DownloadOperation *
 SYNC_download (struct GNUNET_CURL_Context *ctx,
                const char *base_url,
@@ -300,11 +290,6 @@ SYNC_download (struct GNUNET_CURL_Context *ctx,
 }
 
 
-/**
- * Cancel the download.
- *
- * @param do operation to cancel.
- */
 void
 SYNC_download_cancel (struct SYNC_DownloadOperation *download)
 {
diff --git a/src/lib/sync_api_upload.c b/src/lib/sync_api_upload.c
index 1b36844..7c3c8cb 100644
--- a/src/lib/sync_api_upload.c
+++ b/src/lib/sync_api_upload.c
@@ -423,13 +423,6 @@ SYNC_upload (struct GNUNET_CURL_Context *ctx,
 }
 
 
-/**
- * Cancel the upload.  Note that aborting an upload does NOT guarantee
- * 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.
- */
 void
 SYNC_upload_cancel (struct SYNC_UploadOperation *uo)
 {
diff --git a/src/sync/sync-httpd_backup.h b/src/sync/sync-httpd_backup.h
index ebfbe5f..3fed375 100644
--- a/src/sync/sync-httpd_backup.h
+++ b/src/sync/sync-httpd_backup.h
@@ -14,7 +14,7 @@
   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */
 /**
- * @file sync-httpd_policy.h
+ * @file sync-httpd_backup.h
  * @brief functions to handle incoming requests on /backup/
  * @author Christian Grothoff
  */
diff --git a/src/sync/sync-httpd_backup_post.c 
b/src/sync/sync-httpd_backup_post.c
index 66d5a48..694f705 100644
--- a/src/sync/sync-httpd_backup_post.c
+++ b/src/sync/sync-httpd_backup_post.c
@@ -682,16 +682,6 @@ handle_database_error (struct BackupContext *bc,
 }
 
 
-/**
- * Handle a client POSTing a backup to us.
- *
- * @param connection the MHD connection to handle
- * @param[in,out] connection_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
- * @return MHD result code
- */
 MHD_RESULT
 SH_backup_post (struct MHD_Connection *connection,
                 void **con_cls,
diff --git a/src/sync/sync-httpd_config.c b/src/sync/sync-httpd_config.c
index 563ac99..886f2af 100644
--- a/src/sync/sync-httpd_config.c
+++ b/src/sync/sync-httpd_config.c
@@ -14,7 +14,7 @@
   Sync; see the file COPYING.GPL.  If not, see <http://www.gnu.org/licenses/>
 */
 /**
- * @file backend/sync-httpd_config.c
+ * @file sync/sync-httpd_config.c
  * @brief headers for /config handler
  * @author Christian Grothoff
  */
@@ -31,17 +31,6 @@
  *    to be created
  */
 
-/**
- * Manages a /config call.
- *
- * @param rh context of the handler
- * @param connection the MHD connection to handle
- * @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
 SH_handler_config (struct SH_RequestHandler *rh,
                    struct MHD_Connection *connection,
diff --git a/src/sync/sync-httpd_config.h b/src/sync/sync-httpd_config.h
index 0c882e2..3cafade 100644
--- a/src/sync/sync-httpd_config.h
+++ b/src/sync/sync-httpd_config.h
@@ -14,7 +14,7 @@
   Sync; see the file COPYING.GPL.  If not, see <http://www.gnu.org/licenses/>
 */
 /**
- * @file backend/sync-httpd_config.h
+ * @file sync/sync-httpd_config.h
  * @brief headers for /config handler
  * @author Christian Grothoff
  */
diff --git a/src/sync/sync-httpd_mhd.c b/src/sync/sync-httpd_mhd.c
index 54b41f2..c7c4824 100644
--- a/src/sync/sync-httpd_mhd.c
+++ b/src/sync/sync-httpd_mhd.c
@@ -27,17 +27,6 @@
 #include "sync-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] 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
- * @return MHD result code
- */
 MHD_RESULT
 SH_MHD_handler_static_response (struct SH_RequestHandler *rh,
                                 struct MHD_Connection *connection,
@@ -58,17 +47,6 @@ SH_MHD_handler_static_response (struct SH_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] 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
- * @return MHD result code
- */
 MHD_RESULT
 SH_MHD_handler_agpl_redirect (struct SH_RequestHandler *rh,
                               struct MHD_Connection *connection,
diff --git a/src/syncdb/plugin_syncdb_postgres.c 
b/src/syncdb/plugin_syncdb_postgres.c
index 7b6b3a9..f0442d9 100644
--- a/src/syncdb/plugin_syncdb_postgres.c
+++ b/src/syncdb/plugin_syncdb_postgres.c
@@ -14,7 +14,7 @@
   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */
 /**
- * @file sync/plugin_syncdb_postgres.c
+ * @file syncdb/plugin_syncdb_postgres.c
  * @brief database helper functions for postgres used by sync
  * @author Christian Grothoff
  */
diff --git a/src/syncdb/sync-dbinit.c b/src/syncdb/sync-dbinit.c
index be7b2ae..d1c9e39 100644
--- a/src/syncdb/sync-dbinit.c
+++ b/src/syncdb/sync-dbinit.c
@@ -14,7 +14,7 @@
   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */
 /**
- * @file util/sync-dbinit.c
+ * @file syncdb/sync-dbinit.c
  * @brief Create tables for the sync database.
  * @author Christian Grothoff
  */
diff --git a/src/syncdb/sync_db_plugin.c b/src/syncdb/sync_db_plugin.c
index 995c41f..6739e4d 100644
--- a/src/syncdb/sync_db_plugin.c
+++ b/src/syncdb/sync_db_plugin.c
@@ -24,12 +24,6 @@
 #include <ltdl.h>
 
 
-/**
- * Initialize the plugin.
- *
- * @param cfg configuration to use
- * @return NULL on failure
- */
 struct SYNC_DatabasePlugin *
 SYNC_DB_plugin_load (const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
@@ -62,11 +56,6 @@ SYNC_DB_plugin_load (const struct 
GNUNET_CONFIGURATION_Handle *cfg)
 }
 
 
-/**
- * Shutdown the plugin.
- *
- * @param plugin the plugin to unload
- */
 void
 SYNC_DB_plugin_unload (struct SYNC_DatabasePlugin *plugin)
 {
diff --git a/src/testing/testing_api_cmd_backup_download.c 
b/src/testing/testing_api_cmd_backup_download.c
index f404912..eaa1b8f 100644
--- a/src/testing/testing_api_cmd_backup_download.c
+++ b/src/testing/testing_api_cmd_backup_download.c
@@ -17,7 +17,7 @@
   <http://www.gnu.org/licenses/>
 */
 /**
- * @file lib/testing_api_cmd_backup_download.c
+ * @file testing/testing_api_cmd_backup_download.c
  * @brief command to download data to the sync backend service.
  * @author Christian Grothoff
  */
diff --git a/src/testing/testing_api_cmd_backup_upload.c 
b/src/testing/testing_api_cmd_backup_upload.c
index 2b136d0..c030852 100644
--- a/src/testing/testing_api_cmd_backup_upload.c
+++ b/src/testing/testing_api_cmd_backup_upload.c
@@ -17,7 +17,7 @@
   <http://www.gnu.org/licenses/>
 */
 /**
- * @file lib/testing_api_cmd_backup_upload.c
+ * @file testing/testing_api_cmd_backup_upload.c
  * @brief command to upload data to the sync backend service.
  * @author Christian Grothoff
  */
diff --git a/src/testing/testing_api_helpers.c 
b/src/testing/testing_api_helpers.c
index a83c391..70a12f9 100644
--- a/src/testing/testing_api_helpers.c
+++ b/src/testing/testing_api_helpers.c
@@ -17,7 +17,7 @@
   <http://www.gnu.org/licenses/>
 */
 /**
- * @file lib/testing_api_helpers.c
+ * @file testing/testing_api_helpers.c
  * @brief helper functions for test library.
  * @author Christian Grothoff
  * @author Marcello Stanisci
diff --git a/src/util/sync-config.c b/src/util/sync-config.c
index 0e432f8..fd462f2 100644
--- a/src/util/sync-config.c
+++ b/src/util/sync-config.c
@@ -19,7 +19,7 @@
  */
 
 /**
- * @file util/taler-config.c
+ * @file util/sync-config.c
  * @brief tool to access and manipulate Taler configuration files
  * @author Christian Grothoff
  */

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