aboutsummaryrefslogtreecommitdiff
path: root/src/messenger/gnunet-service-messenger_basement.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/messenger/gnunet-service-messenger_basement.h')
-rw-r--r--src/messenger/gnunet-service-messenger_basement.h24
1 files changed, 12 insertions, 12 deletions
diff --git a/src/messenger/gnunet-service-messenger_basement.h b/src/messenger/gnunet-service-messenger_basement.h
index 0a1a9b126..b19aec405 100644
--- a/src/messenger/gnunet-service-messenger_basement.h
+++ b/src/messenger/gnunet-service-messenger_basement.h
@@ -1,6 +1,6 @@
1/* 1/*
2 This file is part of GNUnet. 2 This file is part of GNUnet.
3 Copyright (C) 2020 GNUnet e.V. 3 Copyright (C) 2020--2021 GNUnet e.V.
4 4
5 GNUnet is free software: you can redistribute it and/or modify it 5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published 6 under the terms of the GNU Affero General Public License as published
@@ -31,34 +31,34 @@
31/** 31/**
32 * Returns the count of peers in a list (typically from the basement of a room). 32 * Returns the count of peers in a list (typically from the basement of a room).
33 * 33 *
34 * @param tunnels List of peer identities 34 * @param[in] tunnels List of peer identities
35 * @return Count of the entries in the list 35 * @return Count of the entries in the list
36 */ 36 */
37size_t 37size_t
38count_of_tunnels (const struct GNUNET_MESSENGER_ListTunnels *tunnels); 38count_of_tunnels (const struct GNUNET_MESSENGER_ListTunnels *tunnels);
39 39
40/** 40/**
41 * Returns GNUNET_YES or GNUNET_NO to determine if the peer at index <i>src</i> should 41 * Returns #GNUNET_YES or #GNUNET_NO to determine if the peer at index <i>src</i> should
42 * or should not connect outgoing to the peer at index <i>dst</i> to construct a complete 42 * or should not connect outgoing to the peer at index <i>dst</i> to construct a complete
43 * basement with a given <i>count</i> of peers. 43 * basement with a given <i>count</i> of peers.
44 * 44 *
45 * @param count Count of peers 45 * @param[in] count Count of peers
46 * @param src Source index 46 * @param[in] src Source index
47 * @param dst Destination index 47 * @param[in] dst Destination index
48 * @return GNUNET_YES or GNUNET_NO based on topologic requirement 48 * @return #GNUNET_YES or #GNUNET_NO based on topologic requirement
49 */ 49 */
50int 50int
51should_connect_tunnel_to (size_t count, size_t src, size_t dst); 51should_connect_tunnel_to (size_t count, size_t src, size_t dst);
52 52
53/** 53/**
54 * Returns GNUNET_YES or GNUNET_NO to determine if the peers of index <i>src</i> and 54 * Returns #GNUNET_YES or #GNUNET_NO to determine if the peers of index <i>src</i> and
55 * index <i>dst</i> should be connected in any direction to construct a complete 55 * index <i>dst</i> should be connected in any direction to construct a complete
56 * basement with a given <i>count</i> of peers. 56 * basement with a given <i>count</i> of peers.
57 * 57 *
58 * @param count Count of peers 58 * @param[in] count Count of peers
59 * @param src Source index 59 * @param[in] src Source index
60 * @param dst Destination index 60 * @param[in] dst Destination index
61 * @return GNUNET_YES or GNUNET_NO based on topologic requirement 61 * @return #GNUNET_YES or #GNUNET_NO based on topologic requirement
62 */ 62 */
63int 63int
64required_connection_between (size_t count, size_t src, size_t dst); 64required_connection_between (size_t count, size_t src, size_t dst);