From 763b8f71ba69bb6658461f8205804286d36543c1 Mon Sep 17 00:00:00 2001 From: Willow Liquorice Date: Wed, 7 Sep 2022 20:46:19 +0100 Subject: -DOC: Documentation cleanup pass through CADET subsystem --- src/cadet/cadet_api.c | 9 ++++----- src/cadet/cadet_api_list_tunnels.c | 2 +- src/cadet/gnunet-cadet-profiler.c | 2 -- src/cadet/gnunet-service-cadet.c | 3 +-- src/cadet/gnunet-service-cadet_connection.c | 6 +++--- src/cadet/gnunet-service-cadet_connection.h | 2 +- src/cadet/gnunet-service-cadet_core.c | 8 ++++---- src/cadet/gnunet-service-cadet_hello.c | 2 +- src/cadet/gnunet-service-cadet_paths.h | 4 ++-- src/cadet/gnunet-service-cadet_peer.c | 6 ------ src/cadet/gnunet-service-cadet_tunnels.c | 15 +++------------ src/cadet/gnunet-service-cadet_tunnels.h | 4 ++-- 12 files changed, 22 insertions(+), 41 deletions(-) (limited to 'src/cadet') diff --git a/src/cadet/cadet_api.c b/src/cadet/cadet_api.c index 00c3d2e48..0bfb01868 100644 --- a/src/cadet/cadet_api.c +++ b/src/cadet/cadet_api.c @@ -198,7 +198,6 @@ create_channel (struct GNUNET_CADET_Handle *h, * - Frees all memory used * * @param ch Pointer to the channel. - * @param call_cleaner Whether to call the cleaner handler. */ static void destroy_channel (struct GNUNET_CADET_Channel *ch) @@ -461,7 +460,7 @@ cadet_mq_cancel_impl (struct GNUNET_MQ_Handle *mq, void *impl_state) /** * Process the new channel notification and add it to the channels in the handle * - * @param h The cadet handle + * @param cls The cadet handle * @param msg A message with the details of the new incoming channel */ static void @@ -529,7 +528,7 @@ handle_channel_created ( /** * Process the channel destroy notification and free associated resources * - * @param h The cadet handle + * @param cls The cadet handle * @param msg A message with the details of the channel being destroyed */ static void @@ -582,7 +581,7 @@ check_local_data (void *cls, const struct GNUNET_CADET_LocalData *message) /** * Process the incoming data packets, call appropriate handlers. * - * @param h The cadet handle + * @param cls The cadet handle * @param message A message encapsulating the data */ static void @@ -620,7 +619,7 @@ handle_local_data (void *cls, const struct GNUNET_CADET_LocalData *message) * Process a local ACK message, enabling the client to send * more data to the service. * - * @param h Cadet handle. + * @param cls Cadet handle. * @param message Message itself. */ static void diff --git a/src/cadet/cadet_api_list_tunnels.c b/src/cadet/cadet_api_list_tunnels.c index e9ae069bb..dce12835f 100644 --- a/src/cadet/cadet_api_list_tunnels.c +++ b/src/cadet/cadet_api_list_tunnels.c @@ -95,7 +95,7 @@ handle_get_tunnels (void *cls, * Process a local reply about info on all tunnels, pass info to the user. * * @param cls a `struct GNUNET_CADET_ListTunnels *` - * @param message Message itself. + * @param msg Message itself. */ static void handle_get_tunnels_end (void *cls, diff --git a/src/cadet/gnunet-cadet-profiler.c b/src/cadet/gnunet-cadet-profiler.c index e61053f94..b84337370 100644 --- a/src/cadet/gnunet-cadet-profiler.c +++ b/src/cadet/gnunet-cadet-profiler.c @@ -659,8 +659,6 @@ ping (void *cls) /** * @brief Reply with a pong to origin. * - * @param cls Closure (peer). - * @param tc Task context. */ static void pong (struct GNUNET_CADET_Channel *channel, diff --git a/src/cadet/gnunet-service-cadet.c b/src/cadet/gnunet-service-cadet.c index dd1f05807..07b580005 100644 --- a/src/cadet/gnunet-service-cadet.c +++ b/src/cadet/gnunet-service-cadet.c @@ -442,7 +442,7 @@ shutdown_task (void *cls) * client @a cls opened port @a port. Bind them now. * * @param cls the `struct CadetClient` - * @param h_port the hashed port + * @param port the hashed port * @param value the `struct CadetChannel` * @return #GNUNET_YES (iterate over all such channels) */ @@ -1226,7 +1226,6 @@ client_disconnect_cb (void *cls, * Setup CADET internals. * * @param cls closure - * @param server the initialized server * @param c configuration to use */ static void diff --git a/src/cadet/gnunet-service-cadet_connection.c b/src/cadet/gnunet-service-cadet_connection.c index 66b67aa64..f01c1388e 100644 --- a/src/cadet/gnunet-service-cadet_connection.c +++ b/src/cadet/gnunet-service-cadet_connection.c @@ -431,9 +431,9 @@ GCC_ack_expected (const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid) /** * We observed an ACK for a message that was originally sent via - * the connection identified by @a cti. + * the connection identified by @a cid. * - * @param cti connection identifier where we got an ACK for a message + * @param cid connection identifier where we got an ACK for a message * that was originally sent via this connection (the ACK * may have gotten back to us via a different connection). */ @@ -983,7 +983,7 @@ GCC_transmit (struct CadetConnection *cc, struct GNUNET_MQ_Envelope *env) * Obtain the path used by this connection. * * @param cc connection - * @param off[out] set to the length of the path we use + * @param[out] off set to the length of the path we use * @return path to @a cc */ struct CadetPeerPath * diff --git a/src/cadet/gnunet-service-cadet_connection.h b/src/cadet/gnunet-service-cadet_connection.h index 53c0c1541..54c845b13 100644 --- a/src/cadet/gnunet-service-cadet_connection.h +++ b/src/cadet/gnunet-service-cadet_connection.h @@ -322,7 +322,7 @@ GCC_get_ct (struct CadetConnection *cc); * Obtain the path used by this connection. * * @param cc connection - * @param off[out] set to offset in this path where the connection @a cc ends + * @param[out] off set to offset in this path where the connection @a cc ends * @return path to @a cc */ struct CadetPeerPath * diff --git a/src/cadet/gnunet-service-cadet_core.c b/src/cadet/gnunet-service-cadet_core.c index bff7632da..68f7405c3 100644 --- a/src/cadet/gnunet-service-cadet_core.c +++ b/src/cadet/gnunet-service-cadet_core.c @@ -612,10 +612,10 @@ timeout_cb (void *cls) * later if the connection ever goes down. * * @param cls the `struct RouteDirection` - * @param available #GNUNET_YES if sending is now possible, - * #GNUNET_NO if sending is no longer possible - * #GNUNET_SYSERR if sending is no longer possible - * and the last envelope was discarded + * @param ready #GNUNET_YES if sending is now possible, + * #GNUNET_NO if sending is no longer possible + * #GNUNET_SYSERR if sending is no longer possible + * and the last envelope was discarded */ static void dir_ready_cb (void *cls, int ready) diff --git a/src/cadet/gnunet-service-cadet_hello.c b/src/cadet/gnunet-service-cadet_hello.c index c7857032b..e1850d60a 100644 --- a/src/cadet/gnunet-service-cadet_hello.c +++ b/src/cadet/gnunet-service-cadet_hello.c @@ -57,7 +57,7 @@ static struct GNUNET_PEERINFO_NotifyContext *nc; * Process each hello message received from peerinfo. * * @param cls Closure (unused). - * @param peer Identity of the peer. + * @param id Identity of the peer. * @param hello Hello of the peer. * @param err_msg Error message. */ diff --git a/src/cadet/gnunet-service-cadet_paths.h b/src/cadet/gnunet-service-cadet_paths.h index defdd0df2..0f3b4dd1a 100644 --- a/src/cadet/gnunet-service-cadet_paths.h +++ b/src/cadet/gnunet-service-cadet_paths.h @@ -53,8 +53,8 @@ GCPP_try_path_from_dht (const struct GNUNET_DHT_PathElement *get_path, * We got an incoming connection, obtain the corresponding path. * * @param path_length number of segments on the @a path - * @param path through the network, in reverse order - * (we are at the end, at index @a path_length) + * @param pids path through the network, in reverse order + * (we are at the end, at index @a path_length) * @return corresponding path object */ struct CadetPeerPath * diff --git a/src/cadet/gnunet-service-cadet_peer.c b/src/cadet/gnunet-service-cadet_peer.c index 3fb0eed94..f2b508ae0 100644 --- a/src/cadet/gnunet-service-cadet_peer.c +++ b/src/cadet/gnunet-service-cadet_peer.c @@ -232,12 +232,6 @@ struct CadetPeer }; -/** - * Get the static string for a peer ID. - * - * @param cp Peer. - * @return Static string for it's ID. - */ const char * GCP_2s (const struct CadetPeer *cp) { diff --git a/src/cadet/gnunet-service-cadet_tunnels.c b/src/cadet/gnunet-service-cadet_tunnels.c index ca91a0e01..c7e422926 100644 --- a/src/cadet/gnunet-service-cadet_tunnels.c +++ b/src/cadet/gnunet-service-cadet_tunnels.c @@ -674,7 +674,7 @@ new_ephemeral (struct CadetTunnelAxolotl *ax) * @param size Size of @c plaintext. * @param iv Initialization vector for the message. * @param key Key to use. - * @param hmac[out] Destination to store the HMAC. + * @param[out] hmac Destination to store the HMAC. */ static void t_hmac (const void *plaintext, @@ -890,7 +890,7 @@ t_ax_decrypt (struct CadetTunnelAxolotl *ax, * Encrypt header with the axolotl header key. * * @param ax key material to use. - * @param[in|out] msg Message whose header to encrypt. + * @param[in,out] msg Message whose header to encrypt. */ static void t_h_encrypt (struct CadetTunnelAxolotl *ax, @@ -1488,7 +1488,7 @@ cleanup_ax (struct CadetTunnelAxolotl *ax) * Computes the new chain keys, and root keys, etc, and also checks * whether this is a replay of the current chain. * - * @param[in|out] axolotl chain key state to recompute + * @param[in,out] ax chain key state to recompute * @param pid peer identity of the other peer * @param ephemeral_key ephemeral public key of the other peer * @param ratchet_key senders next ephemeral public key @@ -3487,15 +3487,6 @@ GCT_send (struct CadetTunnel *t, } -/** - * Cancel a previously sent message while it's in the queue. - * - * ONLY can be called before the continuation given to the send - * function is called. Once the continuation is called, the message is - * no longer in the queue! - * - * @param tq Handle to the queue entry to cancel. - */ void GCT_send_cancel (struct CadetTunnelQueueEntry *tq) { diff --git a/src/cadet/gnunet-service-cadet_tunnels.h b/src/cadet/gnunet-service-cadet_tunnels.h index 018a3ec73..e893955a0 100644 --- a/src/cadet/gnunet-service-cadet_tunnels.h +++ b/src/cadet/gnunet-service-cadet_tunnels.h @@ -160,8 +160,8 @@ GCT_get_destination (struct CadetTunnel *t); * Consider using the path @a p for the tunnel @a t. * The tunnel destination is at offset @a off in path @a p. * - * @param cls our tunnel - * @param path a path to our destination + * @param t our tunnel + * @param p a path to our destination * @param off offset of the destination on path @a path */ void -- cgit v1.2.3