[gnunet] 51/90: -DOC: Documentation cleanup pass through DHT 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 c77b7424ff5e8da878da3a55c6ce126c160d2d42
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Wed Sep 7 21:00:13 2022 +0100

    -DOC: Documentation cleanup pass through DHT subsystem
---
 src/dht/gnunet-service-dht.h            |  1 -
 src/dht/gnunet-service-dht_clients.c    | 12 +++++-------
 src/dht/gnunet-service-dht_neighbours.c | 11 +++++------
 src/dht/gnunet-service-dht_neighbours.h |  2 --
 src/dht/gnunet-service-dht_routing.c    |  2 --
 5 files changed, 10 insertions(+), 18 deletions(-)

diff --git a/src/dht/gnunet-service-dht.h b/src/dht/gnunet-service-dht.h
index f7c2fed76..dcc972fc2 100644
--- a/src/dht/gnunet-service-dht.h
+++ b/src/dht/gnunet-service-dht.h
@@ -144,7 +144,6 @@ GDS_u_hold (struct GDS_Underlay *u,
  *
  * @param bd block details
  * @param query_hash hash of the original query, might not match key in @a bd
- * @param trunc_peer peer at which the path was truncated, or NULL if path 
starts at the origin
  * @param get_path_length number of entries in @a get_path
  * @param get_path path the reply has taken
  * @return true on success, false on failures
diff --git a/src/dht/gnunet-service-dht_clients.c 
b/src/dht/gnunet-service-dht_clients.c
index b4d139eec..19b464e63 100644
--- a/src/dht/gnunet-service-dht_clients.c
+++ b/src/dht/gnunet-service-dht_clients.c
@@ -584,7 +584,7 @@ handle_local_result (void *cls,
  * Check DHT GET messages from the client.
  *
  * @param cls the client we received this message from
- * @param message the actual message received
+ * @param get the actual message received
  * @return #GNUNET_OK (always)
  */
 static enum GNUNET_GenericReturnValue
@@ -602,7 +602,7 @@ check_dht_local_get (void *cls,
  * Handler for DHT GET messages from the client.
  *
  * @param cls the client we received this message from
- * @param message the actual message received
+ * @param get the actual message received
  */
 static void
 handle_dht_local_get (void *cls,
@@ -720,7 +720,7 @@ find_by_unique_id (void *cls,
  * Check "GET result seen" messages from the client.
  *
  * @param cls the client we received this message from
- * @param message the actual message received
+ * @param seen the actual message received
  * @return #GNUNET_OK if @a seen is well-formed
  */
 static enum GNUNET_GenericReturnValue
@@ -746,7 +746,7 @@ check_dht_local_get_result_seen (
  * Handler for "GET result seen" messages from the client.
  *
  * @param cls the client we received this message from
- * @param message the actual message received
+ * @param seen the actual message received
  */
 static void
 handle_dht_local_get_result_seen (
@@ -835,7 +835,7 @@ remove_by_unique_id (void *cls,
  * depending on message type (if processed locally)
  *
  * @param cls client we received this message from
- * @param message the actual message received
+ * @param dht_stop_msg the actual message received
  *
  */
 static void
@@ -1603,8 +1603,6 @@ GDS_CLIENTS_process_put (const struct 
GNUNET_DATACACHE_Block *bd,
 
 /**
  * Initialize client subsystem.
- *
- * @param server the initialized server
  */
 static void
 GDS_CLIENTS_init (void)
diff --git a/src/dht/gnunet-service-dht_neighbours.c 
b/src/dht/gnunet-service-dht_neighbours.c
index 65b3014fd..9d1dff8a6 100644
--- a/src/dht/gnunet-service-dht_neighbours.c
+++ b/src/dht/gnunet-service-dht_neighbours.c
@@ -529,7 +529,6 @@ do_send (struct PeerInfo *pi,
  * Sign that we are routing a message from @a pred to @a succ.
  * (So the route is $PRED->us->$SUCC).
  *
- * @param key key of the data (not necessarily the query hash)
  * @param data payload (the block)
  * @param data_size number of bytes in @a data
  * @param exp_time expiration time of @a data
@@ -1890,7 +1889,7 @@ GDS_NEIGHBOURS_handle_reply (struct PeerInfo *pi,
  * Check validity of a p2p put request.
  *
  * @param cls closure with the `struct PeerInfo` of the sender
- * @param message message
+ * @param put message
  * @return #GNUNET_OK if the message is valid
  */
 static enum GNUNET_GenericReturnValue
@@ -1933,7 +1932,7 @@ check_dht_p2p_put (void *cls,
  * Core handler for p2p put requests.
  *
  * @param cls closure with the `struct Target` of the sender
- * @param message message
+ * @param put message
  */
 static void
 handle_dht_p2p_put (void *cls,
@@ -2503,7 +2502,7 @@ process_reply_with_path (const struct 
GNUNET_DATACACHE_Block *bd,
  * Check validity of p2p result message.
  *
  * @param cls closure
- * @param message message
+ * @param prm message
  * @return #GNUNET_YES if the message is well-formed
  */
 static enum GNUNET_GenericReturnValue
@@ -2542,7 +2541,7 @@ check_dht_p2p_result (void *cls,
  * Core handler for p2p result messages.
  *
  * @param cls closure
- * @param message message
+ * @param prm message
  */
 static void
 handle_dht_p2p_result (void *cls,
@@ -2754,7 +2753,7 @@ check_dht_p2p_hello (void *cls,
  * Core handler for p2p HELLO messages.
  *
  * @param cls closure
- * @param message message
+ * @param hello message
  */
 static void
 handle_dht_p2p_hello (void *cls,
diff --git a/src/dht/gnunet-service-dht_neighbours.h 
b/src/dht/gnunet-service-dht_neighbours.h
index 2aa304242..85e18d46d 100644
--- a/src/dht/gnunet-service-dht_neighbours.h
+++ b/src/dht/gnunet-service-dht_neighbours.h
@@ -101,7 +101,6 @@ GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type type,
  * forwarding to local clients.
  *
  * @param pi neighbour that should receive the block
- * @param type type of the block
  * @param bd details about the reply
  * @param query_hash query that was used for the request
  * @param get_path_length number of entries in put_path
@@ -175,7 +174,6 @@ GDS_u_disconnect (void *ctx);
  * Function to call when we receive a message.
  *
  * @param cls the closure
- * @param origin where the message originated from
  * @param[in,out] tctx ctx of target address where we received the message from
  * @param[in,out] sctx ctx of our own source address at which we received the 
message
  * @param message the message we received @param message_size number of
diff --git a/src/dht/gnunet-service-dht_routing.c 
b/src/dht/gnunet-service-dht_routing.c
index 8f87751bb..d81a2b2e1 100644
--- a/src/dht/gnunet-service-dht_routing.c
+++ b/src/dht/gnunet-service-dht_routing.c
@@ -341,8 +341,6 @@ try_combine_recent (void *cls,
  * @param key key for the content
  * @param xquery extended query
  * @param xquery_size number of bytes in @a xquery
- * @param reply_bf bloomfilter to filter duplicates
- * @param reply_bf_mutator mutator for @a reply_bf
  */
 void
 GDS_ROUTING_add (const struct GNUNET_PeerIdentity *sender,

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