summaryrefslogtreecommitdiff
path: root/src/lib/ecore_con/Ecore_Con_Eet.h
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-13 15:29:11 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-02-13 19:54:29 +0900
commit01931c4676ba3a55ca65cd2cd3c2b3e55804c1c8 (patch)
tree024a8a9a725a97dfbd12279455dd8fa22e21458f /src/lib/ecore_con/Ecore_Con_Eet.h
parente4b37d7cb41e005accf2703ec34a9002f14dc4bb (diff)
doxygen: Fix typos & invalid statements in ecore
This covers ecore audio, avahi, buffer and con. Summary: There are some typos and cacologigue statements in doxygen of ecore_audio, ecore_avahi, ecore_buffer, and ecore_con. Test Plan: API Doxygen Revision Reviewers: stefan, cedric, raster, Jaehyun_Cho Subscribers: jpeg, conr2d Differential Revision: https://phab.enlightenment.org/D4652
Diffstat (limited to '')
-rw-r--r--src/lib/ecore_con/Ecore_Con_Eet.h46
1 files changed, 23 insertions, 23 deletions
diff --git a/src/lib/ecore_con/Ecore_Con_Eet.h b/src/lib/ecore_con/Ecore_Con_Eet.h
index d1bc80a583..abbdb10906 100644
--- a/src/lib/ecore_con/Ecore_Con_Eet.h
+++ b/src/lib/ecore_con/Ecore_Con_Eet.h
@@ -35,7 +35,7 @@
35 * @defgroup Ecore_Con_Eet_Group Eet connection functions 35 * @defgroup Ecore_Con_Eet_Group Eet connection functions
36 * @ingroup Ecore_Con_Group 36 * @ingroup Ecore_Con_Group
37 * 37 *
38 * The Ecore Connection Eet library ( @c Ecore_Con_Eet) adds @c Eet data 38 * The Ecore Connection Eet library (@c Ecore_Con_Eet) adds @c Eet data
39 * serialization features to Ecore Connection objects. Its main aim is to 39 * serialization features to Ecore Connection objects. Its main aim is to
40 * provide a way to send @c Eet data streams to another program through sockets 40 * provide a way to send @c Eet data streams to another program through sockets
41 * using @c Ecore_Con objects. 41 * using @c Ecore_Con objects.
@@ -89,7 +89,7 @@ typedef Eina_Bool (*Ecore_Con_Eet_Server_Cb)(void *data, Ecore_Con_Reply *reply,
89#endif 89#endif
90 90
91/** 91/**
92 * Create a Ecore_Con_Eet server. 92 * @brief Creates an Ecore_Con_Eet server.
93 * 93 *
94 * @param server An existing Ecore_Con_Server that have been previously 94 * @param server An existing Ecore_Con_Server that have been previously
95 * created by the server program with @ref 95 * created by the server program with @ref
@@ -103,7 +103,7 @@ typedef Eina_Bool (*Ecore_Con_Eet_Server_Cb)(void *data, Ecore_Con_Reply *reply,
103EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server); 103EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server);
104 104
105/** 105/**
106 * Create a Ecore_Con_Eet client. 106 * @brief Creates an Ecore_Con_Eet client.
107 * 107 *
108 * @param server An existing Ecore_Con_Server that have been previously 108 * @param server An existing Ecore_Con_Server that have been previously
109 * returned by a call to @ref ecore_con_server_connect in the 109 * returned by a call to @ref ecore_con_server_connect in the
@@ -117,7 +117,7 @@ EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server);
117EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server); 117EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server);
118 118
119/** 119/**
120 * Free an existing Ecore_Con_Eet object. 120 * @brief Frees an existing Ecore_Con_Eet object.
121 * 121 *
122 * @param server An existing Ecore_Con_Eet object that have been previously 122 * @param server An existing Ecore_Con_Eet object that have been previously
123 * allocated by a @ref ecore_con_eet_server_new or @ref 123 * allocated by a @ref ecore_con_eet_server_new or @ref
@@ -127,7 +127,7 @@ EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server);
127EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece); 127EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece);
128 128
129/** 129/**
130 * Register an @c Eet data descriptor on a Ecore_Con_Eet object. 130 * @brief Registers an @c Eet data descriptor on a Ecore_Con_Eet object.
131 * 131 *
132 * @param ece An Ecore_Con_Eet object. 132 * @param ece An Ecore_Con_Eet object.
133 * @param name The name of the Eet stream to connect. 133 * @param name The name of the Eet stream to connect.
@@ -138,7 +138,7 @@ EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece);
138EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_Descriptor *edd); 138EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_Descriptor *edd);
139 139
140/** 140/**
141 * Register a data callback on a Ecore_Con_Eet object. 141 * @brief Registers a data callback on a Ecore_Con_Eet object.
142 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 142 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
143 * 143 *
144 * @param ece An Ecore_Con_Eet object. 144 * @param ece An Ecore_Con_Eet object.
@@ -150,7 +150,7 @@ EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_
150EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Data_Cb func, const void *data); 150EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Data_Cb func, const void *data);
151 151
152/** 152/**
153 * Remove a data callback on a Ecore_Con_Eet object. 153 * @brief Removes a data callback on a Ecore_Con_Eet object.
154 * 154 *
155 * @param ece An Ecore_Con_Eet object. 155 * @param ece An Ecore_Con_Eet object.
156 * @param name The name of the Eet stream to remove callback on. 156 * @param name The name of the Eet stream to remove callback on.
@@ -159,7 +159,7 @@ EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name,
159EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name); 159EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name);
160 160
161/** 161/**
162 * Register a raw data callback on a Ecore_Con_Eet object. 162 * @brief Registers a raw data callback on a Ecore_Con_Eet object.
163 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 163 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
164 * 164 *
165 * @param ece An Ecore_Con_Eet object. 165 * @param ece An Ecore_Con_Eet object.
@@ -171,7 +171,7 @@ EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name);
171EAPI void ecore_con_eet_raw_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Raw_Data_Cb func, const void *data); 171EAPI void ecore_con_eet_raw_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Raw_Data_Cb func, const void *data);
172 172
173/** 173/**
174 * Remove a raw data callback on a Ecore_Con_Eet object. 174 * @brief Removes a raw data callback on a Ecore_Con_Eet object.
175 * 175 *
176 * @param ece An Ecore_Con_Eet object. 176 * @param ece An Ecore_Con_Eet object.
177 * @param name The name of the raw Eet stream to remove callback on. 177 * @param name The name of the raw Eet stream to remove callback on.
@@ -180,7 +180,7 @@ EAPI void ecore_con_eet_raw_data_callback_add(Ecore_Con_Eet *ece, const char *na
180EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *name); 180EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *name);
181 181
182/** 182/**
183 * Register a client connect callback on a Ecore_Con_Eet object. 183 * @brief Registers a client connect callback on a Ecore_Con_Eet object.
184 * @brief This callback can be registered on the server program to know when a 184 * @brief This callback can be registered on the server program to know when a
185 * client connects. 185 * client connects.
186 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 186 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
@@ -192,7 +192,7 @@ EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *na
192EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); 192EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
193 193
194/** 194/**
195 * Remove a client connect callback on a Ecore_Con_Eet object. 195 * @brief Removes a client connect callback on a Ecore_Con_Eet object.
196 * 196 *
197 * @param ece An Ecore_Con_Eet object. 197 * @param ece An Ecore_Con_Eet object.
198 * @param func The callback to remove. 198 * @param func The callback to remove.
@@ -201,7 +201,7 @@ EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Co
201EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); 201EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
202 202
203/** 203/**
204 * Register a client disconnect callback on a Ecore_Con_Eet object. 204 * @brief Registers a client disconnect callback on a Ecore_Con_Eet object.
205 * @brief This callback can be registered on the server program to know when a 205 * @brief This callback can be registered on the server program to know when a
206 * client disconnects. 206 * client disconnects.
207 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 207 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
@@ -213,7 +213,7 @@ EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Co
213EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); 213EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
214 214
215/** 215/**
216 * Remove a client disconnect callback on a Ecore_Con_Eet object. 216 * @brief Removes a client disconnect callback on a Ecore_Con_Eet object.
217 * 217 *
218 * @param ece An Ecore_Con_Eet object. 218 * @param ece An Ecore_Con_Eet object.
219 * @param func The callback to remove. 219 * @param func The callback to remove.
@@ -222,8 +222,8 @@ EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore
222EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); 222EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
223 223
224/** 224/**
225 * Register a server connect callback on a Ecore_Con_Eet object. 225 * @brief Registers a server connect callback on a Ecore_Con_Eet object.
226 * @brief This callback can be registered on the client program to be called 226 * @brief This callback can be registered on the client program to be called.
227 * when it has been connected to the server. 227 * when it has been connected to the server.
228 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 228 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
229 * 229 *
@@ -234,7 +234,7 @@ EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore
234EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); 234EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
235 235
236/** 236/**
237 * Remove a server connect callback on a Ecore_Con_Eet object. 237 * @brief Removes a server connect callback on a Ecore_Con_Eet object.
238 * 238 *
239 * @param ece An Ecore_Con_Eet object. 239 * @param ece An Ecore_Con_Eet object.
240 * @param func The callback to remove. 240 * @param func The callback to remove.
@@ -243,7 +243,7 @@ EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Co
243EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); 243EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
244 244
245/** 245/**
246 * Register a server disconnect callback on a Ecore_Con_Eet object. 246 * @brief Registers a server disconnect callback on a Ecore_Con_Eet object.
247 * @brief This callback can be registered on the client program to be called 247 * @brief This callback can be registered on the client program to be called
248 * when it has been disconnected from the server. 248 * when it has been disconnected from the server.
249 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 249 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
@@ -255,7 +255,7 @@ EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Co
255EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); 255EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
256 256
257/** 257/**
258 * Remove a server disconnect callback on a Ecore_Con_Eet object. 258 * @brief Removes a server disconnect callback on a Ecore_Con_Eet object.
259 * 259 *
260 * @param ece An Ecore_Con_Eet object. 260 * @param ece An Ecore_Con_Eet object.
261 * @param func The callback to remove. 261 * @param func The callback to remove.
@@ -264,7 +264,7 @@ EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore
264EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); 264EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
265 265
266/** 266/**
267 * Attach data to an Ecore_Con_Eet object. 267 * @brief Attaches data to an Ecore_Con_Eet object.
268 * 268 *
269 * @param ece An Ecore_Con_Eet object. 269 * @param ece An Ecore_Con_Eet object.
270 * @param data The data to attach to the Ecore_Con_Eet object. 270 * @param data The data to attach to the Ecore_Con_Eet object.
@@ -272,7 +272,7 @@ EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore
272EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data); 272EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data);
273 273
274/** 274/**
275 * Get the data attached to an Ecore_Con_Eet object. 275 * @brief Gets the data attached to an Ecore_Con_Eet object.
276 * 276 *
277 * @param ece An Ecore_Con_Eet object. 277 * @param ece An Ecore_Con_Eet object.
278 * @return The data attached to the Ecore_Con_Eet object. 278 * @return The data attached to the Ecore_Con_Eet object.
@@ -280,7 +280,7 @@ EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data);
280EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece); 280EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece);
281 281
282/** 282/**
283 * Get the Ecore_Con_Eet object corresponding to the Ecore_Con_Reply object. 283 * @brief Gets the Ecore_Con_Eet object corresponding to the Ecore_Con_Reply object.
284 * 284 *
285 * @param reply An Ecore_Con_Reply object. 285 * @param reply An Ecore_Con_Reply object.
286 * @return The corresponding Ecore_Con_Eet object. 286 * @return The corresponding Ecore_Con_Eet object.
@@ -288,7 +288,7 @@ EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece);
288EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply); 288EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply);
289 289
290/** 290/**
291 * Send some data using a protocol type. 291 * @brief Sends some data using a protocol type.
292 * 292 *
293 * @param reply An Ecore_Con_Reply object. 293 * @param reply An Ecore_Con_Reply object.
294 * @param protocol_name The protocol type to use. 294 * @param protocol_name The protocol type to use.
@@ -297,7 +297,7 @@ EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply);
297EAPI void ecore_con_eet_send(Ecore_Con_Reply *reply, const char *protocol_name, void *value); 297EAPI void ecore_con_eet_send(Ecore_Con_Reply *reply, const char *protocol_name, void *value);
298 298
299/** 299/**
300 * Send some raw data using a protocol type. 300 * @brief Sends some raw data using a protocol type.
301 * 301 *
302 * @param reply An Ecore_Con_Reply object. 302 * @param reply An Ecore_Con_Reply object.
303 * @param protocol_name The protocol type to use. 303 * @param protocol_name The protocol type to use.