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/gnunet-service-messenger_service.h | |
parent | 1d0bbddfefaefb6e3f5cd240e56462a6bef2fa09 (diff) | |
download | gnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.tar.gz gnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.zip |
-DOC: Documentation cleanup pass through MESSENGER subsystem
Diffstat (limited to 'src/messenger/gnunet-service-messenger_service.h')
-rw-r--r-- | src/messenger/gnunet-service-messenger_service.h | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/src/messenger/gnunet-service-messenger_service.h b/src/messenger/gnunet-service-messenger_service.h index d364a93c0..55e8b6c50 100644 --- a/src/messenger/gnunet-service-messenger_service.h +++ b/src/messenger/gnunet-service-messenger_service.h | |||
@@ -64,7 +64,7 @@ struct GNUNET_MESSENGER_Service | |||
64 | * Creates and allocates a new service using a given <i>config</i> and a GNUnet service handle. | 64 | * Creates and allocates a new service using a given <i>config</i> and a GNUnet service handle. |
65 | * | 65 | * |
66 | * @param[in] config Configuration | 66 | * @param[in] config Configuration |
67 | * @param[in/out] service_handle GNUnet service handle | 67 | * @param[in,out] service_handle GNUnet service handle |
68 | * @return New service | 68 | * @return New service |
69 | */ | 69 | */ |
70 | struct GNUNET_MESSENGER_Service* | 70 | struct GNUNET_MESSENGER_Service* |
@@ -74,7 +74,7 @@ create_service (const struct GNUNET_CONFIGURATION_Handle *config, | |||
74 | /** | 74 | /** |
75 | * Destroys a <i>service</i> and frees its memory fully. | 75 | * Destroys a <i>service</i> and frees its memory fully. |
76 | * | 76 | * |
77 | * @param[in/out] service Service | 77 | * @param[in,out] service Service |
78 | */ | 78 | */ |
79 | void | 79 | void |
80 | destroy_service (struct GNUNET_MESSENGER_Service *service); | 80 | destroy_service (struct GNUNET_MESSENGER_Service *service); |
@@ -82,7 +82,7 @@ destroy_service (struct GNUNET_MESSENGER_Service *service); | |||
82 | /** | 82 | /** |
83 | * Returns the used EGO-store of a given <i>service</i>. | 83 | * Returns the used EGO-store of a given <i>service</i>. |
84 | * | 84 | * |
85 | * @param[in/out] service Service | 85 | * @param[in,out] service Service |
86 | * @return EGO-store | 86 | * @return EGO-store |
87 | */ | 87 | */ |
88 | struct GNUNET_MESSENGER_EgoStore* | 88 | struct GNUNET_MESSENGER_EgoStore* |
@@ -91,7 +91,7 @@ get_service_ego_store (struct GNUNET_MESSENGER_Service *service); | |||
91 | /** | 91 | /** |
92 | * Returns the used contact store of a given <i>service</i>. | 92 | * Returns the used contact store of a given <i>service</i>. |
93 | * | 93 | * |
94 | * @param[in/out] service Service | 94 | * @param[in,out] service Service |
95 | * @return Contact store | 95 | * @return Contact store |
96 | */ | 96 | */ |
97 | struct GNUNET_MESSENGER_ContactStore* | 97 | struct GNUNET_MESSENGER_ContactStore* |
@@ -100,8 +100,8 @@ get_service_contact_store (struct GNUNET_MESSENGER_Service *service); | |||
100 | /** | 100 | /** |
101 | * Creates and adds a new handle to a <i>service</i> using a given message queue. | 101 | * Creates and adds a new handle to a <i>service</i> using a given message queue. |
102 | * | 102 | * |
103 | * @param[in/out] service Service | 103 | * @param[in,out] service Service |
104 | * @param[in/out] mq Message queue | 104 | * @param[in,out] mq Message queue |
105 | * @return New handle | 105 | * @return New handle |
106 | */ | 106 | */ |
107 | struct GNUNET_MESSENGER_SrvHandle* | 107 | struct GNUNET_MESSENGER_SrvHandle* |
@@ -111,8 +111,8 @@ add_service_handle (struct GNUNET_MESSENGER_Service *service, | |||
111 | /** | 111 | /** |
112 | * Removes a <i>handle</i> from a <i>service</i> and destroys it. | 112 | * Removes a <i>handle</i> from a <i>service</i> and destroys it. |
113 | * | 113 | * |
114 | * @param[in/out] service Service | 114 | * @param[in,out] service Service |
115 | * @param[in/out] handle Handle | 115 | * @param[in,out] handle Handle |
116 | */ | 116 | */ |
117 | void | 117 | void |
118 | remove_service_handle (struct GNUNET_MESSENGER_Service *service, | 118 | remove_service_handle (struct GNUNET_MESSENGER_Service *service, |
@@ -146,8 +146,8 @@ get_service_room (const struct GNUNET_MESSENGER_Service *service, | |||
146 | * Tries to open a room using a given <i>key</i> for a <i>service</i> by a specific <i>handle</i>. The room will be | 146 | * Tries to open a room using a given <i>key</i> for a <i>service</i> by a specific <i>handle</i>. The room will be |
147 | * created if necessary. If the function is successful, it returns #GNUNET_YES, otherwise #GNUNET_NO. | 147 | * created if necessary. If the function is successful, it returns #GNUNET_YES, otherwise #GNUNET_NO. |
148 | * | 148 | * |
149 | * @param[in/out] service Service | 149 | * @param[in,out] service Service |
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 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO | 152 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO |
153 | */ | 153 | */ |
@@ -163,8 +163,8 @@ open_service_room (struct GNUNET_MESSENGER_Service *service, | |||
163 | * The room will be entered through the peer identitied by the peer identity provided as <i>door</i> parameter and | 163 | * The room will be entered through the peer identitied by the peer identity provided as <i>door</i> parameter and |
164 | * a new connection will be made. | 164 | * a new connection will be made. |
165 | * | 165 | * |
166 | * @param[in/out] service Service | 166 | * @param[in,out] service Service |
167 | * @param[in/out] handle Handle | 167 | * @param[in,out] handle Handle |
168 | * @param[in] door Peer identity | 168 | * @param[in] door Peer identity |
169 | * @param[in] key Key of room | 169 | * @param[in] key Key of room |
170 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO | 170 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO |
@@ -182,8 +182,8 @@ entry_service_room (struct GNUNET_MESSENGER_Service *service, | |||
182 | * If the specific handle is currently the host of the room for this service, a new handle which is a member will | 182 | * If the specific handle is currently the host of the room for this service, a new handle which is a member will |
183 | * take its place. Otherwise the room will be destroyed for this service. | 183 | * take its place. Otherwise the room will be destroyed for this service. |
184 | * | 184 | * |
185 | * @param[in/out] service Service | 185 | * @param[in,out] service Service |
186 | * @param[in/out] handle Handle | 186 | * @param[in,out] handle Handle |
187 | * @param[in] key Key of room | 187 | * @param[in] key Key of room |
188 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO | 188 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO |
189 | */ | 189 | */ |
@@ -196,8 +196,8 @@ close_service_room (struct GNUNET_MESSENGER_Service *service, | |||
196 | * Sends a received or sent <i>message</i> with a given <i>hash</i> to each handle of a <i>service</i> which | 196 | * Sends a received or sent <i>message</i> with a given <i>hash</i> to each handle of a <i>service</i> which |
197 | * is currently member of a specific <i>room</i> for handling it in the client API. | 197 | * is currently member of a specific <i>room</i> for handling it in the client API. |
198 | * | 198 | * |
199 | * @param[in/out] service Service | 199 | * @param[in,out] service Service |
200 | * @param[in/out] room Room | 200 | * @param[in,out] room Room |
201 | * @param[in] session Member session | 201 | * @param[in] session Member session |
202 | * @param[in] message Message | 202 | * @param[in] message Message |
203 | * @param[in] hash Hash of message | 203 | * @param[in] hash Hash of message |