ecore: remove doxygen warning messages

Change-Id: If48d5ef1f08b309b28b0fc6da60f1846d44a8be8

diff --git a/src/lib/ecore/Ecore_Common.h b/src/lib/ecore/Ecore_Common.h
index 69f8bc8..33a4023 100644 (file)
--- a/src/lib/ecore/Ecore_Common.h
+++ b/src/lib/ecore/Ecore_Common.h
@@ -192,6 +192,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.
+ *
  * @if MOBILE @since_tizen 2.3
  * @elseif WEARABLE @since_tizen 2.3.1
  * @endif
@@ -831,7 +833,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.
@@ -840,7 +843,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.
@@ -1966,7 +1969,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
@@ -1980,7 +1983,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.
  *
@@ -3299,7 +3302,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
@@ -3368,7 +3371,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

diff --git a/src/lib/ecore_buffer/Ecore_Buffer_Queue.h b/src/lib/ecore_buffer/Ecore_Buffer_Queue.h
index 0e7a242..b353cc0 100644 (file)
--- a/src/lib/ecore_buffer/Ecore_Buffer_Queue.h
+++ b/src/lib/ecore_buffer/Ecore_Buffer_Queue.h
@@ -195,6 +195,8 @@ EAPI int    ecore_buffer_queue_init(void);
  *
  * This closes the connection of Buffer Queue daemon, and Shut down Ecore_Buffer_Queue libraries.
  *
+ * @return How many times the lib has been initialized.
+ *
  * @see ecore_buffer_queue_init()
  *
  * @if MOBILE @since_tizen 2.4

diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h
index 3c24b86..7784e65 100644 (file)
--- a/src/lib/ecore_con/Ecore_Con.h
+++ b/src/lib/ecore_con/Ecore_Con.h
@@ -992,14 +992,14 @@ 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
  *
  * @if MOBILE @since_tizen 3.0
  * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
-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.
@@ -1010,14 +1010,14 @@ 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
  *
  * @if MOBILE @since_tizen 3.0
  * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
-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);
 
 /**
  * @}
@@ -1331,7 +1331,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

diff --git a/src/lib/ecore_con/Ecore_Con_Eet.h b/src/lib/ecore_con/Ecore_Con_Eet.h
index a13b719..18ec264 100644 (file)
--- a/src/lib/ecore_con/Ecore_Con_Eet.h
+++ b/src/lib/ecore_con/Ecore_Con_Eet.h
@@ -124,7 +124,7 @@ EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server);
  * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
-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.

diff --git a/src/lib/ecore_con/ecore_con_eet.c b/src/lib/ecore_con/ecore_con_eet.c
index c85e287..a33e30a 100644 (file)
--- a/src/lib/ecore_con/ecore_con_eet.c
+++ b/src/lib/ecore_con/ecore_con_eet.c
@@ -742,9 +742,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)
 {
-   eo_del(r);
+   eo_del(server);
 }
 
 EAPI void

diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index e9befa0..b0af682 100755 (executable)
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -138,11 +138,20 @@ typedef enum _Ecore_Evas_Engine_Type
    ECORE_EVAS_ENGINE_SOFTWARE_TBM,
 } 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.
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ */
 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
@@ -2688,6 +2697,7 @@ EAPI void        ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj,
  * @brief Unsets the Ecore_Evas cursor.
  *
  * @param ee The Ecore_Evas to unset the cursor.
+ * @return The cursor object.
  *
  * This function unsets the cursor from the Ecore_Evas, and returns the cursor
  * object. If the cursor was set from ecore_evas_cursor_set(), this function