diff options
author | Willow Liquorice <willow@howhill.com> | 2022-09-07 20:44:52 +0100 |
---|---|---|
committer | Willow Liquorice <willow@howhill.com> | 2022-10-03 00:44:34 +0100 |
commit | dd797c2c6c01520fa73b1fd335ccd42df86b1b4d (patch) | |
tree | 1f508fa523fa7c3400fbd4f95a344d7f44ce37c1 /src/messenger/messenger_api_list_tunnels.h | |
parent | 1d0bbddfefaefb6e3f5cd240e56462a6bef2fa09 (diff) | |
download | gnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.tar.gz gnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.zip |
-DOC: Documentation cleanup pass through MESSENGER subsystem
Diffstat (limited to 'src/messenger/messenger_api_list_tunnels.h')
-rw-r--r-- | src/messenger/messenger_api_list_tunnels.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/messenger/messenger_api_list_tunnels.h b/src/messenger/messenger_api_list_tunnels.h index 0e086ee5e..e28935c3e 100644 --- a/src/messenger/messenger_api_list_tunnels.h +++ b/src/messenger/messenger_api_list_tunnels.h | |||
@@ -55,7 +55,7 @@ init_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels); | |||
55 | /** | 55 | /** |
56 | * Clears the list of tunnels peer identities. | 56 | * Clears the list of tunnels peer identities. |
57 | * | 57 | * |
58 | * @param[in/out] tunnels List of peer identities | 58 | * @param[in,out] tunnels List of peer identities |
59 | */ | 59 | */ |
60 | void | 60 | void |
61 | clear_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels); | 61 | clear_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels); |
@@ -63,7 +63,7 @@ clear_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels); | |||
63 | /** | 63 | /** |
64 | * Adds a specific <i>peer</i> from a tunnel to the end of the list. | 64 | * Adds a specific <i>peer</i> from a tunnel to the end of the list. |
65 | * | 65 | * |
66 | * @param[in/out] tunnels List of peer identities | 66 | * @param[in,out] tunnels List of peer identities |
67 | * @param[in] peer Peer identity of tunnel | 67 | * @param[in] peer Peer identity of tunnel |
68 | */ | 68 | */ |
69 | void | 69 | void |
@@ -80,7 +80,7 @@ add_to_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, | |||
80 | * the found element in the list. If no matching element is found, <i>index</i> will | 80 | * the found element in the list. If no matching element is found, <i>index</i> will |
81 | * contain the total amount of elements in the list. | 81 | * contain the total amount of elements in the list. |
82 | * | 82 | * |
83 | * @param[in/out] tunnels List of peer identities | 83 | * @param[in,out] tunnels List of peer identities |
84 | * @param[in] peer Peer identity of tunnel | 84 | * @param[in] peer Peer identity of tunnel |
85 | * @param[out] index Index of found element (optional) | 85 | * @param[out] index Index of found element (optional) |
86 | * @return Element in the list with matching peer identity | 86 | * @return Element in the list with matching peer identity |
@@ -94,7 +94,7 @@ find_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, | |||
94 | * Tests linearly if the list of tunnels peer identities contains a specific | 94 | * Tests linearly if the list of tunnels peer identities contains a specific |
95 | * <i>peer</i> identity and returns #GNUNET_YES on success, otherwise #GNUNET_NO. | 95 | * <i>peer</i> identity and returns #GNUNET_YES on success, otherwise #GNUNET_NO. |
96 | * | 96 | * |
97 | * @param[in/out] tunnels List of peer identities | 97 | * @param[in,out] tunnels List of peer identities |
98 | * @param[in] peer Peer identity of tunnel | 98 | * @param[in] peer Peer identity of tunnel |
99 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO | 99 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO |
100 | */ | 100 | */ |
@@ -106,8 +106,8 @@ contains_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, | |||
106 | * Removes a specific <i>element</i> from the list of tunnels peer identities and returns | 106 | * Removes a specific <i>element</i> from the list of tunnels peer identities and returns |
107 | * the next element in the list. | 107 | * the next element in the list. |
108 | * | 108 | * |
109 | * @param[in/out] tunnels List of peer identities | 109 | * @param[in,out] tunnels List of peer identities |
110 | * @param[in/out] element Element of the list | 110 | * @param[in,out] element Element of the list |
111 | * @return Next element in the list | 111 | * @return Next element in the list |
112 | */ | 112 | */ |
113 | struct GNUNET_MESSENGER_ListTunnel* | 113 | struct GNUNET_MESSENGER_ListTunnel* |
@@ -117,7 +117,7 @@ remove_from_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, | |||
117 | /** | 117 | /** |
118 | * Loads the list of tunnels peer identities from a file under a given <i>path</i>. | 118 | * Loads the list of tunnels peer identities from a file under a given <i>path</i>. |
119 | * | 119 | * |
120 | * @param[out] messages List of hashes | 120 | * @param[out] tunnels List of hashes |
121 | * @param[in] path Path of file | 121 | * @param[in] path Path of file |
122 | */ | 122 | */ |
123 | void | 123 | void |
@@ -127,7 +127,7 @@ load_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, | |||
127 | /** | 127 | /** |
128 | * Saves the list of tunnels peer identities to a file under a given <i>path</i>. | 128 | * Saves the list of tunnels peer identities to a file under a given <i>path</i>. |
129 | * | 129 | * |
130 | * @param[in] messages List of hashes | 130 | * @param[in] tunnels List of hashes |
131 | * @param[in] path Path of file | 131 | * @param[in] path Path of file |
132 | */ | 132 | */ |
133 | void | 133 | void |