kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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
This commit is contained in:
Myoungwoon Roy, Kim 2017-02-13 15:29:11 +09:00 committed by Jean-Philippe Andre
parent e4b37d7cb4
commit 01931c4676
13 changed files with 317 additions and 317 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/lib/ecore_audio/Ecore_Audio.h
View File

@ -20,7 +20,7 @@
/**
* @file Ecore_Audio.h
* @brief Audio utility functions
* @brief Audio utility functions.
*/
#ifdef __cplusplus
@ -69,7 +69,7 @@ typedef struct _Ecore_Audio_Object Ecore_Audio_Object; /**< The audio object */
*/
struct _Ecore_Audio_Vio {
/**
* @brief Get the length of the file
* @brief Gets the length of the file.
*
* @param data User data from the ecore_audio_obj_set_vio call
* @param eo_obj The Ecore_Audio object this operates on
@ -81,7 +81,7 @@ struct _Ecore_Audio_Vio {
int (*get_length)(void *data, Eo *eo_obj);
/**
* @brief Seek to a position within the file
* @brief Seeks to a position within the file.
*
* @param data User data from the ecore_audio_obj_set_vio call
* @param eo_obj The Ecore_Audio object this operates on
@ -99,7 +99,7 @@ struct _Ecore_Audio_Vio {
int (*seek)(void *data, Eo *eo_obj, int offset, int whence);
/**
* @brief Get the current position within the file
* @brief Gets the current position within the file.
*
* @param data User data from the ecore_audio_obj_set_vio call
* @param eo_obj The Ecore_Audio object this operates on
@ -113,7 +113,7 @@ struct _Ecore_Audio_Vio {
int (*tell)(void *data, Eo *eo_obj);
/**
* @brief Read some data from the file
* @brief Reads some data from the file.
*
* @param data User data from the ecore_audio_obj_set_vio call
* @param eo_obj The Ecore_Audio object this operates on
@ -127,7 +127,7 @@ struct _Ecore_Audio_Vio {
int (*read)(void *data, Eo *eo_obj, void *buffer, int length);
/**
* @brief Write some data to the file
* @brief Writes some data to the file.
*
* @param data User data from the ecore_audio_obj_set_vio call
* @param eo_obj The Ecore_Audio object this operates on
@ -142,7 +142,7 @@ struct _Ecore_Audio_Vio {
};
/**
* @brief Holds the callback functions to implement virtual file IO
* @brief Holds the callback functions to implement virtual file IO.
* @since 1.8
*/
typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio;
@ -150,9 +150,9 @@ typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio;
/* Audio operations */
/**
* @brief Initialize the Ecore_Audio library.
* @brief Initializes the Ecore_Audio library.
*
* @return 1 or greater on success, 0 on error.
* @return @c 1 or greater on success, @c 0 on error.
*
* @since 1.8
*
@ -166,9 +166,9 @@ typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio;
EAPI int ecore_audio_init(void);
/**
* @brief Shut down the Ecore_Audio library.
* @brief Shuts down the Ecore_Audio library.
*
* @return 0 when the library is completely shut down, 1 or
* @return @c 0 when the library is completely shut down, @c 1 or
* greater otherwise.
*
* @since 1.8

2
src/lib/ecore_audio/ecore_audio_obj.h
View File

@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj.h
* @brief Base Ecore_Audio object
* @brief Base Ecore_Audio object.
*/
#ifdef __cplusplus

2
src/lib/ecore_audio/ecore_audio_obj_in.h
View File

@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_in.h
* @brief Ecore_Audio Input Object
* @brief Ecore_Audio Input Object.
*/
#ifdef __cplusplus

2
src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h
View File

@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_in_sndfile.h
* @brief Ecore_Audio sndfile input
* @brief Ecore_Audio sndfile input.
*/
#ifdef __cplusplus

4
src/lib/ecore_audio/ecore_audio_obj_in_tone.h
View File

@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_in_tone.h
* @brief Ecore_Audio tone input
* @brief Ecore_Audio tone input.
*/
#ifdef __cplusplus
@ -35,7 +35,7 @@ extern "C"
*/
/**
* @brief The frequency of the tone in Hz
* @brief The frequency of the tone in Hz.
*
* Set with @ref efl_key_data_set()
*/

2
src/lib/ecore_audio/ecore_audio_obj_out.h
View File

@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_out.h
* @brief Ecore_Audio output object
* @brief Ecore_Audio output object.
*/
#ifdef __cplusplus

2
src/lib/ecore_audio/ecore_audio_obj_out_pulse.h
View File

@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_out_pulse.h
* @brief Ecore_Audio pulseaudio output
* @brief Ecore_Audio pulseaudio output.
*/
#ifdef __cplusplus

2
src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h
View File

@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_out_sndfile.h
* @brief Ecore_Audio sndfile output
* @brief Ecore_Audio sndfile output.
*/
#ifdef __cplusplus

10
src/lib/ecore_avahi/Ecore_Avahi.h
View File

@ -1,7 +1,7 @@
/**
@brief Ecore Avahi integration Library Public API Calls
@brief Ecore Avahi integration Library Public API Calls.
These routines are used for integrating Avahi with Ecore main loop
These routines are used for integrating Avahi with Ecore main loop.
*/
#ifndef _ECORE_AVAHI_H
@ -50,7 +50,7 @@ extern "C" {
typedef struct _Ecore_Avahi Ecore_Avahi; /**< A handle for an Avahi instance. */
/**
* @brief Create an AvahiPoll context and integrate it within Ecore main loop.
* @brief Creates an AvahiPoll context and integrate it within Ecore main loop.
*
* @return A handler that reference the AvahiPoll context
* @since 1.9
@ -58,7 +58,7 @@ typedef struct _Ecore_Avahi Ecore_Avahi; /**< A handle for an Avahi instance. */
EAPI Ecore_Avahi *ecore_avahi_add(void);
/**
* @brief Delete the specified handler of an AvahiPoll.
* @brief Deletes the specified handler of an AvahiPoll.
*
* @param handler The actual handler to destroy.
* @since 1.9
@ -69,7 +69,7 @@ EAPI Ecore_Avahi *ecore_avahi_add(void);
EAPI void ecore_avahi_del(Ecore_Avahi *handler);
/**
* @brief Get the AvahiPoll structure to integrate with Ecore main loop.
* @brief Gets the AvahiPoll structure to integrate with Ecore main loop.
*
* @param handler The handler to get the AvahiPoll structure from.
* @return return the actual AvahiPoll structure to use with Avahi.

40
src/lib/ecore_buffer/Ecore_Buffer.h
View File

@ -464,7 +464,7 @@ struct _Ecore_Buffer_Backend
};
/**
* @brief Initialize the Ecore_Buffer system.
* @brief Initializes the Ecore_Buffer system.
*
* @since 1.15
*
@ -474,7 +474,7 @@ struct _Ecore_Buffer_Backend
*/
EAPI Eina_Bool ecore_buffer_init(void);
/**
* @brief Shut down the Ecore_Buffer system.
* @brief Shuts down the Ecore_Buffer system.
*
* @since 1.15
*
@ -502,21 +502,21 @@ EAPI Eina_Bool ecore_buffer_register(Ecore_Buffer_Backend *be);
*/
EAPI void ecore_buffer_unregister(Ecore_Buffer_Backend *be);
/**
* @brief Creates a new Ecore_Buffer given type
* @brief Creates a new Ecore_Buffer given type.
*
* @since 1.15
*
* @param[in] engine the name of backend
* @param[in] width width for Ecore_Buffer
* @param[in] height height for Ecore_Buffer
* @param[in] format format for Ecore_Buffer
* @param[in] flags flags for Ecore_Buffer
* @param[in] engine The name of backend
* @param[in] width Width for Ecore_Buffer
* @param[in] height Height for Ecore_Buffer
* @param[in] format Format for Ecore_Buffer
* @param[in] flags Flags for Ecore_Buffer
*
* @return Newly allocated Ecore_Buffer instance, NULL otherwise.
*/
EAPI Ecore_Buffer *ecore_buffer_new(const char *engine, unsigned int width, unsigned int height, Ecore_Buffer_Format format, unsigned int flags);
/**
* @brief Free the given Ecore_Buffer.
* @brief Frees the given Ecore_Buffer.
*
* @since 1.15
*
@ -524,7 +524,7 @@ EAPI Ecore_Buffer *ecore_buffer_new(const char *engine, unsigned int width, unsi
*/
EAPI void ecore_buffer_free(Ecore_Buffer *buf);
/**
* @brief Set a callback for Ecore_Buffer free events.
* @brief Sets a callback for Ecore_Buffer free events.
*
* @since 1.15
*
@ -539,7 +539,7 @@ EAPI void ecore_buffer_free(Ecore_Buffer *buf);
*/
EAPI void ecore_buffer_free_callback_add(Ecore_Buffer *buf, Ecore_Buffer_Cb func, void *data);
/**
* @brief Remove a callback for Ecore_Buffer free events.
* @brief Removes a callback for Ecore_Buffer free events.
*
* @since 1.15
*
@ -559,17 +559,17 @@ EAPI void ecore_buffer_free_callback_remove(Ecore_Buffer *buf, Ecore_Bu
*/
EAPI void *ecore_buffer_data_get(Ecore_Buffer *buf);
/**
* @brief Return the Pixmap of given Ecore_Buffer.
* @brief Returns the Pixmap of given Ecore_Buffer.
*
* @since 1.15
*
* @param[in] buf The Ecore_Buffer
*
* @return The Pixmap instance, 0 otherwise.
* @return The Pixmap instance, @c 0 otherwise.
*/
EAPI Ecore_Pixmap ecore_buffer_pixmap_get(Ecore_Buffer *buf);
/**
* @brief Return the tbm surface handle of given Ecore_Buffer.
* @brief Returns the tbm surface handle of given Ecore_Buffer.
*
* @since 1.15
*
@ -582,19 +582,19 @@ EAPI Ecore_Pixmap ecore_buffer_pixmap_get(Ecore_Buffer *buf);
*/
EAPI void *ecore_buffer_tbm_surface_get(Ecore_Buffer *buf);
/**
* @brief Return size of given Ecore_Buffer.
* @brief Returns size of given Ecore_Buffer.
*
* @since 1.15
*
* @param[in] buf The Ecore_Buffer
* @param[out] width where to return the width value. May be @c NULL.
* @param[out] height where to return the height value. May be @c NULL.
* @param[out] width Where to return the width value. May be @c NULL.
* @param[out] height Where to return the height value. May be @c NULL.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ecore_buffer_size_get(Ecore_Buffer *buf, unsigned int *width, unsigned int *height);
/**
* @brief Return format of given Ecore_Buffer.
* @brief Returns format of given Ecore_Buffer.
*
* @since 1.15
*
@ -602,11 +602,11 @@ EAPI Eina_Bool ecore_buffer_size_get(Ecore_Buffer *buf, unsigned int *width,
*
* @return The format of given Ecore_Buffer.
*
* return value can be one of those pre-defined value such as ECORE_BUFFER_FORMAT_XRGB8888.
* Return value can be one of those pre-defined value such as ECORE_BUFFER_FORMAT_XRGB8888.
*/
EAPI Ecore_Buffer_Format ecore_buffer_format_get(Ecore_Buffer *buf);
/**
* @brief Return flags of given Ecore_Buffer.
* @brief Returns the flags of given Ecore_Buffer.
*
* @since 1.15
*

60
src/lib/ecore_buffer/Ecore_Buffer_Queue.h
View File

@ -38,9 +38,9 @@ extern "C" {
* @defgroup Ecore_Buffer_Queue_Group Ecore Buffer Queue functions
* @ingroup Ecore_Buffer_Group
*
* Ecore Buffer Queue is a queue which conntects processes for sharing
* Ecore Buffer Queue is a queue which connects processes for sharing
* Ecore_Buffer.
* one process (related object is Ecore_Buffer_Provider) has rear terminal
* One process (related object is Ecore_Buffer_Provider) has rear terminal
* position of Ecore_Buffer Queue which can enqueue the Ecore_Buffer,
* and the other process (related object is Ecore_Buffer_Consumer) has front
* terminal position of Ecore_Buffer_Queue which can dequeue the Ecore_Buffer.
@ -69,7 +69,7 @@ extern "C" {
/**
* @typedef Ecore_Buffer_Return
* @enum _Ecore_Buffer_Return
* types for an buffer queue state on provider side.
* Types for an buffer queue state on provider side.
* @ingroup Ecore_Buffer_Provider_Group
* @see ecore_buffer_provider_buffer_acquire()
* @see ecore_buffer_provider_buffer_acquirable_check()
@ -173,23 +173,23 @@ typedef void (*Ecore_Buffer_Provider_Enqueue_Cb) (Ecore_Buffer_Provider *provide
*/
/**
* @brief Init the Ecore_Buffer_Queue system.
* @brief Inits the Ecore_Buffer_Queue system.
*
* @since 1.15
*
* @return How many times the lib has been initialized, 0 indicates failure.
* @return How many times the lib has been initialized, @c 0 indicates failure.
*
* Set up the connection of Buffer Queue deamon, and Init Ecore_Buffer_Queue libraries.
* Set up the connection of Buffer Queue daemon, and Init Ecore_Buffer_Queue libraries.
*
* @see ecore_buffer_queue_shutdown()
*/
EAPI int ecore_buffer_queue_init(void);
/**
* @brief Shut down the Ecore_Buffer_Queue system.
* @brief Shuts down the Ecore_Buffer_Queue system.
*
* @since 1.15
*
* this closes the connection of Buffer Queue deamon, and Shut down Ecore_Buffer_Queue libraries.
* This closes the connection of Buffer Queue daemon, and Shut down Ecore_Buffer_Queue libraries.
*
* @see ecore_buffer_queue_init()
*/
@ -209,16 +209,16 @@ EAPI int ecore_buffer_queue_shutdown(void);
*
* @since 1.15
*
* @param[in] name the name of Buffer_Queue, this is needed by Consumer and Provider to connect each other.
* @param[in] queue_size size of Queue (If you pass this 0, then default size two(2) is appied)
* @param[in] w width of buffer recommeneded to provider.
* @param[in] h height of buffer recommended to provider.
* @param[in] name The name of Buffer_Queue, this is needed by Consumer and Provider to connect each other.
* @param[in] queue_size Size of Queue (If you pass this 0, then default size two(2) is appied)
* @param[in] w Width of buffer recommended to provider.
* @param[in] h Height of buffer recommended to provider.
*
* @return Ecore_Buffer_Consumer instance or @c NULL if creation failed.
*/
EAPI Ecore_Buffer_Consumer *ecore_buffer_consumer_new(const char *name, int32_t queue_size, int32_t w, int32_t h);
/**
* @brief Free an Ecore_Buffer_Consumer
* @brief Frees an Ecore_Buffer_Consumer.
*
* @since 1.15
*
@ -228,13 +228,13 @@ EAPI Ecore_Buffer_Consumer *ecore_buffer_consumer_new(const char *name, int32
*/
EAPI void ecore_buffer_consumer_free(Ecore_Buffer_Consumer *consumer);
/**
* @brief Return the latest Ecore_Buffer submitted by provider.
* @brief Returns the latest Ecore_Buffer submitted by provider.
*
* @since 1.15
*
* @param[in] consumer The Ecore_Buffer_Consumer to request for buffer
*
* @return Ecore_Buffer handle or NULL if acquirement failed.
* @return Ecore_Buffer handle or @c NULL if acquirement failed.
*
* @see ecore_buffer_consumer_buffer_release()
*
@ -243,7 +243,7 @@ EAPI void ecore_buffer_consumer_free(Ecore_Buffer_Consumer
*/
EAPI Ecore_Buffer *ecore_buffer_consumer_buffer_dequeue(Ecore_Buffer_Consumer *consumer);
/**
* @brief Release the acquired Ecore_Buffer.
* @brief Releases the acquired Ecore_Buffer.
*
* @since 1.15
*
@ -261,7 +261,7 @@ EAPI Ecore_Buffer *ecore_buffer_consumer_buffer_dequeue(Ecore_Buffer
*/
EAPI Eina_Bool ecore_buffer_consumer_buffer_release(Ecore_Buffer_Consumer *consumer, Ecore_Buffer *buffer);
/**
* @brief Check if Queue of Ecore_Buffer is empty.
* @brief Checks if Queue of Ecore_Buffer is empty.
*
* @since 1.15
*
@ -271,7 +271,7 @@ EAPI Eina_Bool ecore_buffer_consumer_buffer_release(Ecore_Buffer
*/
EAPI Eina_Bool ecore_buffer_consumer_queue_is_empty(Ecore_Buffer_Consumer *consumer);
/**
* @brief Set a callback for provider connection events.
* @brief Sets a callback for provider connection events.
*
* @since 1.15
*
@ -284,7 +284,7 @@ EAPI Eina_Bool ecore_buffer_consumer_queue_is_empty(Ecore_Buffer
*/
EAPI void ecore_buffer_consumer_provider_add_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Provider_Add_Cb func, void *data);
/**
* @brief Set a callback for provider disconnection events.
* @brief Sets a callback for provider disconnection events.
*
* @since 1.15
*
@ -297,7 +297,7 @@ EAPI void ecore_buffer_consumer_provider_add_cb_set(Ecore_B
*/
EAPI void ecore_buffer_consumer_provider_del_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Provider_Del_Cb func, void *data);
/**
* @brief Set a callback for enqueued buffer events.
* @brief Sets a callback for enqueued buffer events.
*
* @since 1.15
*
@ -308,7 +308,7 @@ EAPI void ecore_buffer_consumer_provider_del_cb_set(Ecore_B
* A call to this function will set a callback on an Ecore_Buffer_Consumer, causing
* @p func to be called whenever @p consumer has received buffer submitted from provider.
*
* You may success acuiqre Ecore_Buffer after this callback called.
* You may success acquire Ecore_Buffer after this callback called.
*/
EAPI void ecore_buffer_consumer_buffer_enqueued_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Enqueue_Cb func, void *data);
@ -326,13 +326,13 @@ EAPI void ecore_buffer_consumer_buffer_enqueued_cb_set(Ecor
*
* @since 1.15
*
* @param[in] name the name of Buffer_Queue.
* @param[in] name The name of Buffer_Queue.
*
* @return Ecore_Buffer_Provider instance or @c NULL if creation failed.
*/
EAPI Ecore_Buffer_Provider *ecore_buffer_provider_new(const char *name);
/**
* @brief Free an Ecore_Buffer_Provider
* @brief Frees an Ecore_Buffer_Provider.
*
* @since 1.15
*
@ -342,14 +342,14 @@ EAPI Ecore_Buffer_Provider *ecore_buffer_provider_new(const char *name);
*/
EAPI void ecore_buffer_provider_free(Ecore_Buffer_Provider *provider);
/**
* @brief Return the Ecore_Buffer released by consumer or State of Queue.
* @brief Returns the Ecore_Buffer released by consumer or State of Queue.
*
* @since 1.15
*
* @param[in] provider The Ecore_Buffer_Provider to request for buffer
* @param[out] ret_buf A Pointer to the Ecore_Buffer
*
* @return The enumeration of Ecore_Buffer_Return to indicate result of Dequeueing.
* @return The enumeration of Ecore_Buffer_Return to indicate result of Dequeuing.
*
* This function gives you drawable buffer and inform you the state of Queue.
* Each return value of enumeration has meaning as below.
@ -364,7 +364,7 @@ EAPI void ecore_buffer_provider_free(Ecore_Buffer_Provider
*/
EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquire(Ecore_Buffer_Provider *provider, Ecore_Buffer **ret_buf);
/**
* @brief Submit the Ecore_Buffer to Consumer to request compositing.
* @brief Submits the Ecore_Buffer to Consumer to request compositing.
*
* @since 1.15
*
@ -381,7 +381,7 @@ EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquire(Ecore_Buffer
*/
EAPI Eina_Bool ecore_buffer_provider_buffer_enqueue(Ecore_Buffer_Provider *provider, Ecore_Buffer *buffer);
/**
* @brief Check if state of queue.
* @brief Checks if state of queue.
*
* @since 1.15
*
@ -397,7 +397,7 @@ EAPI Eina_Bool ecore_buffer_provider_buffer_enqueue(Ecore_Buffer
*/
EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquirable_check(Ecore_Buffer_Provider *provider);
/**
* @brief Set a callback for consumer connection events.
* @brief Sets a callback for consumer connection events.
*
* @since 1.15
*
@ -410,7 +410,7 @@ EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquirable_check(Eco
*/
EAPI void ecore_buffer_provider_consumer_add_cb_set(Ecore_Buffer_Provider *provider, Ecore_Buffer_Provider_Consumer_Add_Cb func, void *data);
/**
* @brief Set a callback for consumer disconnection events.
* @brief Sets a callback for consumer disconnection events.
*
* @since 1.15
*
@ -423,7 +423,7 @@ EAPI void ecore_buffer_provider_consumer_add_cb_set(Ecore_B
*/
EAPI void ecore_buffer_provider_consumer_del_cb_set(Ecore_Buffer_Provider *provider, Ecore_Buffer_Provider_Consumer_Del_Cb func, void *data);
/**
* @brief Set a callback for released buffer events.
* @brief Sets a callback for released buffer events.
*
* @since 1.15
*

440
src/lib/ecore_con/Ecore_Con.h
View File

File diff suppressed because it is too large Load Diff

46
src/lib/ecore_con/Ecore_Con_Eet.h
View File

@ -35,7 +35,7 @@
* @defgroup Ecore_Con_Eet_Group Eet connection functions
* @ingroup Ecore_Con_Group
*
* The Ecore Connection Eet library ( @c Ecore_Con_Eet) adds @c Eet data
* The Ecore Connection Eet library (@c Ecore_Con_Eet) adds @c Eet data
* serialization features to Ecore Connection objects. Its main aim is to
* provide a way to send @c Eet data streams to another program through sockets
* using @c Ecore_Con objects.
@ -89,7 +89,7 @@ typedef Eina_Bool (*Ecore_Con_Eet_Server_Cb)(void *data, Ecore_Con_Reply *reply,
#endif
/**
* Create a Ecore_Con_Eet server.
* @brief Creates an Ecore_Con_Eet server.
*
* @param server An existing Ecore_Con_Server that have been previously
* 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,
EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server);
/**
* Create a Ecore_Con_Eet client.
* @brief Creates an Ecore_Con_Eet client.
*
* @param server An existing Ecore_Con_Server that have been previously
* 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);
EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server);
/**
* Free an existing Ecore_Con_Eet object.
* @brief Frees an existing Ecore_Con_Eet object.
*
* @param server An existing Ecore_Con_Eet object that have been previously
* 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);
EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece);
/**
* Register an @c Eet data descriptor on a Ecore_Con_Eet object.
* @brief Registers an @c Eet data descriptor on a Ecore_Con_Eet object.
*
* @param ece An Ecore_Con_Eet object.
* @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);
EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_Descriptor *edd);
/**
* Register a data callback on a Ecore_Con_Eet object.
* @brief Registers a data callback on a Ecore_Con_Eet object.
* When the Ecore_Con_Eet object is deleted, this automatically gets removed.
*
* @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_
EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Data_Cb func, const void *data);
/**
* Remove a data callback on a Ecore_Con_Eet object.
* @brief Removes a data callback on a Ecore_Con_Eet object.
*
* @param ece An Ecore_Con_Eet object.
* @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,
EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name);
/**
* Register a raw data callback on a Ecore_Con_Eet object.
* @brief Registers a raw data callback on a Ecore_Con_Eet object.
* When the Ecore_Con_Eet object is deleted, this automatically gets removed.
*
* @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);
EAPI 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);
/**
* Remove a raw data callback on a Ecore_Con_Eet object.
* @brief Removes a raw data callback on a Ecore_Con_Eet object.
*
* @param ece An Ecore_Con_Eet object.
* @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
EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *name);
/**
* Register a client connect callback on a Ecore_Con_Eet object.
* @brief Registers a client connect callback on a Ecore_Con_Eet object.
* @brief This callback can be registered on the server program to know when a
* client connects.
* 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
EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
/**
* Remove a client connect callback on a Ecore_Con_Eet object.
* @brief Removes a client connect callback on a Ecore_Con_Eet object.
*
* @param ece An Ecore_Con_Eet object.
* @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
EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
/**
* Register a client disconnect callback on a Ecore_Con_Eet object.
* @brief Registers a client disconnect callback on a Ecore_Con_Eet object.
* @brief This callback can be registered on the server program to know when a
* client disconnects.
* 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
EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
/**
* Remove a client disconnect callback on a Ecore_Con_Eet object.
* @brief Removes a client disconnect callback on a Ecore_Con_Eet object.
*
* @param ece An Ecore_Con_Eet object.
* @param func The callback to remove.
@ -222,8 +222,8 @@ EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore
EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
/**
* Register a server connect callback on a Ecore_Con_Eet object.
* @brief This callback can be registered on the client program to be called
* @brief Registers a server connect callback on a Ecore_Con_Eet object.
* @brief This callback can be registered on the client program to be called.
* when it has been connected to the server.
* When the Ecore_Con_Eet object is deleted, this automatically gets removed.
*
@ -234,7 +234,7 @@ EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore
EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
/**
* Remove a server connect callback on a Ecore_Con_Eet object.
* @brief Removes a server connect callback on a Ecore_Con_Eet object.
*
* @param ece An Ecore_Con_Eet object.
* @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
EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
/**
* Register a server disconnect callback on a Ecore_Con_Eet object.
* @brief Registers a server disconnect callback on a Ecore_Con_Eet object.
* @brief This callback can be registered on the client program to be called
* when it has been disconnected from the server.
* 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
EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
/**
* Remove a server disconnect callback on a Ecore_Con_Eet object.
* @brief Removes a server disconnect callback on a Ecore_Con_Eet object.
*
* @param ece An Ecore_Con_Eet object.
* @param func The callback to remove.
@ -264,7 +264,7 @@ EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore
EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
/**
* Attach data to an Ecore_Con_Eet object.
* @brief Attaches data to an Ecore_Con_Eet object.
*
* @param ece An Ecore_Con_Eet object.
* @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
EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data);
/**
* Get the data attached to an Ecore_Con_Eet object.
* @brief Gets the data attached to an Ecore_Con_Eet object.
*
* @param ece An Ecore_Con_Eet object.
* @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);
EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece);
/**
* Get the Ecore_Con_Eet object corresponding to the Ecore_Con_Reply object.
* @brief Gets the Ecore_Con_Eet object corresponding to the Ecore_Con_Reply object.
*
* @param reply An Ecore_Con_Reply object.
* @return The corresponding Ecore_Con_Eet object.
@ -288,7 +288,7 @@ EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece);
EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply);
/**
* Send some data using a protocol type.
* @brief Sends some data using a protocol type.
*
* @param reply An Ecore_Con_Reply object.
* @param protocol_name The protocol type to use.
@ -297,7 +297,7 @@ EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply);
EAPI void ecore_con_eet_send(Ecore_Con_Reply *reply, const char *protocol_name, void *value);
/**
* Send some raw data using a protocol type.
* @brief Sends some raw data using a protocol type.
*
* @param reply An Ecore_Con_Reply object.
* @param protocol_name The protocol type to use.