aboutsummaryrefslogtreecommitdiff
path: root/src/messenger/messenger_api_handle.h
diff options
context:
space:
mode:
authorWillow Liquorice <willow@howhill.com>2022-09-07 20:44:52 +0100
committerWillow Liquorice <willow@howhill.com>2022-10-03 00:44:34 +0100
commitdd797c2c6c01520fa73b1fd335ccd42df86b1b4d (patch)
tree1f508fa523fa7c3400fbd4f95a344d7f44ce37c1 /src/messenger/messenger_api_handle.h
parent1d0bbddfefaefb6e3f5cd240e56462a6bef2fa09 (diff)
downloadgnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.tar.gz
gnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.zip
-DOC: Documentation cleanup pass through MESSENGER subsystem
Diffstat (limited to 'src/messenger/messenger_api_handle.h')
-rw-r--r--src/messenger/messenger_api_handle.h18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/messenger/messenger_api_handle.h b/src/messenger/messenger_api_handle.h
index 6a43f13a6..8430f40d5 100644
--- a/src/messenger/messenger_api_handle.h
+++ b/src/messenger/messenger_api_handle.h
@@ -67,7 +67,7 @@ struct GNUNET_MESSENGER_Handle
67 * 67 *
68 * @param[in] cfg Configuration 68 * @param[in] cfg Configuration
69 * @param[in] msg_callback Message callback 69 * @param[in] msg_callback Message callback
70 * @param[in/out] msg_cls Closure 70 * @param[in,out] msg_cls Closure
71 * @return New handle 71 * @return New handle
72 */ 72 */
73struct GNUNET_MESSENGER_Handle* 73struct GNUNET_MESSENGER_Handle*
@@ -80,7 +80,7 @@ create_handle (const struct GNUNET_CONFIGURATION_Handle *cfg,
80/** 80/**
81 * Destroys a <i>handle</i> and frees its memory fully from the client API. 81 * Destroys a <i>handle</i> and frees its memory fully from the client API.
82 * 82 *
83 * @param[in/out] handle Handle 83 * @param[in,out] handle Handle
84 */ 84 */
85void 85void
86destroy_handle (struct GNUNET_MESSENGER_Handle *handle); 86destroy_handle (struct GNUNET_MESSENGER_Handle *handle);
@@ -88,7 +88,7 @@ destroy_handle (struct GNUNET_MESSENGER_Handle *handle);
88/** 88/**
89 * Sets the name of a <i>handle</i> to a specific <i>name</i>. 89 * Sets the name of a <i>handle</i> to a specific <i>name</i>.
90 * 90 *
91 * @param[in/out] handle Handle 91 * @param[in,out] handle Handle
92 * @param[in] name New name 92 * @param[in] name New name
93 */ 93 */
94void 94void
@@ -107,7 +107,7 @@ get_handle_name (const struct GNUNET_MESSENGER_Handle *handle);
107/** 107/**
108 * Sets the public key of a given <i>handle</i> to a specific public key. 108 * Sets the public key of a given <i>handle</i> to a specific public key.
109 * 109 *
110 * @param[in/out] handle Handle 110 * @param[in,out] handle Handle
111 * @param[in] pubkey Public key 111 * @param[in] pubkey Public key
112 */ 112 */
113void 113void
@@ -126,7 +126,7 @@ get_handle_key (const struct GNUNET_MESSENGER_Handle *handle);
126/** 126/**
127 * Returns the used contact store of a given <i>handle</i>. 127 * Returns the used contact store of a given <i>handle</i>.
128 * 128 *
129 * @param[in/out] handle Handle 129 * @param[in,out] handle Handle
130 * @return Contact store 130 * @return Contact store
131 */ 131 */
132struct GNUNET_MESSENGER_ContactStore* 132struct GNUNET_MESSENGER_ContactStore*
@@ -136,7 +136,7 @@ get_handle_contact_store (struct GNUNET_MESSENGER_Handle *handle);
136 * Returns the contact of a given <i>handle</i> in a room identified by a 136 * Returns the contact of a given <i>handle</i> in a room identified by a
137 * given <i>key</i>. 137 * given <i>key</i>.
138 * 138 *
139 * @param[in/out] handle Handle 139 * @param[in,out] handle Handle
140 * @param[in] key Key of room 140 * @param[in] key Key of room
141 * @return Contact 141 * @return Contact
142 */ 142 */
@@ -147,7 +147,7 @@ get_handle_contact (struct GNUNET_MESSENGER_Handle *handle,
147/** 147/**
148 * Marks a room known to a <i>handle</i> identified by a given <i>key</i> as open. 148 * Marks a room known to a <i>handle</i> identified by a given <i>key</i> as open.
149 * 149 *
150 * @param[in/out] handle Handle 150 * @param[in,out] handle Handle
151 * @param[in] key Key of room 151 * @param[in] key Key of room
152 */ 152 */
153void 153void
@@ -158,7 +158,7 @@ open_handle_room (struct GNUNET_MESSENGER_Handle *handle,
158 * Adds a tunnel for a room known to a <i>handle</i> identified by a given <i>key</i> to a 158 * Adds a tunnel for a room known to a <i>handle</i> identified by a given <i>key</i> to a
159 * list of opened connections. 159 * list of opened connections.
160 * 160 *
161 * @param[in/out] handle Handle 161 * @param[in,out] handle Handle
162 * @param[in] door Peer identity 162 * @param[in] door Peer identity
163 * @param[in] key Key of room 163 * @param[in] key Key of room
164 */ 164 */
@@ -170,7 +170,7 @@ entry_handle_room_at (struct GNUNET_MESSENGER_Handle *handle,
170/** 170/**
171 * Destroys and so implicitly closes a room known to a <i>handle</i> identified by a given <i>key</i>. 171 * Destroys and so implicitly closes a room known to a <i>handle</i> identified by a given <i>key</i>.
172 * 172 *
173 * @param[in/out] handle Handle 173 * @param[in,out] handle Handle
174 * @param[in] key Key of room 174 * @param[in] key Key of room
175 */ 175 */
176void 176void