diff options
author | Willow Liquorice <willow@howhill.com> | 2022-09-07 20:46:19 +0100 |
---|---|---|
committer | Willow Liquorice <willow@howhill.com> | 2022-10-03 00:44:34 +0100 |
commit | 763b8f71ba69bb6658461f8205804286d36543c1 (patch) | |
tree | 79be16b523aaac540132265fb50d6dd572de09df /src/cadet | |
parent | dd797c2c6c01520fa73b1fd335ccd42df86b1b4d (diff) | |
download | gnunet-763b8f71ba69bb6658461f8205804286d36543c1.tar.gz gnunet-763b8f71ba69bb6658461f8205804286d36543c1.zip |
-DOC: Documentation cleanup pass through CADET subsystem
Diffstat (limited to 'src/cadet')
-rw-r--r-- | src/cadet/cadet_api.c | 9 | ||||
-rw-r--r-- | src/cadet/cadet_api_list_tunnels.c | 2 | ||||
-rw-r--r-- | src/cadet/gnunet-cadet-profiler.c | 2 | ||||
-rw-r--r-- | src/cadet/gnunet-service-cadet.c | 3 | ||||
-rw-r--r-- | src/cadet/gnunet-service-cadet_connection.c | 6 | ||||
-rw-r--r-- | src/cadet/gnunet-service-cadet_connection.h | 2 | ||||
-rw-r--r-- | src/cadet/gnunet-service-cadet_core.c | 8 | ||||
-rw-r--r-- | src/cadet/gnunet-service-cadet_hello.c | 2 | ||||
-rw-r--r-- | src/cadet/gnunet-service-cadet_paths.h | 4 | ||||
-rw-r--r-- | src/cadet/gnunet-service-cadet_peer.c | 6 | ||||
-rw-r--r-- | src/cadet/gnunet-service-cadet_tunnels.c | 15 | ||||
-rw-r--r-- | src/cadet/gnunet-service-cadet_tunnels.h | 4 |
12 files changed, 22 insertions, 41 deletions
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, | |||
198 | * - Frees all memory used | 198 | * - Frees all memory used |
199 | * | 199 | * |
200 | * @param ch Pointer to the channel. | 200 | * @param ch Pointer to the channel. |
201 | * @param call_cleaner Whether to call the cleaner handler. | ||
202 | */ | 201 | */ |
203 | static void | 202 | static void |
204 | destroy_channel (struct GNUNET_CADET_Channel *ch) | 203 | destroy_channel (struct GNUNET_CADET_Channel *ch) |
@@ -461,7 +460,7 @@ cadet_mq_cancel_impl (struct GNUNET_MQ_Handle *mq, void *impl_state) | |||
461 | /** | 460 | /** |
462 | * Process the new channel notification and add it to the channels in the handle | 461 | * Process the new channel notification and add it to the channels in the handle |
463 | * | 462 | * |
464 | * @param h The cadet handle | 463 | * @param cls The cadet handle |
465 | * @param msg A message with the details of the new incoming channel | 464 | * @param msg A message with the details of the new incoming channel |
466 | */ | 465 | */ |
467 | static void | 466 | static void |
@@ -529,7 +528,7 @@ handle_channel_created ( | |||
529 | /** | 528 | /** |
530 | * Process the channel destroy notification and free associated resources | 529 | * Process the channel destroy notification and free associated resources |
531 | * | 530 | * |
532 | * @param h The cadet handle | 531 | * @param cls The cadet handle |
533 | * @param msg A message with the details of the channel being destroyed | 532 | * @param msg A message with the details of the channel being destroyed |
534 | */ | 533 | */ |
535 | static void | 534 | static void |
@@ -582,7 +581,7 @@ check_local_data (void *cls, const struct GNUNET_CADET_LocalData *message) | |||
582 | /** | 581 | /** |
583 | * Process the incoming data packets, call appropriate handlers. | 582 | * Process the incoming data packets, call appropriate handlers. |
584 | * | 583 | * |
585 | * @param h The cadet handle | 584 | * @param cls The cadet handle |
586 | * @param message A message encapsulating the data | 585 | * @param message A message encapsulating the data |
587 | */ | 586 | */ |
588 | static void | 587 | static void |
@@ -620,7 +619,7 @@ handle_local_data (void *cls, const struct GNUNET_CADET_LocalData *message) | |||
620 | * Process a local ACK message, enabling the client to send | 619 | * Process a local ACK message, enabling the client to send |
621 | * more data to the service. | 620 | * more data to the service. |
622 | * | 621 | * |
623 | * @param h Cadet handle. | 622 | * @param cls Cadet handle. |
624 | * @param message Message itself. | 623 | * @param message Message itself. |
625 | */ | 624 | */ |
626 | static void | 625 | 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, | |||
95 | * Process a local reply about info on all tunnels, pass info to the user. | 95 | * Process a local reply about info on all tunnels, pass info to the user. |
96 | * | 96 | * |
97 | * @param cls a `struct GNUNET_CADET_ListTunnels *` | 97 | * @param cls a `struct GNUNET_CADET_ListTunnels *` |
98 | * @param message Message itself. | 98 | * @param msg Message itself. |
99 | */ | 99 | */ |
100 | static void | 100 | static void |
101 | handle_get_tunnels_end (void *cls, | 101 | 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) | |||
659 | /** | 659 | /** |
660 | * @brief Reply with a pong to origin. | 660 | * @brief Reply with a pong to origin. |
661 | * | 661 | * |
662 | * @param cls Closure (peer). | ||
663 | * @param tc Task context. | ||
664 | */ | 662 | */ |
665 | static void | 663 | static void |
666 | pong (struct GNUNET_CADET_Channel *channel, | 664 | 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) | |||
442 | * client @a cls opened port @a port. Bind them now. | 442 | * client @a cls opened port @a port. Bind them now. |
443 | * | 443 | * |
444 | * @param cls the `struct CadetClient` | 444 | * @param cls the `struct CadetClient` |
445 | * @param h_port the hashed port | 445 | * @param port the hashed port |
446 | * @param value the `struct CadetChannel` | 446 | * @param value the `struct CadetChannel` |
447 | * @return #GNUNET_YES (iterate over all such channels) | 447 | * @return #GNUNET_YES (iterate over all such channels) |
448 | */ | 448 | */ |
@@ -1226,7 +1226,6 @@ client_disconnect_cb (void *cls, | |||
1226 | * Setup CADET internals. | 1226 | * Setup CADET internals. |
1227 | * | 1227 | * |
1228 | * @param cls closure | 1228 | * @param cls closure |
1229 | * @param server the initialized server | ||
1230 | * @param c configuration to use | 1229 | * @param c configuration to use |
1231 | */ | 1230 | */ |
1232 | static void | 1231 | 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) | |||
431 | 431 | ||
432 | /** | 432 | /** |
433 | * We observed an ACK for a message that was originally sent via | 433 | * We observed an ACK for a message that was originally sent via |
434 | * the connection identified by @a cti. | 434 | * the connection identified by @a cid. |
435 | * | 435 | * |
436 | * @param cti connection identifier where we got an ACK for a message | 436 | * @param cid connection identifier where we got an ACK for a message |
437 | * that was originally sent via this connection (the ACK | 437 | * that was originally sent via this connection (the ACK |
438 | * may have gotten back to us via a different connection). | 438 | * may have gotten back to us via a different connection). |
439 | */ | 439 | */ |
@@ -983,7 +983,7 @@ GCC_transmit (struct CadetConnection *cc, struct GNUNET_MQ_Envelope *env) | |||
983 | * Obtain the path used by this connection. | 983 | * Obtain the path used by this connection. |
984 | * | 984 | * |
985 | * @param cc connection | 985 | * @param cc connection |
986 | * @param off[out] set to the length of the path we use | 986 | * @param[out] off set to the length of the path we use |
987 | * @return path to @a cc | 987 | * @return path to @a cc |
988 | */ | 988 | */ |
989 | struct CadetPeerPath * | 989 | 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); | |||
322 | * Obtain the path used by this connection. | 322 | * Obtain the path used by this connection. |
323 | * | 323 | * |
324 | * @param cc connection | 324 | * @param cc connection |
325 | * @param off[out] set to offset in this path where the connection @a cc ends | 325 | * @param[out] off set to offset in this path where the connection @a cc ends |
326 | * @return path to @a cc | 326 | * @return path to @a cc |
327 | */ | 327 | */ |
328 | struct CadetPeerPath * | 328 | 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) | |||
612 | * later if the connection ever goes down. | 612 | * later if the connection ever goes down. |
613 | * | 613 | * |
614 | * @param cls the `struct RouteDirection` | 614 | * @param cls the `struct RouteDirection` |
615 | * @param available #GNUNET_YES if sending is now possible, | 615 | * @param ready #GNUNET_YES if sending is now possible, |
616 | * #GNUNET_NO if sending is no longer possible | 616 | * #GNUNET_NO if sending is no longer possible |
617 | * #GNUNET_SYSERR if sending is no longer possible | 617 | * #GNUNET_SYSERR if sending is no longer possible |
618 | * and the last envelope was discarded | 618 | * and the last envelope was discarded |
619 | */ | 619 | */ |
620 | static void | 620 | static void |
621 | dir_ready_cb (void *cls, int ready) | 621 | 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; | |||
57 | * Process each hello message received from peerinfo. | 57 | * Process each hello message received from peerinfo. |
58 | * | 58 | * |
59 | * @param cls Closure (unused). | 59 | * @param cls Closure (unused). |
60 | * @param peer Identity of the peer. | 60 | * @param id Identity of the peer. |
61 | * @param hello Hello of the peer. | 61 | * @param hello Hello of the peer. |
62 | * @param err_msg Error message. | 62 | * @param err_msg Error message. |
63 | */ | 63 | */ |
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, | |||
53 | * We got an incoming connection, obtain the corresponding path. | 53 | * We got an incoming connection, obtain the corresponding path. |
54 | * | 54 | * |
55 | * @param path_length number of segments on the @a path | 55 | * @param path_length number of segments on the @a path |
56 | * @param path through the network, in reverse order | 56 | * @param pids path through the network, in reverse order |
57 | * (we are at the end, at index @a path_length) | 57 | * (we are at the end, at index @a path_length) |
58 | * @return corresponding path object | 58 | * @return corresponding path object |
59 | */ | 59 | */ |
60 | struct CadetPeerPath * | 60 | 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 | |||
232 | }; | 232 | }; |
233 | 233 | ||
234 | 234 | ||
235 | /** | ||
236 | * Get the static string for a peer ID. | ||
237 | * | ||
238 | * @param cp Peer. | ||
239 | * @return Static string for it's ID. | ||
240 | */ | ||
241 | const char * | 235 | const char * |
242 | GCP_2s (const struct CadetPeer *cp) | 236 | GCP_2s (const struct CadetPeer *cp) |
243 | { | 237 | { |
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) | |||
674 | * @param size Size of @c plaintext. | 674 | * @param size Size of @c plaintext. |
675 | * @param iv Initialization vector for the message. | 675 | * @param iv Initialization vector for the message. |
676 | * @param key Key to use. | 676 | * @param key Key to use. |
677 | * @param hmac[out] Destination to store the HMAC. | 677 | * @param[out] hmac Destination to store the HMAC. |
678 | */ | 678 | */ |
679 | static void | 679 | static void |
680 | t_hmac (const void *plaintext, | 680 | t_hmac (const void *plaintext, |
@@ -890,7 +890,7 @@ t_ax_decrypt (struct CadetTunnelAxolotl *ax, | |||
890 | * Encrypt header with the axolotl header key. | 890 | * Encrypt header with the axolotl header key. |
891 | * | 891 | * |
892 | * @param ax key material to use. | 892 | * @param ax key material to use. |
893 | * @param[in|out] msg Message whose header to encrypt. | 893 | * @param[in,out] msg Message whose header to encrypt. |
894 | */ | 894 | */ |
895 | static void | 895 | static void |
896 | t_h_encrypt (struct CadetTunnelAxolotl *ax, | 896 | t_h_encrypt (struct CadetTunnelAxolotl *ax, |
@@ -1488,7 +1488,7 @@ cleanup_ax (struct CadetTunnelAxolotl *ax) | |||
1488 | * Computes the new chain keys, and root keys, etc, and also checks | 1488 | * Computes the new chain keys, and root keys, etc, and also checks |
1489 | * whether this is a replay of the current chain. | 1489 | * whether this is a replay of the current chain. |
1490 | * | 1490 | * |
1491 | * @param[in|out] axolotl chain key state to recompute | 1491 | * @param[in,out] ax chain key state to recompute |
1492 | * @param pid peer identity of the other peer | 1492 | * @param pid peer identity of the other peer |
1493 | * @param ephemeral_key ephemeral public key of the other peer | 1493 | * @param ephemeral_key ephemeral public key of the other peer |
1494 | * @param ratchet_key senders next ephemeral public key | 1494 | * @param ratchet_key senders next ephemeral public key |
@@ -3487,15 +3487,6 @@ GCT_send (struct CadetTunnel *t, | |||
3487 | } | 3487 | } |
3488 | 3488 | ||
3489 | 3489 | ||
3490 | /** | ||
3491 | * Cancel a previously sent message while it's in the queue. | ||
3492 | * | ||
3493 | * ONLY can be called before the continuation given to the send | ||
3494 | * function is called. Once the continuation is called, the message is | ||
3495 | * no longer in the queue! | ||
3496 | * | ||
3497 | * @param tq Handle to the queue entry to cancel. | ||
3498 | */ | ||
3499 | void | 3490 | void |
3500 | GCT_send_cancel (struct CadetTunnelQueueEntry *tq) | 3491 | GCT_send_cancel (struct CadetTunnelQueueEntry *tq) |
3501 | { | 3492 | { |
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); | |||
160 | * Consider using the path @a p for the tunnel @a t. | 160 | * Consider using the path @a p for the tunnel @a t. |
161 | * The tunnel destination is at offset @a off in path @a p. | 161 | * The tunnel destination is at offset @a off in path @a p. |
162 | * | 162 | * |
163 | * @param cls our tunnel | 163 | * @param t our tunnel |
164 | * @param path a path to our destination | 164 | * @param p a path to our destination |
165 | * @param off offset of the destination on path @a path | 165 | * @param off offset of the destination on path @a path |
166 | */ | 166 | */ |
167 | void | 167 | void |