ecore: fix doxygen warnings
authorjihoon <jihoon@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Thu, 31 May 2012 00:18:38 +0000 (00:18 +0000)
committerjihoon <jihoon@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Thu, 31 May 2012 00:18:38 +0000 (00:18 +0000)
git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/ecore@71569 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

src/lib/ecore_evas/Ecore_Evas.h
src/lib/ecore_evas/ecore_evas_x.c
src/lib/ecore_x/xcb/ecore_xcb.c
src/lib/ecore_x/xlib/ecore_x.c

index 3e96e5e..248aedb 100644 (file)
@@ -216,6 +216,8 @@ EAPI Eina_Bool   ecore_evas_app_comp_sync_get(void);
 EAPI Eina_List  *ecore_evas_engines_get(void);
 /**
  * @brief Free list returned by ecore_evas_engines_get()
+ *
+ * @param engines list with engines names
  */
 EAPI void        ecore_evas_engines_free(Eina_List *engines);
 /**
index edf1c3a..0434c38 100644 (file)
@@ -3189,7 +3189,7 @@ ecore_evas_software_x11_new(const char *disp_name __UNUSED__, Ecore_X_Window par
 
 /**
  * @brief Get the window from Ecore_Evas using software x11.
- * @note If ecore is not compiled with support for x11 or if @ee was not
+ * @note If ecore is not compiled with support for x11 or if @ee was not
  * created with ecore_evas_software_x11_new() then nothing is done and
  * 0 is returned.
  * @param ee The Ecore_Evas from which to get the window.
@@ -3439,7 +3439,7 @@ ecore_evas_gl_x11_options_new(const char *disp_name __UNUSED__, Ecore_X_Window p
 
 /**
  * @brief Get the window from Ecore_Evas using opengl x11.
- * @note If ecore is not compiled with support for x11 or if @ee was not
+ * @note If ecore is not compiled with support for x11 or if @ee was not
  * created with ecore_evas_gl_x11_new() then nothing is done and
  * 0 is returned.
  * @param ee The Ecore_Evas from which to get the window.
@@ -3747,7 +3747,7 @@ ecore_evas_software_x11_16_new(const char *disp_name __UNUSED__, Ecore_X_Window
 
 /**
  * @brief Get the window from Ecore_Evas using software 16 x11.
- * @note If ecore is not compiled with support for x11 or if @ee was not
+ * @note If ecore is not compiled with support for x11 or if @ee was not
  * created with ecore_evas_software_x11_16_new() then nothing is done and
  * 0 is returned.
  * @param ee The Ecore_Evas from which to get the window.
@@ -4079,7 +4079,7 @@ ecore_evas_software_x11_8_new(const char *disp_name, Ecore_X_Window parent,
 
 /**
  * @brief Get window from Ecore_Evas using software 8 x11.
- * @note If ecore is not compiled with support for x11 or if @ee was not
+ * @note If ecore is not compiled with support for x11 or if @ee was not
  * created with ecore_evas_software_x11_8_new() then nothing is done and
  * 0 is returned.
  * @param ee The Ecore_Evas from which to get the window.
@@ -4099,7 +4099,7 @@ ecore_evas_software_x11_8_window_get(const Ecore_Evas *ee)
 
 /**
  * @brief Get subwindow from Ecore_Evas using software 8 x11.
- * @note If ecore is not compiled with support for x11 or if @ee was not
+ * @note If ecore is not compiled with support for x11 or if @ee was not
  * created with ecore_evas_software_x11_8_new() then nothing is done and
  * 0 is returned.
  * @param ee The Ecore_Evas from which to get the subwindow.
index 7bb2dff..9d8910d 100644 (file)
@@ -1308,14 +1308,14 @@ ecore_x_screen_index_get(const Ecore_X_Screen *screen)
 /**
  * Retrieves the screen based on index number.
  *
- * @param index The index that will be used to retrieve the screen.
+ * @param idx The index that will be used to retrieve the screen.
  * @return  The Ecore_X_Screen at this index.
  * @ingroup Ecore_X_Display_Attr_Group
  *
  * @since 1.1
  */
 EAPI Ecore_X_Screen *
-ecore_x_screen_get(int index)
+ecore_x_screen_get(int idx)
 {
    xcb_screen_iterator_t iter;
    int i = 0;
@@ -1325,7 +1325,7 @@ ecore_x_screen_get(int index)
    iter =
      xcb_setup_roots_iterator(xcb_get_setup(_ecore_xcb_conn));
    for (i = 0; iter.rem; xcb_screen_next(&iter), i++)
-     if (i == index) return iter.data;
+     if (i == idx) return iter.data;
 
    return NULL;
 }
index 96e49f1..6788d62 100644 (file)
@@ -813,7 +813,7 @@ ecore_x_screen_index_get(const Ecore_X_Screen *screen)
 /**
  * Retrieves the screen based on index number.
  *
- * @param index The index that will be used to retrieve the screen.
+ * @param idx The index that will be used to retrieve the screen.
  * @return  The Ecore_X_Screen at this index.
  * @ingroup Ecore_X_Display_Attr_Group
  *