From ebe9a4605b0f0c96f3d18db472bd6a0638ce2b77 Mon Sep 17 00:00:00 2001 From: "Myoungwoon Roy, Kim" Date: Fri, 10 Feb 2017 13:10:15 +0900 Subject: [PATCH] Fix typos, cacologique statements in API reference doxygen of ecore's audio, avahi, buffer, and con Change-Id: Id5a3d71475adbcc8eb932cef2b38851e6586c61f --- src/lib/ecore_audio/Ecore_Audio.h | 22 +- src/lib/ecore_audio/ecore_audio_obj.h | 2 +- src/lib/ecore_audio/ecore_audio_obj_in.h | 2 +- src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h | 2 +- src/lib/ecore_audio/ecore_audio_obj_in_tone.h | 4 +- src/lib/ecore_audio/ecore_audio_obj_out.h | 2 +- src/lib/ecore_audio/ecore_audio_obj_out_pulse.h | 2 +- src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h | 2 +- src/lib/ecore_audio/ecore_audio_obj_out_tizen.h | 2 +- src/lib/ecore_avahi/Ecore_Avahi.h | 10 +- src/lib/ecore_buffer/Ecore_Buffer.h | 46 +-- src/lib/ecore_buffer/Ecore_Buffer_Queue.h | 60 +-- src/lib/ecore_con/Ecore_Con.h | 453 +++++++++++----------- src/lib/ecore_con/Ecore_Con_Eet.h | 46 +-- src/lib/ecore_con/Ecore_Con_Legacy.h | 4 +- 15 files changed, 330 insertions(+), 329 deletions(-) diff --git a/src/lib/ecore_audio/Ecore_Audio.h b/src/lib/ecore_audio/Ecore_Audio.h index e9ee2db..f80340f 100644 --- a/src/lib/ecore_audio/Ecore_Audio.h +++ b/src/lib/ecore_audio/Ecore_Audio.h @@ -20,7 +20,7 @@ /** * @file Ecore_Audio.h - * @brief Audio utility functions + * @brief Audio utility functions. */ #ifdef __cplusplus @@ -90,7 +90,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 @@ -102,7 +102,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 @@ -120,7 +120,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 @@ -134,7 +134,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 @@ -148,7 +148,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 @@ -163,7 +163,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; @@ -173,9 +173,9 @@ typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio; /** * @internal * - * @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 * @@ -191,9 +191,9 @@ EAPI int ecore_audio_init(void); /** * @internal * - * @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 diff --git a/src/lib/ecore_audio/ecore_audio_obj.h b/src/lib/ecore_audio/ecore_audio_obj.h index 917acc1..ea36e29 100644 --- a/src/lib/ecore_audio/ecore_audio_obj.h +++ b/src/lib/ecore_audio/ecore_audio_obj.h @@ -20,7 +20,7 @@ /** * @file ecore_audio_obj.h - * @brief Base Ecore_Audio object + * @brief Base Ecore_Audio object. */ #ifdef __cplusplus diff --git a/src/lib/ecore_audio/ecore_audio_obj_in.h b/src/lib/ecore_audio/ecore_audio_obj_in.h index f9df45d..5007185 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_in.h +++ b/src/lib/ecore_audio/ecore_audio_obj_in.h @@ -20,7 +20,7 @@ /** * @file ecore_audio_obj_in.h - * @brief Ecore_Audio Input Object + * @brief Ecore_Audio Input Object. */ #ifdef __cplusplus diff --git a/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h b/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h index ea689c6..96d9570 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h +++ b/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h @@ -20,7 +20,7 @@ /** * @file ecore_audio_obj_in_sndfile.h - * @brief Ecore_Audio sndfile input + * @brief Ecore_Audio sndfile input. */ #ifdef __cplusplus diff --git a/src/lib/ecore_audio/ecore_audio_obj_in_tone.h b/src/lib/ecore_audio/ecore_audio_obj_in_tone.h index f0e36e0..c1599d7 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_in_tone.h +++ b/src/lib/ecore_audio/ecore_audio_obj_in_tone.h @@ -20,7 +20,7 @@ /** * @file ecore_audio_obj_in_tone.h - * @brief Ecore_Audio tone input + * @brief Ecore_Audio tone input. */ #ifdef __cplusplus @@ -36,7 +36,7 @@ extern "C" */ /** - * @brief The frequency of the tone in Hz + * @brief The frequency of the tone in Hz. * * Set with @ref eo_key_data_set() */ diff --git a/src/lib/ecore_audio/ecore_audio_obj_out.h b/src/lib/ecore_audio/ecore_audio_obj_out.h index 8c61658..719333a 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_out.h +++ b/src/lib/ecore_audio/ecore_audio_obj_out.h @@ -20,7 +20,7 @@ /** * @file ecore_audio_obj_out.h - * @brief Ecore_Audio output object + * @brief Ecore_Audio output object. */ #ifdef __cplusplus diff --git a/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h b/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h index 553c424..0588748 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h +++ b/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h @@ -20,7 +20,7 @@ /** * @file ecore_audio_obj_out_pulse.h - * @brief Ecore_Audio pulseaudio output + * @brief Ecore_Audio pulseaudio output. */ #ifdef __cplusplus diff --git a/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h b/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h index 2fc6604..4bc53a8 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h +++ b/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h @@ -20,7 +20,7 @@ /** * @file ecore_audio_obj_out_sndfile.h - * @brief Ecore_Audio sndfile output + * @brief Ecore_Audio sndfile output. */ #ifdef __cplusplus diff --git a/src/lib/ecore_audio/ecore_audio_obj_out_tizen.h b/src/lib/ecore_audio/ecore_audio_obj_out_tizen.h index 60d9caf..6031938 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_out_tizen.h +++ b/src/lib/ecore_audio/ecore_audio_obj_out_tizen.h @@ -20,7 +20,7 @@ /** * @file ecore_audio_obj_out_pulse.h - * @brief Ecore_Audio pulseaudio output + * @brief Ecore_Audio pulseaudio output. */ #ifdef __cplusplus diff --git a/src/lib/ecore_avahi/Ecore_Avahi.h b/src/lib/ecore_avahi/Ecore_Avahi.h index 3a7c8dd..9ab2b5e 100644 --- a/src/lib/ecore_avahi/Ecore_Avahi.h +++ b/src/lib/ecore_avahi/Ecore_Avahi.h @@ -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 @@ -54,7 +54,7 @@ typedef struct _Ecore_Avahi Ecore_Avahi; /**< A handle for an Avahi instance. */ /** * @internal * - * @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 @@ -64,7 +64,7 @@ EAPI Ecore_Avahi *ecore_avahi_add(void); /** * @internal * - * @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 @@ -77,7 +77,7 @@ EAPI void ecore_avahi_del(Ecore_Avahi *handler); /** * @internal * - * @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. diff --git a/src/lib/ecore_buffer/Ecore_Buffer.h b/src/lib/ecore_buffer/Ecore_Buffer.h index 508f467..7ccb317 100644 --- a/src/lib/ecore_buffer/Ecore_Buffer.h +++ b/src/lib/ecore_buffer/Ecore_Buffer.h @@ -517,7 +517,7 @@ struct _Ecore_Buffer_Backend }; /** - * @brief Initialize the Ecore_Buffer system. + * @brief Initializes the Ecore_Buffer system. * * @since 1.15 * @@ -531,7 +531,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 * @@ -571,15 +571,15 @@ 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. * @@ -593,9 +593,9 @@ EAPI Ecore_Buffer *ecore_buffer_new(const char *engine, unsigned int width, unsi * * @since 1.15 * - * @param[in] engine the name of backend - * @param[in] tbm_surface the handle of tbm_surface_h - * @param[in] flags the flags for Ecore_Buffer + * @param[in] engine The name of backend + * @param[in] tbm_surface The handle of tbm_surface_h + * @param[in] flags The flags for Ecore_Buffer * * @return Newly allocated Ecore_Buffer instance based on tbm surface, NULL otherwise. * @@ -605,7 +605,7 @@ EAPI Ecore_Buffer *ecore_buffer_new(const char *engine, unsigned int width, unsi */ EAPI Ecore_Buffer *ecore_buffer_new_with_tbm_surface(const char *engine, void *tbm_surface, unsigned int flags); /** - * @brief Free the given Ecore_Buffer. + * @brief Frees the given Ecore_Buffer. * * @since 1.15 * @@ -617,7 +617,7 @@ EAPI Ecore_Buffer *ecore_buffer_new_with_tbm_surface(const char *engine, void *t */ 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 * @@ -636,7 +636,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 * @@ -652,13 +652,13 @@ EAPI void ecore_buffer_free_callback_add(Ecore_Buffer *buf, Ecore_Buffe */ EAPI void ecore_buffer_free_callback_remove(Ecore_Buffer *buf, Ecore_Buffer_Cb func, void *data); /** - * @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. * * @if MOBILE @since_tizen 2.4 * @elseif WEARABLE @since_tizen 3.0 @@ -666,7 +666,7 @@ EAPI void ecore_buffer_free_callback_remove(Ecore_Buffer *buf, Ecore_Bu */ 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 * @@ -683,13 +683,13 @@ 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. * @@ -699,7 +699,7 @@ EAPI void *ecore_buffer_tbm_surface_get(Ecore_Buffer *buf); */ 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 * @@ -707,7 +707,7 @@ 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. * * @if MOBILE @since_tizen 2.4 * @elseif WEARABLE @since_tizen 3.0 @@ -715,7 +715,7 @@ EAPI Eina_Bool ecore_buffer_size_get(Ecore_Buffer *buf, unsigned int *width, */ 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 * diff --git a/src/lib/ecore_buffer/Ecore_Buffer_Queue.h b/src/lib/ecore_buffer/Ecore_Buffer_Queue.h index 4cbeb38..0e7a242 100644 --- a/src/lib/ecore_buffer/Ecore_Buffer_Queue.h +++ b/src/lib/ecore_buffer/Ecore_Buffer_Queue.h @@ -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,13 +173,13 @@ 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() * @@ -189,11 +189,11 @@ typedef void (*Ecore_Buffer_Provider_Enqueue_Cb) (Ecore_Buffer_Provider *provide */ 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() * @@ -217,10 +217,10 @@ 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. * @@ -230,7 +230,7 @@ EAPI int ecore_buffer_queue_shutdown(void); */ 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 * @@ -244,13 +244,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() * @@ -263,7 +263,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 * @@ -285,7 +285,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 * @@ -299,7 +299,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 * @@ -316,7 +316,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 * @@ -333,7 +333,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 * @@ -344,7 +344,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. * * @if MOBILE @since_tizen 2.4 * @elseif WEARABLE @since_tizen 3.0 @@ -366,7 +366,7 @@ 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. * @@ -376,7 +376,7 @@ EAPI void ecore_buffer_consumer_buffer_enqueued_cb_set(Ecor */ 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 * @@ -390,14 +390,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. @@ -416,7 +416,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 * @@ -437,7 +437,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 * @@ -457,7 +457,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 * @@ -474,7 +474,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 * @@ -491,7 +491,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 * diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h index d6ee258..a91c596 100644 --- a/src/lib/ecore_con/Ecore_Con.h +++ b/src/lib/ecore_con/Ecore_Con.h @@ -56,7 +56,7 @@ * To create a listening server call @c ecore_con_server_add(), optionally using * an ECORE_CON_USE_* encryption type OR'ed with the type for encryption. * - * To connect to a server, call @c ecore_con_server_connect(). Data can + * To connect to a server, call @c ecore_con_server_connect(). Data can * then be sent to the server using the @c ecore_con_server_send(). * * Functions are described in the following groupings: @@ -81,15 +81,15 @@ * retrieval of the client's ip with @ref ecore_con_client_ip_get and * associating data with the client using ecore_con_client_data_set. * @li ECORE_CON_EVENT_CLIENT_DEL: Whenever a client connection to an - * @c Ecore_Con_Server is destroyed, an event of this type is emitted. The contents of + * @c Ecore_Con_Server is destroyed, an event of this type is emitted. The contents of * the data with this event are variable, but if the client object in the data * is non-null, it must be freed with @ref ecore_con_client_del. * @li ECORE_CON_EVENT_CLIENT_DATA: Whenever a server object receives * data, then an event of this type is emitted. The data will contain - * the size and contents of the message sent by the client. It should be noted that + * the size and contents of the message sent by the client. It should be noted that * data within this object is transient, so it must be duplicated in order to be - * retained. This event will continue to occur until the client has stopped sending its - * message, so a good option for storing this data is an Eina_Strbuf. Once the message has + * retained. This event will continue to occur until the client has stopped sending its + * message, so a good option for storing this data is an Eina_Strbuf. Once the message has * been received in full, the client object must be freed with ecore_con_client_free. * * Client side events: @@ -100,15 +100,15 @@ * occurred. * @li ECORE_CON_EVENT_SERVER_DEL: Whenever a server object is destroyed, * usually by the server connection being refused or dropped, an event of this - * type is emitted. The contents of the data with this event are variable, + * type is emitted. The contents of the data with this event are variable, * but if the server object in the data is non-null, it must be freed * with @ref ecore_con_server_del. * @li ECORE_CON_EVENT_SERVER_DATA: Whenever client object receives * data from the server, an event of this type is emitted. The data will contain both - * the size and contents of the message sent by the server. It should be noted that + * the size and contents of the message sent by the server. It should be noted that * data within this object is transient, so it must be duplicated in order to be - * retained. This event will continue to occur until the server has stopped sending its - * message, so a good option for storing this data is an Eina_Strbuf. Once the message has + * retained. This event will continue to occur until the server has stopped sending its + * message, so a good option for storing this data is an Eina_Strbuf. Once the message has * been received in full, the server object must be freed with ecore_con_server_free. * */ @@ -231,7 +231,7 @@ typedef Eo Ecore_Con; /** * @typedef Ecore_Con_Socks - * An object representing a SOCKS proxy + * An object representing a SOCKS proxy. * @ingroup Ecore_Con_Socks_Group * @since 1.2 */ @@ -266,9 +266,10 @@ typedef void (*Ecore_Con_Dns_Cb)(const char *canonname, /** * @typedef Ecore_Con_Type * @enum _Ecore_Con_Type - * Types for an ecore_con client/server object. A correct way to set this type is + * Types for an ecore_con client/server object. A correct way to set this type is * with an ECORE_CON_$TYPE, optionally OR'ed with an ECORE_CON_$USE if encryption is desired, * and LOAD_CERT if the previously loaded certificate should be used. + * * @code * ECORE_CON_REMOTE_TCP | ECORE_CON_USE_TLS | ECORE_CON_LOAD_CERT * @endcode @@ -293,7 +294,7 @@ typedef enum _Ecore_Con_Type /** Remote connection sending packets immediately */ ECORE_CON_REMOTE_NODELAY = 7, /** Remote connection sending data in large chunks - * @note Only available on Linux + * @note Only available on Linux. * @since 1.2 */ ECORE_CON_REMOTE_CORK = 8, @@ -308,7 +309,7 @@ typedef enum _Ecore_Con_Type /** Attempt to use the loaded certificate */ ECORE_CON_LOAD_CERT = (1 << 7), /** Disable all types of proxy on the server - * @note Only functional for clients + * @note Only functional for clients. * @since 1.2 */ ECORE_CON_NO_PROXY = (1 << 8), @@ -331,85 +332,85 @@ typedef enum _Ecore_Con_Type /** * @typedef Ecore_Con_Event_Client_Add - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. */ typedef struct _Ecore_Con_Event_Client_Add Ecore_Con_Event_Client_Add; /** * @typedef Ecore_Con_Event_Client_Upgrade - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @since 1.1 */ typedef struct _Ecore_Con_Event_Client_Upgrade Ecore_Con_Event_Client_Upgrade; /** * @typedef Ecore_Con_Event_Client_Del - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. */ typedef struct _Ecore_Con_Event_Client_Del Ecore_Con_Event_Client_Del; /** * @typedef Ecore_Con_Event_Client_Error - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @since 1.1 */ typedef struct _Ecore_Con_Event_Client_Error Ecore_Con_Event_Client_Error; /** * @typedef Ecore_Con_Event_Server_Add - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. */ typedef struct _Ecore_Con_Event_Server_Add Ecore_Con_Event_Server_Add; /** * @typedef Ecore_Con_Event_Server_Upgrade - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @since 1.1 */ typedef struct _Ecore_Con_Event_Server_Upgrade Ecore_Con_Event_Server_Upgrade; /** * @typedef Ecore_Con_Event_Server_Del - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. */ typedef struct _Ecore_Con_Event_Server_Del Ecore_Con_Event_Server_Del; /** * @typedef Ecore_Con_Event_Server_Error - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @since 1.1 */ typedef struct _Ecore_Con_Event_Server_Error Ecore_Con_Event_Server_Error; /** * @typedef Ecore_Con_Event_Client_Data - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. */ typedef struct _Ecore_Con_Event_Client_Data Ecore_Con_Event_Client_Data; /** * @typedef Ecore_Con_Event_Server_Data - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. */ typedef struct _Ecore_Con_Event_Server_Data Ecore_Con_Event_Server_Data; /** * @typedef Ecore_Con_Event_Client_Write - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @since 1.1 */ typedef struct _Ecore_Con_Event_Client_Write Ecore_Con_Event_Client_Write; /** * @typedef Ecore_Con_Event_Server_Write - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @since 1.1 */ typedef struct _Ecore_Con_Event_Server_Write Ecore_Con_Event_Server_Write; /** * @typedef Ecore_Con_Event_Proxy_Bind - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @since 1.2 */ typedef struct _Ecore_Con_Event_Proxy_Bind Ecore_Con_Event_Proxy_Bind; @@ -418,7 +419,7 @@ typedef struct _Ecore_Con_Event_Proxy_Bind Ecore_Con_Event_Proxy_Bind; /** * @typedef Efl_Network_Event_Url_Data * Used as the @p data param for the corresponding event - * EFL_NETWORK_EVENT_URL_DATA + * EFL_NETWORK_EVENT_URL_DATA. * @ingroup Ecore_Con_Url_Group */ typedef struct _Efl_Network_Event_Url_Data Efl_Network_Event_Url_Data; @@ -426,14 +427,14 @@ typedef struct _Efl_Network_Event_Url_Data Efl_Network_Event_Url_Data; /** * @typedef Ecore_Con_Event_Url_Data - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @ingroup Ecore_Con_Url_Group */ typedef struct _Ecore_Con_Event_Url_Data Ecore_Con_Event_Url_Data; /** * @typedef Ecore_Con_Event_Url_Complete - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @ingroup Ecore_Con_Url_Group */ typedef struct _Ecore_Con_Event_Url_Complete Ecore_Con_Event_Url_Complete; @@ -442,7 +443,7 @@ typedef struct _Ecore_Con_Event_Url_Complete Ecore_Con_Event_Url_Complete; /** * @typedef Efl_Network_Event_Url_Complete * Used as the @p data param for the corresponding event - * EFL_NETWORK_EVENT_URL_COMPLETE + * EFL_NETWORK_EVENT_URL_COMPLETE. * @ingroup Ecore_Con_Url_Group */ typedef struct _Ecore_Con_Event_Url_Complete Efl_Network_Event_Url_Complete; @@ -450,7 +451,7 @@ typedef struct _Ecore_Con_Event_Url_Complete Efl_Network_Event_Url_Complete; /** * @typedef Ecore_Con_Event_Url_Progress - * Used as the @p data param for the corresponding event + * Used as the @p data param for the corresponding event. * @ingroup Ecore_Con_Url_Group */ typedef struct _Ecore_Con_Event_Url_Progress Ecore_Con_Event_Url_Progress; @@ -459,7 +460,7 @@ typedef struct _Ecore_Con_Event_Url_Progress Ecore_Con_Event_Url_Progress; /** * @typedef Efl_Network_Event_Url_Progress * Used as the @p data param for the corresponding event - * EFL_NETWORK_EVENT_URL_PROGRESS + * EFL_NETWORK_EVENT_URL_PROGRESS. * @ingroup Ecore_Con_Url_Group */ typedef struct _Ecore_Con_Event_Url_Progress Efl_Network_Event_Url_Progress; @@ -467,7 +468,7 @@ typedef struct _Ecore_Con_Event_Url_Progress Efl_Network_Event_Url_Progress; /** * @struct _Ecore_Con_Event_Client_Add - * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_ADD event + * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_ADD event. */ struct _Ecore_Con_Event_Client_Add { @@ -476,7 +477,7 @@ struct _Ecore_Con_Event_Client_Add /** * @struct _Ecore_Con_Event_Client_Upgrade - * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_UPGRADE event + * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_UPGRADE event. * @since 1.1 */ struct _Ecore_Con_Event_Client_Upgrade @@ -486,7 +487,7 @@ struct _Ecore_Con_Event_Client_Upgrade /** * @struct _Ecore_Con_Event_Client_Del - * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_DEL event + * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_DEL event. */ struct _Ecore_Con_Event_Client_Del { @@ -495,7 +496,7 @@ struct _Ecore_Con_Event_Client_Del /** * @struct _Ecore_Con_Event_Client_Error - * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_ERROR event + * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_ERROR event. */ struct _Ecore_Con_Event_Client_Error { @@ -505,7 +506,7 @@ struct _Ecore_Con_Event_Client_Error /** * @struct _Ecore_Con_Event_Server_Add - * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_ADD event + * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_ADD event. */ struct _Ecore_Con_Event_Server_Add { @@ -514,7 +515,7 @@ struct _Ecore_Con_Event_Server_Add /** * @struct _Ecore_Con_Event_Server_Upgrade - * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_UPGRADE event + * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_UPGRADE event. * @since 1.1 */ struct _Ecore_Con_Event_Server_Upgrade @@ -524,7 +525,7 @@ struct _Ecore_Con_Event_Server_Upgrade /** * @struct _Ecore_Con_Event_Server_Del - * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_DEL event + * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_DEL event. */ struct _Ecore_Con_Event_Server_Del { @@ -533,7 +534,7 @@ struct _Ecore_Con_Event_Server_Del /** * @struct _Ecore_Con_Event_Server_Error - * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_ERROR event + * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_ERROR event. */ struct _Ecore_Con_Event_Server_Error { @@ -543,7 +544,7 @@ struct _Ecore_Con_Event_Server_Error /** * @struct _Ecore_Con_Event_Client_Data - * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_DATA event + * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_DATA event. */ struct _Ecore_Con_Event_Client_Data { @@ -565,7 +566,7 @@ struct _Ecore_Con_Event_Server_Data /** * @struct _Ecore_Con_Event_Client_Write - * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_WRITE event + * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_WRITE event. */ struct _Ecore_Con_Event_Client_Write { @@ -585,7 +586,7 @@ struct _Ecore_Con_Event_Server_Write /** * @struct _Ecore_Con_Event_Proxy_Bind - * Used as the @p data param for the @ref ECORE_CON_EVENT_PROXY_BIND event + * Used as the @p data param for the @ref ECORE_CON_EVENT_PROXY_BIND event. * @ingroup Ecore_Con_Socks_Group * @since 1.2 */ @@ -599,7 +600,7 @@ struct _Ecore_Con_Event_Proxy_Bind #ifdef EFL_EO_API_SUPPORT /** * @struct _Efl_Network_Event_Url_Data - * Used as the @p data param for the @ref EFL_NETWORK_EVENT_URL_DATA event + * Used as the @p data param for the @ref EFL_NETWORK_EVENT_URL_DATA event. * @ingroup Ecore_Con_Url_Group */ struct _Efl_Network_Event_Url_Data @@ -612,7 +613,7 @@ struct _Efl_Network_Event_Url_Data /** * @struct _Ecore_Con_Event_Url_Data - * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_DATA event + * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_DATA event. * @ingroup Ecore_Con_Url_Group */ struct _Ecore_Con_Event_Url_Data @@ -624,7 +625,7 @@ struct _Ecore_Con_Event_Url_Data /** * @struct _Ecore_Con_Event_Url_Complete - * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_COMPLETE event + * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_COMPLETE event. * @ingroup Ecore_Con_Url_Group */ struct _Ecore_Con_Event_Url_Complete @@ -635,7 +636,7 @@ struct _Ecore_Con_Event_Url_Complete /** * @struct _Ecore_Con_Event_Url_Progress - * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_PROGRESS event + * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_PROGRESS event. * @ingroup Ecore_Con_Url_Group */ struct _Ecore_Con_Event_Url_Progress @@ -654,7 +655,7 @@ struct _Ecore_Con_Event_Url_Progress }; /** - * A client has connected to the serve + * A client has connected to the server. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -662,7 +663,7 @@ struct _Ecore_Con_Event_Url_Progress */ EAPI extern int ECORE_CON_EVENT_CLIENT_ADD; /** - * A client has disconnected from the serve + * A client has disconnected from the server. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -670,7 +671,7 @@ EAPI extern int ECORE_CON_EVENT_CLIENT_ADD; */ EAPI extern int ECORE_CON_EVENT_CLIENT_DEL; /** - * A client experienced an error + * A client experienced an error. * @since 1.1 * * @if MOBILE @since_tizen 3.0 @@ -679,7 +680,7 @@ EAPI extern int ECORE_CON_EVENT_CLIENT_DEL; */ EAPI extern int ECORE_CON_EVENT_CLIENT_ERROR; /** - * A client connection has been upgraded to SSL + * A client connection has been upgraded to SSL. * @since 1.1 * * @if MOBILE @since_tizen 3.0 @@ -688,7 +689,7 @@ EAPI extern int ECORE_CON_EVENT_CLIENT_ERROR; */ EAPI extern int ECORE_CON_EVENT_CLIENT_UPGRADE; /** - * A server was create + * A server was created. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -696,7 +697,7 @@ EAPI extern int ECORE_CON_EVENT_CLIENT_UPGRADE; */ EAPI extern int ECORE_CON_EVENT_SERVER_ADD; /** - * A server connection was los + * A server connection was lost. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -704,7 +705,7 @@ EAPI extern int ECORE_CON_EVENT_SERVER_ADD; */ EAPI extern int ECORE_CON_EVENT_SERVER_DEL; /** - * A server experienced an error + * A server experienced an error. * @since 1.1 * * @if MOBILE @since_tizen 3.0 @@ -713,7 +714,7 @@ EAPI extern int ECORE_CON_EVENT_SERVER_DEL; */ EAPI extern int ECORE_CON_EVENT_SERVER_ERROR; /** - * A server connection has been upgraded to SSL + * A server connection has been upgraded to SSL. * @since 1.1 * * @if MOBILE @since_tizen 3.0 @@ -722,7 +723,7 @@ EAPI extern int ECORE_CON_EVENT_SERVER_ERROR; */ EAPI extern int ECORE_CON_EVENT_SERVER_UPGRADE; /** - * A server connection has sent data to its client + * A server connection has sent data to its client. * @since 1.1 * * @if MOBILE @since_tizen 3.0 @@ -731,7 +732,7 @@ EAPI extern int ECORE_CON_EVENT_SERVER_UPGRADE; */ EAPI extern int ECORE_CON_EVENT_CLIENT_WRITE; /** - * A server connection object has sent data + * A server connection object has sent data. * @since 1.1 * * @if MOBILE @since_tizen 3.0 @@ -740,7 +741,7 @@ EAPI extern int ECORE_CON_EVENT_CLIENT_WRITE; */ EAPI extern int ECORE_CON_EVENT_SERVER_WRITE; /** - * A client connected to the server has sent dat + * A client connected to the server has sent data. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -748,7 +749,7 @@ EAPI extern int ECORE_CON_EVENT_SERVER_WRITE; */ EAPI extern int ECORE_CON_EVENT_CLIENT_DATA; /** - * A server connection object has dat + * A server connection object has data. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -756,7 +757,7 @@ EAPI extern int ECORE_CON_EVENT_CLIENT_DATA; */ EAPI extern int ECORE_CON_EVENT_SERVER_DATA; /** - * A server connection has successfully negotiated an ip:port binding + * A server connection has successfully negotiated an ip:port binding. * @since 1.2 * * @if MOBILE @since_tizen 3.0 @@ -765,7 +766,7 @@ EAPI extern int ECORE_CON_EVENT_SERVER_DATA; */ EAPI extern int ECORE_CON_EVENT_PROXY_BIND; /** - * A URL object has dat + * A URL object has data. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -773,7 +774,7 @@ EAPI extern int ECORE_CON_EVENT_PROXY_BIND; */ EAPI extern int ECORE_CON_EVENT_URL_DATA; /** - * A URL object has completed its transfer to and from the server and can be reuse + * A URL object has completed its transfer to and from the server and can be reused. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -781,7 +782,7 @@ EAPI extern int ECORE_CON_EVENT_URL_DATA; */ EAPI extern int ECORE_CON_EVENT_URL_COMPLETE; /** - * A URL object has made progress in its transfe + * A URL object has made progress in its transfer. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -801,7 +802,7 @@ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS; */ /** - * @brief Initialise the Ecore_Con library. + * @brief Initializes the Ecore_Con library. * @return Number of times the library has been initialised without being * shut down. * @@ -815,7 +816,7 @@ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS; EAPI int ecore_con_init(void); /** - * @brief Shut down the Ecore_Con library. + * @brief Shuts down the Ecore_Con library. * @return Number of times the library has been initialised without being * shut down. * @note This function already calls ecore_shutdown() internally, so you don't @@ -841,10 +842,10 @@ EAPI int ecore_con_shutdown(void); */ /** - * @brief Return if SSL support is available - * @return 1 if SSL is available and provided by gnutls, - * 2 if SSL is available and provided by openssl, - * 0 if it is not available. + * @brief Returns if SSL support is available. + * @return @c 1 if SSL is available and provided by gnutls, + * @c 2 if SSL is available and provided by openssl, + * @c 0 if it is not available. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -853,7 +854,7 @@ EAPI int ecore_con_shutdown(void); EAPI int ecore_con_ssl_available_get(void); /** - * @brief Add an ssl certificate for use in ecore_con functions. + * @brief Adds an SSL certificate for use in ecore_con functions. * * Use this function to add a SSL PEM certificate. * Simply specify the cert here to use it in the server object for connecting or listening. @@ -869,12 +870,12 @@ EAPI int ecore_con_ssl_available_get(void); EAPI Eina_Bool ecore_con_ssl_server_cert_add(Ecore_Con_Server *svr, const char *cert); /** - * @brief Add an ssl private key for use in ecore_con functions. + * @brief Adds an SSL private key for use in ecore_con functions. * - * Use this function to add a SSL PEM private key + * Use this function to add a SSL PEM private key. * Simply specify the key file here to use it in the server object for connecting or listening. * If there is an error loading the key, an error will automatically be logged. - * @param svr The server object + * @param svr The server object. * @param key_file The path to the key file. * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. * @@ -885,12 +886,12 @@ EAPI Eina_Bool ecore_con_ssl_server_cert_add(Ecore_Con_Server *svr, cons EAPI Eina_Bool ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr, const char *key_file); /** - * @brief Add an ssl CRL for use in ecore_con functions. + * @brief Adds an SSL CRL for use in ecore_con functions. * - * Use this function to add a SSL PEM CRL file + * Use this function to add a SSL PEM CRL file. * Simply specify the CRL file here to use it in the server object for connecting or listening. * If there is an error loading the CRL, an error will automatically be logged. - * @param svr The server object + * @param svr The server object. * @param crl_file The path to the CRL file. * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. * @@ -901,15 +902,15 @@ EAPI Eina_Bool ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr, c EAPI Eina_Bool ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr, const char *crl_file); /** - * @brief Add an ssl CA file for use in ecore_con functions. + * @brief Adds an SSL CA file for use in ecore_con functions. * * Use this function to add a SSL PEM CA file. * Simply specify the file here to use it in the server object for connecting or listening. * If there is an error loading the CAs, an error will automatically be logged. - * @param svr The server object + * @param svr The server object. * @param ca_file The path to the CA file. * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. - * @note since 1.2, this function can load directores + * @note since 1.2, this function can load directories. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -918,7 +919,7 @@ EAPI Eina_Bool ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr, const EAPI Eina_Bool ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr, const char *ca_file); /** - * @brief Enable certificate verification on a server object + * @brief Enables certificate verification on a server object. * * Call this function on a server object before main loop has started * to enable verification of certificates against loaded certificates. @@ -931,13 +932,13 @@ EAPI Eina_Bool ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr, co EAPI void ecore_con_ssl_server_verify(Ecore_Con_Server *svr); /** - * @brief Enable hostname-based certificate verification on a server object + * @brief Enables hostname-based certificate verification on a server object. * * Call this function on a server object before main loop has started * to enable verification of certificates using ONLY their hostnames. - * @param svr The server object + * @param svr The server object. * @note This function has no effect when used on a listening server created by - * ecore_con_server_add + * ecore_con_server_add. * @since 1.1 * * @if MOBILE @since_tizen 3.0 @@ -947,7 +948,7 @@ EAPI void ecore_con_ssl_server_verify(Ecore_Con_Server *svr); EAPI void ecore_con_ssl_server_verify_basic(Ecore_Con_Server *svr); /** - * @brief Set the hostname to verify against in certificate verification + * @brief Sets the hostname to verify against in certificate verification. * * Sometimes the certificate hostname will not match the hostname that you are * connecting to, and will instead match a different name. An example of this is @@ -955,7 +956,7 @@ EAPI void ecore_con_ssl_server_verify_basic(Ecore_Con_Server *svr); * certificate for gmail.com. This certificate should be trusted, and so you must call * this function with "gmail.com" as @p name. * See RFC2818 for more details. - * @param svr The server object + * @param svr The server object. * @param name The hostname to verify against * @since 1.2 * @@ -966,12 +967,12 @@ EAPI void ecore_con_ssl_server_verify_basic(Ecore_Con_Server *svr); EAPI void ecore_con_ssl_server_verify_name_set(Ecore_Con_Server *svr, const char *name); /** - * @brief Get the hostname to verify against in certificate verification + * @brief Gets the hostname to verify against in certificate verification. * * This function returns the name which will be used to validate the SSL certificate * common name (CN) or alt name (subjectAltName). It will default to the @p name * param in ecore_con_server_connect(), but can be changed with ecore_con_ssl_server_verify_name_set(). - * @param svr The server object + * @param svr The server object. * @return The hostname which will be used * @since 1.2 * @@ -982,15 +983,15 @@ EAPI void ecore_con_ssl_server_verify_name_set(Ecore_Con_Server *sv EAPI const char *ecore_con_ssl_server_verify_name_get(Ecore_Con_Server *svr); /** - * @brief Upgrade a connection to a specified level of encryption + * @brief Upgrades a connection to a specified level of encryption. * * Use this function to begin an SSL handshake on a connection (STARTTLS or similar). * Once the upgrade has been completed, an ECORE_CON_EVENT_SERVER_UPGRADE event will be emitted. * The connection should be treated as disconnected until the next event. - * @param svr The server object + * @param svr The server object. * @param ssl_type The SSL connection type (ONLY). * @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE. - * @note This function is NEVER to be used on a server object created with ecore_con_server_add + * @note This function is NEVER to be used on a server object created with ecore_con_server_add. * @warning Setting a wrong value for @p compl_type WILL mess up your program. * @since 1.1 * @@ -1001,12 +1002,12 @@ EAPI const char *ecore_con_ssl_server_verify_name_get(Ecore_Con_Server *sv EAPI Eina_Bool ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore_Con_Type compl_type); /** - * @brief Upgrade a connection to a specified level of encryption + * @brief Upgrades a connection to a specified level of encryption. * * Use this function to begin an SSL handshake on a connection (STARTTLS or similar). * Once the upgrade has been completed, an ECORE_CON_EVENT_CLIENT_UPGRADE event will be emitted. * The connection should be treated as disconnected until the next event. - * @param cl The client object + * @param cl The client object. * @param ssl_type The SSL connection type (ONLY). * @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE. * @warning Setting a wrong value for @p compl_type WILL mess up your program. @@ -1029,14 +1030,14 @@ EAPI Eina_Bool ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_ */ /** - * @brief Add a SOCKS v4 proxy to the proxy list + * @brief Adds a SOCKS v4 proxy to the proxy list. * * Use this to create (or return, if previously added) a SOCKS proxy * object which can be used by any ecore_con servers. - * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) - * @param port The port to connect to on the proxy - * @param username The username to use for the proxy (OPTIONAL) - * @return An allocated proxy object, or NULL on failure + * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.) + * @param port The port to connect to on the proxy. + * @param username The username to use for the proxy. (OPTIONAL) + * @return An allocated proxy object, or @c NULL on failure. * @note This object NEVER needs to be explicitly freed. * @since 1.2 * @@ -1047,14 +1048,14 @@ EAPI Eina_Bool ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_ EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, const char *username); /** - * @brief Find a SOCKS v4 proxy in the proxy list + * @brief Finds a SOCKS v4 proxy in the proxy list. * * Use this to determine if a SOCKS proxy was previously added by checking * the proxy list against the parameters given. - * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) + * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.) * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip - * @param username The username used for the proxy (OPTIONAL) - * @return true only if a proxy exists matching the given params + * @param username The username used for the proxy. (OPTIONAL) + * @return True only if a proxy exists matching the given params. * @note This function matches slightly more loosely than ecore_con_socks4_remote_add(), and * ecore_con_socks4_remote_add() should be used to return the actual object. * @since 1.2 @@ -1066,13 +1067,13 @@ EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, cons EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, const char *username); /** - * @brief Remove a SOCKS v4 proxy from the proxy list and delete it + * @brief Removes a SOCKS v4 proxy from the proxy list and delete it. * * Use this to remove a SOCKS proxy from the proxy list by checking * the list against the parameters given. The proxy will then be deleted. - * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) + * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.) * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip - * @param username The username used for the proxy (OPTIONAL) + * @param username The username used for the proxy. (OPTIONAL) * @note This function matches in the same way as ecore_con_socks4_remote_exists(). * @warning Be aware that deleting a proxy which is being used WILL ruin your life. * @since 1.2 @@ -1084,15 +1085,15 @@ EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, c EAPI void ecore_con_socks4_remote_del(const char *ip, int port, const char *username); /** - * @brief Add a SOCKS v5 proxy to the proxy list + * @brief Adds a SOCKS v5 proxy to the proxy list. * * Use this to create (or return, if previously added) a SOCKS proxy * object which can be used by any ecore_con servers. - * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) - * @param port The port to connect to on the proxy - * @param username The username to use for the proxy (OPTIONAL) - * @param password The password to use for the proxy (OPTIONAL) - * @return An allocated proxy object, or NULL on failure + * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.) + * @param port The port to connect to on the proxy. + * @param username The username to use for the proxy. (OPTIONAL) + * @param password The password to use for the proxy. (OPTIONAL) + * @return An allocated proxy object, or @c NULL on failure. * @note This object NEVER needs to be explicitly freed. * @since 1.2 * @@ -1103,15 +1104,15 @@ EAPI void ecore_con_socks4_remote_del(const char *ip, int port, cons EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, const char *username, const char *password); /** - * @brief Find a SOCKS v5 proxy in the proxy list + * @brief Finds a SOCKS v5 proxy in the proxy list. * * Use this to determine if a SOCKS proxy was previously added by checking * the proxy list against the parameters given. - * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) + * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.) * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip - * @param username The username used for the proxy (OPTIONAL) - * @param password The password used for the proxy (OPTIONAL) - * @return true only if a proxy exists matching the given params + * @param username The username used for the proxy. (OPTIONAL) + * @param password The password used for the proxy. (OPTIONAL) + * @return True only if a proxy exists matching the given params. * @note This function matches slightly more loosely than ecore_con_socks5_remote_add(), and * ecore_con_socks5_remote_add() should be used to return the actual object. * @since 1.2 @@ -1123,14 +1124,14 @@ EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, cons EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, const char *username, const char *password); /** - * @brief Remove a SOCKS v5 proxy from the proxy list and delete it + * @brief Removes a SOCKS v5 proxy from the proxy list and delete it. * * Use this to remove a SOCKS proxy from the proxy list by checking * the list against the parameters given. The proxy will then be deleted. - * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) + * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.) * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip - * @param username The username used for the proxy (OPTIONAL) - * @param password The password used for the proxy (OPTIONAL) + * @param username The username used for the proxy. (OPTIONAL) + * @param password The password used for the proxy. (OPTIONAL) * @note This function matches in the same way as ecore_con_socks4_remote_exists(). * @warning Be aware that deleting a proxy which is being used WILL ruin your life. * @since 1.2 @@ -1142,15 +1143,15 @@ EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, c EAPI void ecore_con_socks5_remote_del(const char *ip, int port, const char *username, const char *password); /** - * @brief Set DNS lookup mode on an existing SOCKS proxy + * @brief Sets DNS lookup mode on an existing SOCKS proxy. * * According to RFC, SOCKS v4 does not require that a proxy perform * its own DNS lookups for addresses. SOCKS v4a specifies the protocol * for this. SOCKS v5 allows DNS lookups. * If you want to enable remote DNS lookup and are sure that your * proxy supports it, use this function. - * @param ecs The proxy object - * @param enable If true, the proxy will perform the dns lookup + * @param ecs The proxy object. + * @param enable If true, the proxy will perform the dns lookup. * @note By default, this setting is DISABLED. * @since 1.2 * @@ -1161,14 +1162,14 @@ EAPI void ecore_con_socks5_remote_del(const char *ip, int port, cons EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool enable); /** - * @brief Get DNS lookup mode on an existing SOCKS proxy + * @brief Gets DNS lookup mode on an existing SOCKS proxy. * * According to RFC, SOCKS v4 does not require that a proxy perform * its own DNS lookups for addresses. SOCKS v4a specifies the protocol * for this. SOCKS v5 allows DNS lookups. * This function returns whether lookups are enabled on a proxy object. - * @param ecs The proxy object - * @return If true, the proxy will perform the dns lookup + * @param ecs The proxy object. + * @return If true, the proxy will perform the dns lookup. * @note By default, this setting is DISABLED. * @since 1.2 * @@ -1179,12 +1180,12 @@ EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs); /** - * @brief Enable bind mode on a SOCKS proxy + * @brief Enables bind mode on a SOCKS proxy. * * Use this function to enable binding a remote port for use with a remote server. * For more information, see http://ufasoft.com/doc/socks4_protocol.htm - * @param ecs The proxy object - * @param is_bind If true, the connection established will be a port binding + * @param ecs The proxy object. + * @param is_bind If true, the connection established will be a port binding. * @warning Be aware that changing the operation mode of an active proxy may result in undefined behavior * @since 1.2 * @@ -1195,12 +1196,12 @@ EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs); EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool is_bind); /** - * @brief Return bind mode of a SOCKS proxy + * @brief Returns bind mode of a SOCKS proxy. * * Use this function to return bind mode of a proxy (binding a remote port for use with a remote server). * For more information, see http://ufasoft.com/doc/socks4_protocol.htm - * @param ecs The proxy object - * @return If true, the connection established will be a port binding + * @param ecs The proxy object. + * @return If true, the connection established will be a port binding. * @since 1.2 * * @if MOBILE @since_tizen 3.0 @@ -1210,11 +1211,11 @@ EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool i EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs); /** - * @brief Return SOCKS version of a SOCKS proxy + * @brief Returns SOCKS version of a SOCKS proxy. * - * Use this function to return the SOCKS protocol version of a proxy - * @param ecs The proxy object - * @return 0 on error, else 4/5 + * Use this function to return the SOCKS protocol version of a proxy. + * @param ecs The proxy object. + * @return @c 0 on error, else @c 4/5 * @since 1.2 * * @if MOBILE @since_tizen 3.0 @@ -1224,7 +1225,7 @@ EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs); EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs); /** - * @brief Remove a SOCKS v4 proxy from the proxy list and delete it + * @brief Removes a SOCKS v4 proxy from the proxy list and delete it. * * Use this to remove a SOCKS proxy from the proxy list by directly deleting the object given. * @param ecs The proxy object to delete @@ -1238,7 +1239,7 @@ EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs); EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs); /** - * @brief Set a proxy object to be used with the next server created with ecore_con_server_connect() + * @brief Sets a proxy object to be used with the next server created with ecore_con_server_connect(). * * This function sets a proxy for the next ecore_con connection. After the next server is created, * the proxy will NEVER be applied again unless explicitly enabled. @@ -1253,19 +1254,19 @@ EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs); EAPI void ecore_con_socks_apply_once(Ecore_Con_Socks *ecs); /** - * @brief Set a proxy object to be used with all servers created with ecore_con_server_connect() + * @brief Sets a proxy object to be used with all servers created with ecore_con_server_connect(). * * This function sets a proxy for all ecore_con connections. It will always be used. - * @param ecs The proxy object - * @see ecore_con_socks_apply_once() + * @param ecs The proxy object. + * @see ecore_con_socks_apply_once(). * @since 1.2 * @note ecore-con supports setting this through environment variables like so: * ECORE_CON_SOCKS_V4=[user@]server-port:lookup * ECORE_CON_SOCKS_V5=[user@]server-port:lookup * user is the OPTIONAL string that would be passed to the proxy as the username - * server is the IP_ADDRESS of the proxy server - * port is the port to connect to on the proxy server - * lookup is 1 if the proxy should perform all DNS lookups, otherwise 0 or omitted + * server is the IP_ADDRESS of the proxy server. + * port is the port to connect to on the proxy server. + * lookup is 1 if the proxy should perform all DNS lookups, otherwise 0 or omitted. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -1347,15 +1348,15 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs); */ /** - * @brief Create a server to listen for connections. + * @brief Creates a server to listen for connections. * * @param type The connection type. - * @param name Name to associate with the socket. It is used when + * @param name Name to associate with the socket. It is used when * generating the socket name of a Unix socket, or for * determining what host to listen on for TCP sockets. * @c NULL will not be accepted. - * @param port Number to identify socket. When a Unix socket is used, - * it becomes part of the socket name. When a TCP socket + * @param port Number to identify socket. When a Unix socket is used, + * it becomes part of the socket name. When a TCP socket * is used, it is used as the TCP port. * @param data Data to associate with the created Ecore_Con_Server * object. @@ -1391,14 +1392,14 @@ EAPI Ecore_Con_Server *ecore_con_server_add(Ecore_Con_Type type, const void *data); /** - * @brief Create a connection to the specified server and return an associated object. + * @brief Creates a connection to the specified server and return an associated object. * * @param type The connection type. * @param name Name used when determining what socket to connect to. * It is used to generate the socket name when the socket - * is a Unix socket. It is used as the hostname when + * is a Unix socket. It is used as the hostname when * connecting with a TCP socket. - * @param port Number to identify the socket to connect to. Used when + * @param port Number to identify the socket to connect to. Used when * generating the socket name for a Unix socket, or as the * TCP port when connecting to a TCP socket. * @param data Data to associate with the created Ecore_Con_Server @@ -1411,9 +1412,9 @@ EAPI Ecore_Con_Server *ecore_con_server_add(Ecore_Con_Type type, * if that is not set, then from HOME, even if this is not set, then from * TMPDIR. If none is set, then path would be /tmp. From this path the * function would connect to socket at "[path]/.ecore/[name]/[port]". If - * port is negetive, then to socket at "[path]/.ecore/[name]". + * port is negative, then to socket at "[path]/.ecore/[name]". * @li If @a type is @c ECORE_CON_LOCAL_SYSTEM, the server will connect to - * Unix socket at "/tmp/.ecore_service|[name]|[port]". If port is negetive, + * Unix socket at "/tmp/.ecore_service|[name]|[port]". If port is negative, * then to Unix socket at "/tmp/.ecore_service|[name]". * @li If @a type is @c ECORE_CON_LOCAL_ABSTRACT, then port number is not * considered while connecting to socket. @@ -1444,7 +1445,7 @@ EAPI Ecore_Con_Server *ecore_con_server_connect(Ecore_Con_Type type, const char *name, int port, const void *data); /** - * @brief Close the connection and free the given server. + * @brief Closes the connection and free the given server. * * @param svr The given server. * @return Data associated with the server when it was created. @@ -1460,7 +1461,7 @@ EAPI Ecore_Con_Server *ecore_con_server_connect(Ecore_Con_Type type, EAPI void * ecore_con_server_del(Ecore_Con_Server *svr); /** - * @brief Retrieve the data associated with the given server. + * @brief Retrieves the data associated with the given server. * * @param svr The given server. * @return The associated data. @@ -1473,10 +1474,10 @@ EAPI void * ecore_con_server_del(Ecore_Con_Server *svr); */ EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr); /** - * @brief Set the data associated with the given server. + * @brief Sets the data associated with the given server. * * @param svr The given server. - * @param data The data to associate with @p svr + * @param data The data to associate with @p svr. * @return The previously associated data, if any. * * @see ecore_con_server_data_get() @@ -1488,7 +1489,7 @@ EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr); EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr, void *data); /** - * @brief Retrieve whether the given server is currently connected. + * @brief Retrieves whether the given server is currently connected. * * @param svr The given server. * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise. @@ -1500,7 +1501,7 @@ EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr, EAPI Eina_Bool ecore_con_server_connected_get(const Ecore_Con_Server *svr); /** - * @brief Retrieve the server port in use. + * @brief Retrieves the server port in use. * * @param svr The given server. * @return The server port in use. @@ -1513,11 +1514,11 @@ EAPI Eina_Bool ecore_con_server_connected_get(const Ecore_Con_Server *sv */ EAPI int ecore_con_server_port_get(const Ecore_Con_Server *svr); /** - * @brief Check how long a server has been connected + * @brief Checks how long a server has been connected. * * @param svr The server to check * @return The total time, in seconds, that the server has been - * connected/running + * connected/running. * * This function is used to find out the time that has been elapsed since * ecore_con_server_add() succeeded. @@ -1528,7 +1529,7 @@ EAPI int ecore_con_server_port_get(const Ecore_Con_Server *svr); */ EAPI double ecore_con_server_uptime_get(const Ecore_Con_Server *svr); /** - * @brief Send the given data to the given server. + * @brief Sends the given data to the given server. * * @param svr The given server. * @param data The given data. @@ -1552,7 +1553,7 @@ EAPI int ecore_con_server_send(Ecore_Con_Server *svr, const void *data, int size); /** - * @brief Set a limit on the number of clients that can be handled concurrently + * @brief Sets a limit on the number of clients that can be handled concurrently * by the given server, and a policy on what to do if excess clients try to * connect. * @@ -1562,7 +1563,7 @@ EAPI int ecore_con_server_send(Ecore_Con_Server *svr, * effectively disables the server. * @param reject_excess_clients Set to 1 to automatically disconnect * excess clients as soon as they connect if you are - * already handling client_limit clients. Set to 0 + * already handling client_limit clients. Set to 0 * (default) to just hold off on the "accept()" * system call until the number of active clients * drops. This causes the kernel to queue up to 4096 @@ -1582,7 +1583,7 @@ EAPI void ecore_con_server_client_limit_set(Ecore_Con_Server *svr, int client_limit, char reject_excess_clients); /** - * @brief Get the IP address of a server that has been connected to. + * @brief Gets the IP address of a server that has been connected to. * * @param svr The given server. * @return A pointer to an internal string that contains the IP address of @@ -1597,7 +1598,7 @@ EAPI void ecore_con_server_client_limit_set(Ecore_Con_Server *svr, */ EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr); /** - * @brief Flush all pending data to the given server. + * @brief Flushes all pending data to the given server. * * @param svr The given server. * @@ -1612,10 +1613,10 @@ EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr); */ EAPI void ecore_con_server_flush(Ecore_Con_Server *svr); /** - * @brief Set the default time after which an inactive client will be disconnected + * @brief Sets the default time after which an inactive client will be disconnected. * - * @param svr The server object - * @param timeout The timeout, in seconds, to disconnect after + * @param svr The server object. + * @param timeout The timeout, in seconds, to disconnect after. * * This function is used by the server to set the default idle timeout on * clients. If the any of the clients becomes idle for a time higher than this @@ -1635,10 +1636,10 @@ EAPI void ecore_con_server_flush(Ecore_Con_Server *svr); */ EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, double timeout); /** - * @brief Get the default time after which an inactive client will be disconnected + * @brief Gets the default time after which an inactive client will be disconnected. * - * @param svr The server object - * @return The timeout, in seconds, to disconnect after + * @param svr The server object. + * @return The timeout, in seconds, to disconnect after. * * This function is used to get the idle timeout for clients. A value of < 1 * means the idle timeout is disabled. @@ -1653,14 +1654,14 @@ EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, doubl EAPI double ecore_con_server_timeout_get(const Ecore_Con_Server *svr); /** - * @brief Get the fd that the server is connected to + * @brief Gets the fd that the server is connected to. * * @param svr The server object - * @return The fd, or -1 on failure + * @return The fd, or @c -1 on failure * * This function returns the fd which is used by the underlying server connection. * It should not be tampered with unless you REALLY know what you are doing. - * @note This function is only valid for servers created with ecore_con_server_connect() + * @note This function is only valid for servers created with ecore_con_server_connect(). * @warning Seriously. Don't use this unless you know what you are doing. * @since 1.1 * @@ -1671,10 +1672,10 @@ EAPI double ecore_con_server_timeout_get(const Ecore_Con_Server *svr) EAPI int ecore_con_server_fd_get(const Ecore_Con_Server *svr); /** - * @brief Get the fd that the client is connected to + * @brief Gets the fd that the client is connected to. * * @param cl The client object - * @return The fd, or -1 on failure + * @return The fd, or @c -1 on failure * * This function returns the fd which is used by the underlying client connection. * It should not be tampered with unless you REALLY know what you are doing. @@ -1710,7 +1711,7 @@ EAPI int ecore_con_client_fd_get(const Ecore_Con_Client *cl); */ /** - * @brief Send the given data to the given client. + * @brief Sends the given data to the given client. * * @param cl The given client. * @param data The given data. @@ -1734,7 +1735,7 @@ EAPI int ecore_con_client_send(Ecore_Con_Client *cl, const void *data, int size); /** - * @brief Close the connection and free memory allocated to the given client. + * @brief Closes the connection and free memory allocated to the given client. * * @param cl The given client. * @return Data associated with the client. @@ -1745,7 +1746,7 @@ EAPI int ecore_con_client_send(Ecore_Con_Client *cl, */ EAPI void * ecore_con_client_del(Ecore_Con_Client *cl); /** - * @brief Set the data associated with the given client to @p data. + * @brief Sets the data associated with the given client to @p data. * * @param cl The given client. * @param data What to set the data to. @@ -1757,7 +1758,7 @@ EAPI void * ecore_con_client_del(Ecore_Con_Client *cl); EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl, const void *data); /** - * @brief Retrieve the data associated with the given client. + * @brief Retrieves the data associated with the given client. * * @param cl The given client. * @return The data associated with @p cl. @@ -1769,7 +1770,7 @@ EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl, EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl); /** - * @brief Get the IP address of a client that has connected. + * @brief Gets the IP address of a client that has connected. * * @param cl The given client. * @return A pointer to an internal string that contains the IP address of @@ -1784,7 +1785,7 @@ EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl); */ EAPI const char * ecore_con_client_ip_get(const Ecore_Con_Client *cl); /** - * @brief Flush all pending data to the given client. + * @brief Flushes all pending data to the given client. * * @param cl The given client. * @@ -1799,7 +1800,7 @@ EAPI const char * ecore_con_client_ip_get(const Ecore_Con_Client *cl); */ EAPI void ecore_con_client_flush(Ecore_Con_Client *cl); /** - * @brief Check how long a client has been connected + * @brief Checks how long a client has been connected. * * @param cl The client to check * @return The total time, in seconds, that the client has been connected to @@ -1813,11 +1814,11 @@ EAPI void ecore_con_client_flush(Ecore_Con_Client *cl); */ EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl); /** - * @brief Get the default time after which the client will be disconnected when - * inactive + * @brief Gets the default time after which the client will be disconnected when + * inactive. * - * @param cl The client object - * @return The timeout, in seconds, to disconnect after + * @param cl The client object. + * @return The timeout, in seconds, to disconnect after. * * This function is used to get the idle timeout for a client. A value of < 1 * means the idle timeout is disabled. @@ -1830,7 +1831,7 @@ EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl); */ EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl); /** - * @brief Set the time after which the client will be disconnected when inactive + * @brief Sets the time after which the client will be disconnected when inactive. * * @param cl The client object * @param timeout The timeout, in seconds, to disconnect after @@ -1854,7 +1855,7 @@ EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl); */ EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double timeout); /** - * @brief Return whether the client is still connected + * @brief Returns whether the client is still connected. * * @param cl The given client. * @return @c EINA_TRUE if connected, @c EINA_FALSE otherwise. @@ -1865,10 +1866,10 @@ EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double */ EAPI Eina_Bool ecore_con_client_connected_get(const Ecore_Con_Client *cl); /** - * @brief Return the port that the client has connected to + * @brief Returns the port that the client has connected to. * * @param cl The client - * @return The port that @p cl has connected to, or -1 on error + * @return The port that @p cl has connected to, or @c -1 on error * Use this function to return the port on which a given client has connected. * * @if MOBILE @since_tizen 3.0 @@ -1995,9 +1996,9 @@ typedef enum _Ecore_Con_Url_Http_Version } Ecore_Con_Url_Http_Version; /** - * @brief Change the HTTP version used for the request + * @brief Changes the HTTP version used for the request. * @param url_con Connection object through which the request will be sent. - * @param version The version to be used + * @param version The version to be used. * @return @c EINA_TRUE on success, @c EINA_FALSE on failure to change version. * @since 1.2 * @see ecore_con_url_pipeline_get() @@ -2009,7 +2010,7 @@ typedef enum _Ecore_Con_Url_Http_Version EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ecore_Con_Url_Http_Version version); /** - * @brief Initialise the Ecore_Con_Url library. + * @brief Initializes the Ecore_Con_Url library. * @return Number of times the library has been initialised without being * shut down. * @@ -2023,7 +2024,7 @@ EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ec EAPI int ecore_con_url_init(void); /** - * @brief Shut down the Ecore_Con_Url library. + * @brief Shuts down the Ecore_Con_Url library. * @return Number of calls that still uses Ecore_Con_Url * * @note This function doesn't call ecore_con_shutdown(). You still need to call @@ -2036,7 +2037,7 @@ EAPI int ecore_con_url_init(void); EAPI int ecore_con_url_shutdown(void); /** - * @brief Enable or disable HTTP 1.1 pipelining. + * @brief Enables or disable HTTP 1.1 pipelining. * @param enable @c EINA_TRUE will turn it on, @c EINA_FALSE will disable it. * * Pipelining allows to send one request after another one, without having to @@ -2068,7 +2069,7 @@ EAPI void ecore_con_url_pipeline_set(Eina_Bool enable); EAPI Eina_Bool ecore_con_url_pipeline_get(void); /** - * @brief Create and initialize a new Ecore_Con_Url connection object. + * @brief Creates and initializes a new Ecore_Con_Url connection object. * * @param url URL that will receive requests. Can be changed using * ecore_con_url_url_set. @@ -2087,7 +2088,7 @@ EAPI Eina_Bool ecore_con_url_pipeline_get(void); */ EAPI Ecore_Con_Url * ecore_con_url_new(const char *url); /** - * @brief Create a custom connection object. + * @brief Creates a custom connection object. * * @param url URL that will receive requests * @param custom_request Custom request (e.g. GET, POST, HEAD, PUT, etc) @@ -2108,7 +2109,7 @@ EAPI Ecore_Con_Url * ecore_con_url_new(const char *url); EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url, const char *custom_request); /** - * @brief Destroy a Ecore_Con_Url connection object. + * @brief Destroys an Ecore_Con_Url connection object. * * @param url_con Connection object to free. * @@ -2121,7 +2122,7 @@ EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url, EAPI void ecore_con_url_free(Ecore_Con_Url *url_con); /** - * @brief Associate data with a connection object. + * @brief Associates data with a connection object. * * @param url_con Connection object to associate data. * @param data Data to be set. @@ -2138,7 +2139,7 @@ EAPI void ecore_con_url_free(Ecore_Con_Url *url_con); EAPI void ecore_con_url_data_set(Ecore_Con_Url *url_con, void *data); /** - * @brief Retrieve data associated with a Ecore_Con_Url connection object. + * @brief Retrieves data associated with a Ecore_Con_Url connection object. * * @param url_con Connection object to retrieve data from. * @@ -2155,7 +2156,7 @@ EAPI void ecore_con_url_data_set(Ecore_Con_Url *url_con, */ EAPI void * ecore_con_url_data_get(Ecore_Con_Url *url_con); /** - * @brief Add an additional header to the request connection object. + * @brief Adds an additional header to the request connection object. * * @param url_con Connection object * @param key Header key @@ -2179,7 +2180,7 @@ EAPI void ecore_con_url_additional_header_add(Ecore_Con_Url *url_co const char *key, const char *value); /** - * @brief Clean additional headers. + * @brief Cleans additional headers. * * @param url_con Connection object to clean additional headers. * @@ -2196,7 +2197,7 @@ EAPI void ecore_con_url_additional_header_add(Ecore_Con_Url *url_co */ EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url_con); /** - * @brief Retrieve headers from last request sent. + * @brief Retrieves headers from last request sent. * * @param url_con Connection object to retrieve response headers from. * @@ -2212,7 +2213,7 @@ EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url */ EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con); /** - * @brief Set up a file for receiving response data. + * @brief Sets up a file for receiving response data. * * @param url_con Connection object to set file * @param fd File descriptor associated with the file. A negative value will @@ -2231,7 +2232,7 @@ EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con */ EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd); /** - * @brief Retrieve the number of bytes received. + * @brief Retrieves the number of bytes received. * * Retrieve the number of bytes received on the last request of the given * connection object. @@ -2249,7 +2250,7 @@ EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd); */ EAPI int ecore_con_url_received_bytes_get(Ecore_Con_Url *url_con); /** - * @brief Set url_con to use http auth, with given username and password, "safely" or not. + * @brief Sets url_con to use http auth, with given username and password, "safely" or not. * * @param url_con Connection object to perform a request on, previously created * with ecore_con_url_new() or ecore_con_url_custom_new(). @@ -2271,7 +2272,7 @@ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con, const char *password, Eina_Bool safe); /** - * @brief Send a get request. + * @brief Sends a get request. * * @param url_con Connection object to perform a request on, previously created * @@ -2296,7 +2297,7 @@ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con, */ EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con); /** - * @brief Send a HEAD request. + * @brief Sends a HEAD request. * * @param url_con Connection object to perform a request on, previously created * @@ -2320,7 +2321,7 @@ EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con); */ EAPI Eina_Bool ecore_con_url_head(Ecore_Con_Url *url_con); /** - * @brief Send a post request. + * @brief Sends a post request. * * @param url_con Connection object to perform a request on, previously created * with ecore_con_url_new() or ecore_con_url_custom_new(). @@ -2355,7 +2356,7 @@ EAPI Eina_Bool ecore_con_url_post(Ecore_Con_Url *url_con, const void *data, long length, const char *content_type); /** - * @brief Set whether HTTP requests should be conditional, dependent on + * @brief Sets whether HTTP requests should be conditional, dependent on * modification time. * * @param url_con Ecore_Con_Url to act upon. @@ -2378,7 +2379,7 @@ EAPI void ecore_con_url_time(Ecore_Con_Url *url_con, double timestamp); /** - * @brief Upload a file to an ftp site. + * @brief Uploads a file to an ftp site. * * @param url_con The Ecore_Con_Url object to send with * @param filename The path to the file to send @@ -2400,7 +2401,7 @@ EAPI Eina_Bool ecore_con_url_ftp_upload(Ecore_Con_Url *url_con, const char *pass, const char *upload_dir); /** - * @brief Toggle libcurl's verbose output. + * @brief Toggles libcurl's verbose output. * * @param url_con Ecore_Con_Url instance which will be acted upon. * @param verbose Whether or not to enable libcurl's verbose output. @@ -2416,7 +2417,7 @@ EAPI Eina_Bool ecore_con_url_ftp_upload(Ecore_Con_Url *url_con, EAPI void ecore_con_url_verbose_set(Ecore_Con_Url *url_con, Eina_Bool verbose); /** - * @brief Enable or disable EPSV extension + * @brief Enables or disables EPSV extension. * @param url_con The Ecore_Con_Url instance which will be acted upon. * @param use_epsv Boolean to enable/disable the EPSV extension. * @@ -2428,7 +2429,7 @@ EAPI void ecore_con_url_ftp_use_epsv_set(Ecore_Con_Url *url_con, Eina_Bool use_epsv); /** - * @brief Enable the cookie engine for subsequent HTTP requests. + * @brief Enables the cookie engine for subsequent HTTP requests. * * @param url_con Ecore_Con_Url instance which will be acted upon. * @@ -2445,7 +2446,7 @@ EAPI void ecore_con_url_ftp_use_epsv_set(Ecore_Con_Url *url_con, */ EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con); /** - * @brief Control whether session cookies from previous sessions shall be loaded. + * @brief Controls whether session cookies from previous sessions shall be loaded. * * @param url_con Ecore_Con_Url instance which will be acted upon. * @param ignore If @c EINA_TRUE, ignore session cookies when loading cookies @@ -2471,7 +2472,7 @@ EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con); EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Url *url_con, Eina_Bool ignore); /** - * @brief Clear currently loaded cookies. + * @brief Clears currently loaded cookies. * @param url_con Ecore_Con_Url instance which will be acted upon. * * The cleared cookies are removed and will not be sent in subsequent HTTP @@ -2498,7 +2499,7 @@ EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Ur */ EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con); /** - * @brief Clear currently loaded session cookies. + * @brief Clears currently loaded session cookies. * * @param url_con Ecore_Con_Url instance which will be acted upon. * @@ -2531,7 +2532,7 @@ EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con); */ EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_con); /** - * @brief Add a file to the list of files from which to load cookies. + * @brief Adds a file to the list of files from which to load cookies. * * @param url_con Ecore_Con_Url instance which will be acted upon. * @param file_name Name of the file that will be added to the list. @@ -2563,7 +2564,7 @@ EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_co EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con, const char * const file_name); /** - * @brief Set the name of the file to which all current cookies will be written when + * @brief Sets the name of the file to which all current cookies will be written when * either cookies are flushed or Ecore_Con is shut down. * * @param url_con Ecore_Con_Url instance which will be acted upon. @@ -2590,7 +2591,7 @@ EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con, EAPI Eina_Bool ecore_con_url_cookies_jar_file_set(Ecore_Con_Url *url_con, const char * const cookiejar_file); /** - * @brief Write all current cookies to the cookie jar immediately. + * @brief Writes all current cookies to the cookie jar immediately. * * @param url_con Ecore_Con_Url instance which will be acted upon. * @@ -2614,7 +2615,7 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con, const char *ca_path); /** - * @brief Set HTTP proxy to use. + * @brief Sets HTTP proxy to use. * * The parameter should be a char * to a zero terminated string holding * the host name or dotted IP address. To specify port number in this string, @@ -2637,7 +2638,7 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con, EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy); /** - * @brief Set zero terminated username to use for proxy. + * @brief Sets zero terminated username to use for proxy. * * If socks protocol is used for proxy, protocol should be socks5 and above. * @@ -2657,7 +2658,7 @@ EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const char *username); /** - * @brief Set zero terminated password to use for proxy. + * @brief Sets zero terminated password to use for proxy. * * If socks protocol is used for proxy, protocol should be socks5 and above. * @@ -2677,7 +2678,7 @@ EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const ch EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const char *password); /** - * @brief Set timeout in seconds. + * @brief Sets timeout in seconds. * * The maximum time in seconds that you allow the ecore con url transfer * operation to take. Normally, name lookups can take a considerable time @@ -2698,7 +2699,7 @@ EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const ch EAPI void ecore_con_url_timeout_set(Ecore_Con_Url *url_con, double timeout); /** - * @brief Get the returned HTTP STATUS code + * @brief Gets the returned HTTP STATUS code. * * This is used to, at any time, try to return the status code for a transmission. * @param url_con Connection object diff --git a/src/lib/ecore_con/Ecore_Con_Eet.h b/src/lib/ecore_con/Ecore_Con_Eet.h index efac538..a13b719 100644 --- a/src/lib/ecore_con/Ecore_Con_Eet.h +++ b/src/lib/ecore_con/Ecore_Con_Eet.h @@ -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. @@ -78,7 +78,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 @@ -96,7 +96,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 @@ -114,7 +114,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. @@ -141,7 +141,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. @@ -156,7 +156,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. @@ -168,7 +168,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. @@ -183,7 +183,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. @@ -195,7 +195,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. @@ -211,7 +211,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. @@ -224,7 +224,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. @@ -240,7 +240,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. @@ -253,8 +253,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. * @@ -269,7 +269,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. @@ -282,7 +282,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. @@ -298,7 +298,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. @@ -311,7 +311,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. @@ -323,7 +323,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. @@ -335,7 +335,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. @@ -347,7 +347,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. @@ -360,7 +360,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. diff --git a/src/lib/ecore_con/Ecore_Con_Legacy.h b/src/lib/ecore_con/Ecore_Con_Legacy.h index 9ecb36c..9501317 100644 --- a/src/lib/ecore_con/Ecore_Con_Legacy.h +++ b/src/lib/ecore_con/Ecore_Con_Legacy.h @@ -19,7 +19,7 @@ typedef Eo Ecore_Con_Url; * ecore_con_url.eo.legacy.h *******************************************************************/ /** - * * Controls the URL to send the request to. + * @brief Controls the URL to send the request to. * @param[in] url The URL * * @if MOBILE @since_tizen 3.0 @@ -29,7 +29,7 @@ typedef Eo Ecore_Con_Url; EAPI Eina_Bool ecore_con_url_url_set(Ecore_Con_Url *obj, const char *url); /** - * * Controls the URL to send the request to. + * @brief Controls the URL to send the request to. * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 -- 2.7.4