ecore: remove doxygen warning messages

Summary:
remove doxygen warning messages
@fix

Reviewers: jpeg, cedric, woohyun

Reviewed By: jpeg

Differential Revision: https://phab.enlightenment.org/D5339
This commit is contained in:
Taehyub Kim 2017-10-18 17:32:00 +09:00 committed by Jean-Philippe Andre
parent 06eee29b76
commit 5360034675
6 changed files with 28 additions and 17 deletions

View File

@ -199,6 +199,8 @@ EAPI void ecore_main_loop_select_func_set(Ecore_Select_Function func);
* Gets the select function set by ecore_select_func_set(),
* or the native select function if none was set.
*
* @return A function which can be used to replace select() in the main loop.
*
*/
EAPI Ecore_Select_Function ecore_main_loop_select_func_get(void);
@ -747,7 +749,8 @@ EAPI int ecore_event_type_new(void);
/**
* @brief Forcefully flush all pending type without processing them
* @param Serie of Ecore_Event finished by ECORE_EVENT_NONE.
* @param type Ecore_Event.
* @param ... Serie of Ecore_Event finished by ECORE_EVENT_NONE.
*
* This function is to be called before calling ecore_shutdown() if any event
* has still a chance to be in the ecore event queue.
@ -756,7 +759,7 @@ EAPI void ecore_event_type_flush_internal(int type, ...);
/**
* @brief Forcefully flush all pending type without processing them
* @param Serie of Ecore_Event.
* @param ... Serie of Ecore_Event.
*
* This function is to be called before calling ecore_shutdown() if any event
* has still a chance to be in the ecore event queue.
@ -1662,7 +1665,7 @@ EAPI void ecore_loop_time_set(double t);
*
* @image html ecore_thread.png
* @image rtf ecore_thread.png
* @image latex ecore_thread.eps width=\textwidth
* @image latex ecore_thread.eps width=\\textwidth
*
* For larger tasks that may require continuous communication with the main
* program, the feedback workers provide the same functionality plus a way
@ -1676,7 +1679,7 @@ EAPI void ecore_loop_time_set(double t);
*
* @image html ecore_thread_feedback.png
* @image rtf ecore_thread_feedback.png
* @image latex ecore_thread_feedback.eps width=\textwidth
* @image latex ecore_thread_feedback.eps width=\\textwidth
*
* See an overview example in @ref ecore_thread_example_c.
*
@ -2804,7 +2807,7 @@ EAPI double ecore_animator_frametime_get(void);
* @note When not listed v1 and v2 have no effect.
*
* @image html ecore-pos-map.png
* @image latex ecore-pos-map.eps width=\textwidth
* @image latex ecore-pos-map.eps width=\\textwidth
*
* One way to use this would be:
* @code
@ -2869,7 +2872,7 @@ EAPI double ecore_animator_pos_map(double pos, Ecore_Pos_Map map, double v1, dou
* @note When not listed v has no effect.
*
* @image html ecore-pos-map.png
* @image latex ecore-pos-map.eps width=\textwidth
* @image latex ecore-pos-map.eps width=\\textwidth
*
* One way to use this would be:
* @code

View File

@ -189,6 +189,8 @@ EAPI int ecore_buffer_queue_init(void);
*
* @since 1.15
*
* @return How many times the lib has been initialized.
*
* This closes the connection of Buffer Queue daemon, and Shut down Ecore_Buffer_Queue libraries.
*
* @see ecore_buffer_queue_init()

View File

@ -857,10 +857,10 @@ EAPI const char *ecore_con_ssl_server_verify_name_get(Ecore_Con_Server *sv
* @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.
* @warning Setting a wrong value for @p compl_type WILL mess up your program.
* @warning Setting a wrong value for @p ssl_type WILL mess up your program.
* @since 1.1
*/
EAPI Eina_Bool ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore_Con_Type compl_type);
EAPI Eina_Bool ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore_Con_Type ssl_type);
/**
* @brief Upgrades a connection to a specified level of encryption.
@ -871,10 +871,10 @@ EAPI Eina_Bool ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore
* @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.
* @warning Setting a wrong value for @p ssl_type WILL mess up your program.
* @since 1.1
*/
EAPI Eina_Bool ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_Con_Type compl_type);
EAPI Eina_Bool ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_Con_Type ssl_type);
/**
* @}
@ -1132,7 +1132,7 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs);
* @endhtmlonly
*
* @image rtf ecore_con-client-server.png
* @image latex ecore_con-client-server.eps width=\textwidth
* @image latex ecore_con-client-server.eps width=\\textwidth
*
* Please notice the important difference between these two codes: the first is
* used for writing a @b server, while the second should be used for writing a

View File

@ -124,7 +124,7 @@ EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server);
* ecore_con_eet_client_new.
*
*/
EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece);
EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *server);
/**
* @brief Registers an @c Eet data descriptor on a Ecore_Con_Eet object.

View File

@ -743,9 +743,9 @@ ecore_con_eet_client_new(Ecore_Con_Server *server)
}
EAPI void
ecore_con_eet_server_free(Ecore_Con_Eet *r)
ecore_con_eet_server_free(Ecore_Con_Eet *server)
{
efl_del(r);
efl_del(server);
}
EAPI void

View File

@ -133,11 +133,17 @@ typedef enum _Ecore_Evas_Engine_Type
ECORE_EVAS_ENGINE_OPENGL_DRM
} Ecore_Evas_Engine_Type;
/**
* @enum _Ecore_Evas_Avoid_Damage_Type
* This option causes updates of the Ecore_Evas to be done on a pixmap, and
* then copied to the window, or the pixmap used directly on the window,
* depending on the setting.
*/
typedef enum _Ecore_Evas_Avoid_Damage_Type
{
ECORE_EVAS_AVOID_DAMAGE_NONE = 0,
ECORE_EVAS_AVOID_DAMAGE_EXPOSE = 1,
ECORE_EVAS_AVOID_DAMAGE_BUILT_IN = 2
ECORE_EVAS_AVOID_DAMAGE_NONE = 0, /**< every expose event triggers a new damage and consequently render of the affected area. The rendering of things happens directly on the window */
ECORE_EVAS_AVOID_DAMAGE_EXPOSE = 1, /**< there's a pixmap where everything is rendered into, and then copied to the window. On expose events, there's no need to render things again, just to copy the exposed region to the window */
ECORE_EVAS_AVOID_DAMAGE_BUILT_IN = 2 /**< there's the same pixmap as the previous one, but it is set as a "background pixmap" of the window. The rendered things appear directly on the window, with no need to copy anything, but would stay stored on the pixmap, so there's no need to render things again on expose events. This option can be faster than the previous one, but may lead to artifacts during resize of the window */
} Ecore_Evas_Avoid_Damage_Type;
typedef enum _Ecore_Evas_Object_Associate_Flags