From ac453afa5e8827759653b76dcd3c5f4317330285 Mon Sep 17 00:00:00 2001 From: Willow Liquorice Date: Wed, 7 Sep 2022 20:53:34 +0100 Subject: -DOC: Documentation cleanup pass through RPS subsystem --- src/rps/gnunet-rps-profiler.c | 2 +- src/rps/gnunet-rps.c | 2 +- src/rps/gnunet-service-rps.c | 12 ++++++------ src/rps/gnunet-service-rps_sampler_elem.c | 2 +- src/rps/rps-sampler_common.c | 22 ---------------------- src/rps/rps-sampler_common.h | 2 -- src/rps/rps_api.c | 2 +- 7 files changed, 10 insertions(+), 34 deletions(-) (limited to 'src/rps') diff --git a/src/rps/gnunet-rps-profiler.c b/src/rps/gnunet-rps-profiler.c index 6d1236f08..df10ad5da 100644 --- a/src/rps/gnunet-rps-profiler.c +++ b/src/rps/gnunet-rps-profiler.c @@ -2206,7 +2206,7 @@ get_idx_of_pid (const struct GNUNET_PeerIdentity *pid) * @brief Counts number of peers in view of a that have b in their view * * @param a - * @param uint32_tb + * @param b * * @return */ diff --git a/src/rps/gnunet-rps.c b/src/rps/gnunet-rps.c index 33c03f006..f90fc0d88 100644 --- a/src/rps/gnunet-rps.c +++ b/src/rps/gnunet-rps.c @@ -149,7 +149,7 @@ view_update_handle (void *cls, /** * Callback called on receipt of peer from biased stream * - * @param n number of peers + * @param num_peers number of peers * @param recv_peers the received peers */ static void diff --git a/src/rps/gnunet-service-rps.c b/src/rps/gnunet-service-rps.c index f6fcf3ae7..be9324af9 100644 --- a/src/rps/gnunet-service-rps.c +++ b/src/rps/gnunet-service-rps.c @@ -1191,7 +1191,7 @@ check_operation_scheduled (const struct PeerContext *peer_ctx, /** * @brief Callback for scheduler to destroy a channel * - * @param cls Context of the channel + * @param channel_ctx Context of the channel */ static void destroy_channel (struct ChannelCtx *channel_ctx) @@ -3324,7 +3324,7 @@ check_client_seed (void *cls, const struct GNUNET_RPS_CS_SeedMessage *msg) * Handle seed from the client. * * @param cls closure - * @param message the actual message + * @param msg the actual message */ static void handle_client_seed (void *cls, @@ -3362,7 +3362,7 @@ handle_client_seed (void *cls, * Handle RPS request from the client. * * @param cls Client context - * @param message Message containing the number of updates the client wants to + * @param msg Message containing the number of updates the client wants to * receive */ static void @@ -3416,7 +3416,7 @@ handle_client_view_cancel (void *cls, * Handle RPS request for biased stream from the client. * * @param cls Client context - * @param message unused + * @param msg unused */ static void handle_client_stream_request (void *cls, @@ -4691,7 +4691,7 @@ valid_peers_iterator (void *cls, * @param cls Closure - Sub * @param peer id of the peer, NULL for last call * @param hello hello message for the peer (can be NULL) - * @param error message + * @param err_msg error message */ void process_peerinfo_peers (void *cls, @@ -4823,7 +4823,7 @@ client_connect_cb (void *cls, * Callback called when a client disconnected from the service * * @param cls closure for the service - * @param c the client that disconnected + * @param client the client that disconnected * @param internal_cls should be equal to @a c */ static void diff --git a/src/rps/gnunet-service-rps_sampler_elem.c b/src/rps/gnunet-service-rps_sampler_elem.c index aa8b72445..a6dc755a3 100644 --- a/src/rps/gnunet-service-rps_sampler_elem.c +++ b/src/rps/gnunet-service-rps_sampler_elem.c @@ -44,7 +44,7 @@ /** * Reinitialise a previously initialised sampler element. * - * @param sampler_el The sampler element to (re-) initialise + * @param sampler_elem The sampler element to (re-) initialise */ void RPS_sampler_elem_reinit (struct RPS_SamplerElement *sampler_elem) diff --git a/src/rps/rps-sampler_common.c b/src/rps/rps-sampler_common.c index a30ba06a1..e3fb79501 100644 --- a/src/rps/rps-sampler_common.c +++ b/src/rps/rps-sampler_common.c @@ -191,15 +191,6 @@ RPS_sampler_set_desired_probability (struct RPS_Sampler *sampler, } -/** - * @brief Set the deficiency factor. - * - * Only used/useful with the client sampler - * (Maybe move to rps-sampler_client.{h|c} ?) - * - * @param sampler - * @param desired_probability - */ void RPS_sampler_set_deficiency_factor (struct RPS_Sampler *sampler, double deficiency_factor) @@ -440,7 +431,6 @@ RPS_sampler_resize (struct RPS_Sampler *sampler, unsigned int new_size) * Empty the sampler. * * @param sampler the sampler to empty. - * @param new_size the new size of the sampler */ static void sampler_empty (struct RPS_Sampler *sampler) @@ -555,18 +545,6 @@ check_peer_info_ready (void *cls, } -/** - * Get n random peers out of the sampled peers. - * - * We might want to reinitialise this sampler after giving the - * corrsponding peer to the client. - * Random with or without consumption? - * - * @param sampler the sampler to get peers from. - * @param cb callback that will be called once the ids are ready. - * @param cls closure given to @a cb - * @param num_peers the number of peers requested - */ struct RPS_SamplerRequestHandle * RPS_sampler_get_n_rand_peers (struct RPS_Sampler *sampler, uint32_t num_peers, diff --git a/src/rps/rps-sampler_common.h b/src/rps/rps-sampler_common.h index c60d37217..94727028a 100644 --- a/src/rps/rps-sampler_common.h +++ b/src/rps/rps-sampler_common.h @@ -325,8 +325,6 @@ RPS_sampler_resize (struct RPS_Sampler *sampler, unsigned int new_size); * @param sampler the sampler to get peers from. * @param cb callback that will be called once the ids are ready. * @param cls closure given to @a cb - * @param for_client #GNUNET_YES if result is used for client, - * #GNUNET_NO if used internally * @param num_peers the number of peers requested */ struct RPS_SamplerRequestHandle * diff --git a/src/rps/rps_api.c b/src/rps/rps_api.c index bb4c3597e..c4166745a 100644 --- a/src/rps/rps_api.c +++ b/src/rps/rps_api.c @@ -745,7 +745,7 @@ mq_error_handler (void *cls, * (-group) * * @param share_val Share value - * @param hash[out] Pointer to the location in which the hash will be stored. + * @param[out] hash Pointer to the location in which the hash will be stored. */ static void hash_from_share_val (const char *share_val, -- cgit v1.2.3