[gnunet] 52/90: -DOC: Documentation cleanup pass through FS subsystem

[gnunet]

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

martin-schanzenbach pushed a commit to branch master
in repository gnunet.

commit 182a45fc9a4d7f127034b9dc4adae999c4c7e4ad
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Wed Sep 7 21:02:47 2022 +0100

    -DOC: Documentation cleanup pass through FS subsystem
---
 src/fs/fs_download.c                    | 1 -
 src/fs/fs_search.c                      | 4 ++--
 src/fs/fs_test_lib.c                    | 1 -
 src/fs/gnunet-service-fs.c              | 6 +++---
 src/fs/gnunet-service-fs_cadet_server.c | 1 -
 src/fs/gnunet-service-fs_cp.c           | 2 --
 src/fs/gnunet-service-fs_push.c         | 2 +-
 src/fs/plugin_block_fs.c                | 3 +--
 src/include/gnunet_fs_service.h         | 2 +-
 9 files changed, 8 insertions(+), 14 deletions(-)

diff --git a/src/fs/fs_download.c b/src/fs/fs_download.c
index 3f5ac6c64..102b297c1 100644
--- a/src/fs/fs_download.c
+++ b/src/fs/fs_download.c
@@ -1422,7 +1422,6 @@ try_reconnect (struct GNUNET_FS_DownloadContext *dc)
  * We're allowed to ask the FS service for our blocks.  Start the download.
  *
  * @param cls the 'struct GNUNET_FS_DownloadContext'
- * @param mq handle to use for communication with FS (we must destroy it!)
  */
 static void
 activate_fs_download (void *cls)
diff --git a/src/fs/fs_search.c b/src/fs/fs_search.c
index 3f3d30146..5538b7838 100644
--- a/src/fs/fs_search.c
+++ b/src/fs/fs_search.c
@@ -927,7 +927,7 @@ try_reconnect (struct GNUNET_FS_SearchContext *sc);
  * We check a result message from the service.
  *
  * @param cls closure
- * @param msg result message received
+ * @param cm result message received
  */
 static int
 check_result (void *cls,
@@ -942,7 +942,7 @@ check_result (void *cls,
  * We process a search result from the service.
  *
  * @param cls closure
- * @param msg result message received
+ * @param cm result message received
  */
 static void
 handle_result (void *cls,
diff --git a/src/fs/fs_test_lib.c b/src/fs/fs_test_lib.c
index 94bf469f7..f80a2859c 100644
--- a/src/fs/fs_test_lib.c
+++ b/src/fs/fs_test_lib.c
@@ -177,7 +177,6 @@ struct TestDownloadOperation
  * Task scheduled to report on the completion of our publish operation.
  *
  * @param cls the publish operation context
- * @param tc scheduler context (unused)
  */
 static void
 report_uri (void *cls)
diff --git a/src/fs/gnunet-service-fs.c b/src/fs/gnunet-service-fs.c
index c22a5b5a9..7da92ed44 100644
--- a/src/fs/gnunet-service-fs.c
+++ b/src/fs/gnunet-service-fs.c
@@ -603,7 +603,7 @@ update_latencies (void *cls,
  * Check P2P "PUT" message.
  *
  * @param cls closure with the `struct GSF_ConnectedPeer`
- * @param message the actual message
+ * @param put the actual message
  * @return #GNUNET_OK to keep the connection open,
  *         #GNUNET_SYSERR to close it (signal serious error)
  */
@@ -1063,7 +1063,7 @@ hash_for_index_val (void *cls,
  * Handle INDEX_START-message.
  *
  * @param cls identification of the client
- * @param message the actual message
+ * @param ism the actual message
  */
 static void
 handle_client_index_start (void *cls,
@@ -1144,7 +1144,7 @@ handle_client_index_list_get (void *cls,
  * Handle UNINDEX-message.
  *
  * @param cls identification of the client
- * @param message the actual message
+ * @param um the actual message
  */
 static void
 handle_client_unindex (void *cls,
diff --git a/src/fs/gnunet-service-fs_cadet_server.c 
b/src/fs/gnunet-service-fs_cadet_server.c
index 395842ebb..8bfe91cf0 100644
--- a/src/fs/gnunet-service-fs_cadet_server.c
+++ b/src/fs/gnunet-service-fs_cadet_server.c
@@ -415,7 +415,6 @@ connect_cb (void *cls,
  *
  * @param cls  our `struct CadetClient`
  * @param channel channel of the disconnecting client
- * @param channel_ctx
  */
 static void
 disconnect_cb (void *cls,
diff --git a/src/fs/gnunet-service-fs_cp.c b/src/fs/gnunet-service-fs_cp.c
index 96b21783c..29e4c5910 100644
--- a/src/fs/gnunet-service-fs_cp.c
+++ b/src/fs/gnunet-service-fs_cp.c
@@ -1342,8 +1342,6 @@ handle_p2p_get (void *cls,
  * @param cp target peer
  * @param is_query is this a query (#GNUNET_YES) or content (#GNUNET_NO) or 
neither (#GNUNET_SYSERR)
  * @param priority how important is this request?
- * @param timeout when does this request timeout
- * @param size number of bytes we would like to send to the peer
  * @param env message to send
  */
 void
diff --git a/src/fs/gnunet-service-fs_push.c b/src/fs/gnunet-service-fs_push.c
index 80c2c00e6..92dbba8e6 100644
--- a/src/fs/gnunet-service-fs_push.c
+++ b/src/fs/gnunet-service-fs_push.c
@@ -210,7 +210,7 @@ find_content (void *cls);
 /**
  * Send the given block to the given peer.
  *
- * @param peer target peer
+ * @param mrp target peer
  * @param block the block
  * @return #GNUNET_YES if the block was deleted (!)
  */
diff --git a/src/fs/plugin_block_fs.c b/src/fs/plugin_block_fs.c
index 18aa289ef..11677a6b2 100644
--- a/src/fs/plugin_block_fs.c
+++ b/src/fs/plugin_block_fs.c
@@ -158,10 +158,9 @@ block_plugin_fs_get_key (void *cls,
  * Function called to validate a query.
  *
  * @param cls closure
- * @param ctx block context
  * @param type block type
  * @param query original query (hash)
- * @param xquery extrended query data (can be NULL, depending on type)
+ * @param xquery extended query data (can be NULL, depending on type)
  * @param xquery_size number of bytes in @a xquery
  * @return #GNUNET_OK if the query is fine, #GNUNET_NO if not
  */
diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h
index f40670ea5..8ae826380 100644
--- a/src/include/gnunet_fs_service.h
+++ b/src/include/gnunet_fs_service.h
@@ -464,7 +464,7 @@ GNUNET_FS_GETOPT_KEYWORDS (char shortName,
  * @param name long name of the option
  * @param argumentHelp help text for the option argument
  * @param description long help text for the option
- * @param[out] metadata set to the desired value
+ * @param[out] meta metadata set to the desired value
  */
 struct GNUNET_GETOPT_CommandLineOption
 GNUNET_FS_GETOPT_METADATA (char shortName,

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