enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

Cleanup Doxygen Warnings - ecore 2 

Files modified:
ecore/src/lib/ecore_evas/Ecore_Evas.h
ecore/src/lib/ecore_evas/ecore_evas_fb.c
ecore/src/lib/ecore_evas/ecore_evas_sdl.c
ecore/src/lib/ecore_evas/ecore_evas_util.c
ecore/src/lib/ecore_evas/ecore_evas_x.c
ecore/src/lib/ecore_fb/ecore_fb_li.c

SVN revision: 70422
This commit is contained in:
Jonas M. Gastal 2012-04-23 20:09:48 +00:00
parent 9080cd0a3a
commit d6350e7bc2
6 changed files with 139 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h
View File

@ -812,13 +812,12 @@ EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const
/**
* @brief Get the name and class of an Ecore_Evas' window
*
* @p ee The Ecore_Evas to query
* @p n A pointer to a string to place the name in.
* @p c A pointer to a string to place the class in.
*
* This function gets the name of @p ee into @p n, and its class into
* @p c.
*
* @param ee The Ecore_Evas to query.
* @param n A pointer to a string to place the name in.
* @param c A pointer to a string to place the class in.
* @see ecore_evas_name_class_set()
*/
EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c);
@ -1000,6 +999,7 @@ EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h);
* determine stacking and geometry of it for window managers
* that decorate windows.
*
* @param ee The Ecore_Evas from which to get the backing store.
* @see ecore_evas_ews_manager_set()
* @see ecore_evas_ews_evas_get()
* @since 1.1
@ -1010,6 +1010,7 @@ EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee);
* Calls the window to be deleted (freed), but can let user decide to
* forbid it by using ecore_evas_callback_delete_request_set()
*
* @param ee The Ecore_Evas for which window will be deleted.
* @since 1.1
*/
EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
@ -1871,6 +1872,8 @@ EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee);
/**
* Sets the engine to be used by the backing store engine.
*
* @param engine The engine to be set.
* @param options The options of the engine to be set.
* @return @c EINA_TRUE on success, @c EINA_FALSE if ews is already in use.
* @since 1.1
*/
@ -1879,6 +1882,10 @@ EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options
/**
* Reconfigure the backing store used.
*
* @param x The X coordinate to be used.
* @param y The Y coordinate to be used.
* @param w The width of the Ecore_Evas to setup.
* @param h The height of the Ecore_Evas to setup.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
* @since 1.1
*/
@ -1921,6 +1928,7 @@ EAPI Evas_Object *ecore_evas_ews_background_get(void);
* rectangle.
*
* @note previous object will be deleted!
* @param o The Evas_Object for which to set the background.
*/
EAPI void ecore_evas_ews_background_set(Evas_Object *o);

9
legacy/ecore/src/lib/ecore_evas/ecore_evas_fb.c
View File

@ -565,9 +565,12 @@ static Ecore_Evas_Engine_Func _ecore_fb_engine_func =
#endif
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Create Ecore_Evas using fb backend.
* @param disp_name The name of the display to be used.
* @param rotation The rotation to be used.
* @param w The width of the Ecore_Evas to be created.
* @param h The height of the Ecore_Evas to be created.
* @return The new Ecore_Evas.
*/
#ifdef BUILD_ECORE_EVAS_FB
EAPI Ecore_Evas *

9
legacy/ecore/src/lib/ecore_evas/ecore_evas_sdl.c
View File

@ -22,11 +22,10 @@
#include "ecore_evas_private.h"
#include "Ecore_Evas.h"
/**
** SDL only handle one window at a time. That's by definition, there is nothing wrong here.
**
**/
/*
* SDL only handle one window at a time. That's by definition, there is nothing wrong here.
*
*/
#if defined(BUILD_ECORE_EVAS_SOFTWARE_SDL) || defined(BUILD_ECORE_EVAS_OPENGL_SDL)
/* static char *ecore_evas_default_display = "0"; */

6
legacy/ecore/src/lib/ecore_evas/ecore_evas_util.c
View File

@ -412,6 +412,12 @@ _ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj)
*
* If there is a boolean storage provided, then it is marked with 1
* when this option is executed.
* @param parser This parameter isn't in use.
* @param desc This parameter isn't in use.
* @param str This parameter isn't in use.
* @param data The data to be used.
* @param storage The storage to be used.
* @return The function always return 1.
*/
unsigned char
ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Getopt *parser __UNUSED__, const Ecore_Getopt_Desc *desc __UNUSED__, const char *str __UNUSED__, void *data, Ecore_Getopt_Value *storage)

201
legacy/ecore/src/lib/ecore_evas/ecore_evas_x.c
View File

@ -2979,9 +2979,15 @@ _ecore_evas_x_flush_post(void *data, Evas *e __UNUSED__, void *event_info __UNUS
#endif
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Create Ecore_Evas using software x11.
* @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned.
* @param disp_name The name of the Ecore_Evas to be created.
* @param parent The parent of the Ecore_Evas to be created.
* @param x The X coordinate to be used.
* @param y The Y coordinate to be used.
* @param w The width of the Ecore_Evas to be created.
* @param h The height of the Ecore_Evas to be created.
* @return A handle to the created Ecore_Evas.
*/
#ifdef BUILD_ECORE_EVAS_SOFTWARE_X11
EAPI Ecore_Evas *
@ -3182,9 +3188,10 @@ ecore_evas_software_x11_new(const char *disp_name __UNUSED__, Ecore_X_Window par
#endif
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Get the window from Ecore_Evas using software x11.
* @note If ecore is not compiled with support to x11 then nothing is done and 0 is returned.
* @param ee The Ecore_Evas from which to get the window.
* @return The window of type Ecore_X_Window.
*/
#ifdef BUILD_ECORE_EVAS_SOFTWARE_X11
EAPI Ecore_X_Window
@ -3201,9 +3208,10 @@ ecore_evas_software_x11_window_get(const Ecore_Evas *ee __UNUSED__)
#endif
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Set the direct_resize of Ecore_Evas using software x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas in which to set direct resize.
* @param on Enables the resize of Ecore_Evas if equals EINA_TRUE, disables if equals EINA_FALSE.
*/
#ifdef BUILD_ECORE_EVAS_SOFTWARE_X11
EAPI void
@ -3237,9 +3245,10 @@ ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee __UNUSED__, Eina_Bool o
#endif
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Gets if the Ecore_Evas is being directly resized using software x11.
* @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned.
* @param ee The Ecore_Evas from which to get direct resize.
* @return EINA_TRUE if the resize was managed directly, otherwise return EINA_FALSE.
*/
#ifdef BUILD_ECORE_EVAS_SOFTWARE_X11
EAPI Eina_Bool
@ -3256,9 +3265,10 @@ ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee __UNUSED__)
#endif
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Add extra window on Ecore_Evas using software x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas on which to add the window.
* @param win The window to be added at the Ecore_Evas.
*/
#ifdef BUILD_ECORE_EVAS_SOFTWARE_X11
EAPI void
@ -3287,9 +3297,15 @@ ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee __UNUSED__, Ecore_
#endif
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Create Ecore_Evas using opengl x11.
* @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned.
* @param disp_name The name of the display of the Ecore_Evas to be created.
* @param parent The parent of the Ecore_Evas to be created.
* @param x The X coordinate to be used.
* @param y The Y coordinate to be used.
* @param w The width of the Ecore_Evas to be created.
* @param h The height of the Ecore_Evas to be created.
* @return The new Ecore_Evas.
*/
#ifdef BUILD_ECORE_EVAS_OPENGL_X11
EAPI Ecore_Evas *
@ -3419,9 +3435,10 @@ ecore_evas_gl_x11_options_new(const char *disp_name __UNUSED__, Ecore_X_Window p
#endif /* ! BUILD_ECORE_EVAS_OPENGL_X11 */
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Get the window from Ecore_Evas using opengl x11.
* @note If ecore is not compiled with support to x11 then nothing is done and 0 is returned.
* @param ee The Ecore_Evas from which to get the window.
* @return The window of type Ecore_X_Window of Ecore_Evas.
*/
#ifdef BUILD_ECORE_EVAS_OPENGL_X11
EAPI Ecore_X_Window
@ -3438,9 +3455,10 @@ ecore_evas_gl_x11_window_get(const Ecore_Evas *ee __UNUSED__)
#endif /* ! BUILD_ECORE_EVAS_OPENGL_X11 */
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Set direct_resize for Ecore_Evas using opengl x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas in which to set direct resize.
* @param on Enables the resize of Ecore_Evas if equals EINA_TRUE, disables if equals EINA_FALSE.
*/
#ifdef BUILD_ECORE_EVAS_OPENGL_X11
EAPI void
@ -3456,9 +3474,10 @@ ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee __UNUSED__, Eina_Bool on __UN
#endif /* ! BUILD_ECORE_EVAS_OPENGL_X11 */
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Gets if the Ecore_Evas is being directly resized using opengl x11.
* @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned.
* @param ee The Ecore_Evas from which to get direct resize.
* @return EINA_TRUE if the resize was managed directly, otherwise return EINA_FALSE.
*/
#ifdef BUILD_ECORE_EVAS_OPENGL_X11
EAPI Eina_Bool
@ -3475,9 +3494,10 @@ ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee __UNUSED__)
#endif /* ! BUILD_ECORE_EVAS_OPENGL_X11 */
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Add extra window on Ecore_Evas using opengl x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas for which to add the window.
* @param win The window to be added at the Ecore_Evas.
*/
#ifdef BUILD_ECORE_EVAS_OPENGL_X11
EAPI void
@ -3493,9 +3513,12 @@ ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee __UNUSED__, Ecore_X_Wind
#endif /* ! BUILD_ECORE_EVAS_OPENGL_X11 */
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Set the functions to be used before and after the swap callback.
* @note If ecore is not compiled with support to x11 then nothing is done and the function is returned.
* @param ee The Ecore_Evas for which to set the swap callback.
* @param data The data for which to set the swap callback.
* @param pre_cb The function to be called before the callback.
* @param post_cb The function to be called after the callback.
*/
#ifdef BUILD_ECORE_EVAS_OPENGL_X11
EAPI void
@ -3525,11 +3548,6 @@ ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Evas *ee __UNUSED__, vo
}
#endif /* ! BUILD_ECORE_EVAS_OPENGL_X11 */
/**
* To be documented.
*
* FIXME: To be fixed or maybe removed rather?
*/
EAPI Ecore_Evas *
ecore_evas_xrender_x11_new(const char *disp_name __UNUSED__, Ecore_X_Window parent __UNUSED__,
int x __UNUSED__, int y __UNUSED__, int w __UNUSED__, int h __UNUSED__)
@ -3537,52 +3555,38 @@ ecore_evas_xrender_x11_new(const char *disp_name __UNUSED__, Ecore_X_Window pare
return NULL;
}
/**
* To be documented.
*
* FIXME: To be fixed or maybe removed rather?
*/
EAPI Ecore_X_Window
ecore_evas_xrender_x11_window_get(const Ecore_Evas *ee __UNUSED__)
{
return 0;
}
/**
* To be documented.
*
* FIXME: To be fixed.
*/
EAPI void
ecore_evas_xrender_x11_direct_resize_set(Ecore_Evas *ee __UNUSED__, Eina_Bool on __UNUSED__)
{
}
/**
* To be documented.
*
* FIXME: To be fixed.
*/
EAPI Eina_Bool
ecore_evas_xrender_x11_direct_resize_get(const Ecore_Evas *ee __UNUSED__)
{
return 0;
}
/**
* To be documented.
*
* FIXME: To be fixed.
*/
EAPI void
ecore_evas_xrender_x11_extra_event_window_add(Ecore_Evas *ee __UNUSED__, Ecore_X_Window win __UNUSED__)
{
}
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Create Ecore_Evas using software 16 x11.
* @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned.
* @param disp_name The name of the display of the Ecore_Evas to be created.
* @param parent The parent of the Ecore_Evas to be created.
* @param x The X coordinate to be used.
* @param y The Y coordinate to be used.
* @param w The width of the Ecore_Evas to be created.
* @param h The height of the Ecore_Evas to be created.
* @return The new Ecore_Evas.
*/
#if BUILD_ECORE_EVAS_SOFTWARE_16_X11
EAPI Ecore_Evas *
@ -3736,9 +3740,10 @@ ecore_evas_software_x11_16_new(const char *disp_name __UNUSED__, Ecore_X_Window
#endif /* ! BUILD_ECORE_EVAS_SOFTWARE_16_X11 */
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Get the window from Ecore_Evas using software 16 x11.
* @note If ecore is not compiled with support to x11 then nothing is done and 0 is returned.
* @param ee The Ecore_Evas from which to get the window.
* @return The window of type Ecore_X_Window of Ecore_Evas.
*/
#if BUILD_ECORE_EVAS_SOFTWARE_16_X11
EAPI Ecore_X_Window
@ -3755,9 +3760,10 @@ ecore_evas_software_x11_16_window_get(const Ecore_Evas *ee __UNUSED__)
#endif /* ! BUILD_ECORE_EVAS_SOFTWARE_16_X11 */
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Set direct_resize for Ecore_Evas using software 16 x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas in which to set direct resize.
* @param on Enables the resize of Ecore_Evas if equals EINA_TRUE, disables if equals EINA_FALSE.
*/
#if BUILD_ECORE_EVAS_SOFTWARE_16_X11
EAPI void
@ -3791,9 +3797,10 @@ ecore_evas_software_x11_16_direct_resize_set(Ecore_Evas *ee __UNUSED__, Eina_Boo
#endif /* ! BUILD_ECORE_EVAS_SOFTWARE_16_X11 */
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Gets if the Ecore_Evas is being directly resized using software 16 x11.
* @note If ecore is not compiled with support to x11 then nothing is done and 0 is returned.
* @param ee The Ecore_Evas from which to get direct resize.
* @return EINA_TRUE if the resize was managed directly, otherwise return EINA_FALSE.
*/
#if BUILD_ECORE_EVAS_SOFTWARE_16_X11
EAPI Eina_Bool
@ -3810,9 +3817,10 @@ ecore_evas_software_x11_16_direct_resize_get(const Ecore_Evas *ee __UNUSED__)
#endif /* ! BUILD_ECORE_EVAS_SOFTWARE_16_X11 */
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Add extra window on Ecore_Evas using software 16 x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas on which to add the window.
* @param win The window to be added at the Ecore_Evas.
*/
#if BUILD_ECORE_EVAS_SOFTWARE_16_X11
EAPI void
@ -3842,9 +3850,15 @@ ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee __UNUSED__, Eco
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Create Ecore_Evas using software 8 x11.
* @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned.
* @param disp_name The name of the display of the Ecore_Evas to be created.
* @param parent The parent of the Ecore_Evas to be created.
* @param x The X coordinate to be used.
* @param y The Y coordinate to be used.
* @param w The width of the Ecore_Evas to be created.
* @param h The height of the Ecore_Evas to be created.
* @return The new Ecore_Evas.
*/
EAPI Ecore_Evas *
ecore_evas_software_x11_8_new(const char *disp_name, Ecore_X_Window parent,
@ -4055,9 +4069,10 @@ ecore_evas_software_x11_8_new(const char *disp_name, Ecore_X_Window parent,
}
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Get window from Ecore_Evas using software 8 x11.
* @note If ecore is not compiled with support to x11 then nothing is done and 0 is returned.
* @param ee The Ecore_Evas from which to get the window.
* @return The window of type Ecore_X_Window of Ecore_Evas.
*/
EAPI Ecore_X_Window
ecore_evas_software_x11_8_window_get(const Ecore_Evas *ee)
@ -4071,9 +4086,10 @@ ecore_evas_software_x11_8_window_get(const Ecore_Evas *ee)
}
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Get subwindow from Ecore_Evas using software 8 x11.
* @note If ecore is not compiled with support to x11 then nothing is done and 0 is returned.
* @param ee The Ecore_Evas from which to get the subwindow.
* @return The window of type Ecore_X_Window of Ecore_Evas.
*/
EAPI Ecore_X_Window
ecore_evas_software_x11_8_subwindow_get(const Ecore_Evas *ee)
@ -4087,9 +4103,10 @@ ecore_evas_software_x11_8_subwindow_get(const Ecore_Evas *ee)
}
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Set direct_size for Ecore_Evas using software 8 x11.
* @note If ecore is not compiled with support to x11 then nothing is done and the function is returned.
* @param ee The Ecore_Evas in which to set direct resize.
* @param on Enables the resize of Ecore_Evas if equals EINA_TRUE, disables if equals EINA_FALSE.
*/
EAPI void
ecore_evas_software_x11_8_direct_resize_set(Ecore_Evas *ee, Eina_Bool on)
@ -4122,9 +4139,10 @@ ecore_evas_software_x11_8_direct_resize_set(Ecore_Evas *ee, Eina_Bool on)
}
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Gets if the Ecore_Evas is being directly resized using software 8 x11.
* @note If ecore is not compiled with support to x11 then nothing is done and 0 is returned.
* @param ee The Ecore_Evas from which to get direct resize.
* @return EINA_TRUE if the resize was managed directly, otherwise return EINA_FALSE.
*/
EAPI Eina_Bool
ecore_evas_software_x11_8_direct_resize_get(const Ecore_Evas *ee)
@ -4138,9 +4156,10 @@ ecore_evas_software_x11_8_direct_resize_get(const Ecore_Evas *ee)
}
/**
* To be documented.
*
* FIXME: To be fixed.
* @brief Add extra window on Ecore_Evas using software 8 x11.
* @note If ecore is not compiled with support to x11 then nothing is done and the function is returned.
* @param ee The Ecore_Evas on which to add the window.
* @param win The window to be added at Ecore_Evas.
*/
EAPI void
ecore_evas_software_x11_8_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win)

2
legacy/ecore/src/lib/ecore_fb/ecore_fb_li.c
View File

@ -661,7 +661,7 @@ ecore_fb_input_device_name_get(Ecore_Fb_Input_Device *dev)
* @return The capability of the device.
*
* This function returns the capability of the device @p dev. If @p dev is
* @c NULL, this function returns #ECORE_FB_INPUT_DEVICE_CAP_NONE.
* @c NULL, this function returns ECORE_FB_INPUT_DEVICE_CAP_NONE.
*/
EAPI Ecore_Fb_Input_Device_Cap
ecore_fb_input_device_cap_get(Ecore_Fb_Input_Device *dev)