From ae16eae6aac25476a840c1de866a8efe310d6391 Mon Sep 17 00:00:00 2001 From: Jee-Yong Um Date: Wed, 21 Sep 2016 20:19:17 +0900 Subject: [PATCH] efl: adjust documentation defgroups Signed-Off-By: Jee-Yong Um Change-Id: Id96702e2d0ab39ae15c73f500884a87947da5c45 --- doc/main.dox | 53 +++- src/lib/ecore/Ecore_Common.h | 2 + src/lib/ecore/Ecore_Legacy.h | 12 +- src/lib/ecore_audio/Ecore_Audio.h | 2 + src/lib/ecore_audio/ecore_audio_obj.h | 1 + src/lib/ecore_audio/ecore_audio_obj_in.h | 3 +- src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h | 3 +- src/lib/ecore_audio/ecore_audio_obj_in_tone.h | 1 + src/lib/ecore_audio/ecore_audio_obj_out.h | 3 +- src/lib/ecore_audio/ecore_audio_obj_out_pulse.h | 3 +- src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h | 1 + src/lib/ecore_audio/ecore_audio_private.h | 1 + src/lib/ecore_avahi/Ecore_Avahi.h | 2 + src/lib/ecore_fb/Ecore_Fb.h | 2 + src/lib/ecore_input/Ecore_Input.h | 2 +- src/lib/ecore_wayland/Ecore_Wayland.h | 122 ++++++++ src/lib/ecore_win32/Ecore_Win32.h | 2 + src/lib/ecore_x/Ecore_X.h | 2 + src/lib/ector/Ector.h | 1 + src/lib/edje/Edje_Common.h | 2 +- src/lib/eeze/Eeze.h | 11 + src/lib/eeze/Eeze_Disk.h | 1 + src/lib/eeze/Eeze_Net.h | 1 + src/lib/eeze/Eeze_Sensor.h | 2 + src/lib/efreet/Efreet_Mime.h | 1 + src/lib/efreet/Efreet_Trash.h | 1 + src/lib/efreet/efreet_base.h | 1 + src/lib/efreet/efreet_desktop.h | 1 + src/lib/efreet/efreet_icon.h | 1 + src/lib/efreet/efreet_menu.h | 1 + src/lib/efreet/efreet_private.h | 1 + src/lib/efreet/efreet_uri.h | 1 + src/lib/efreet/efreet_utils.h | 1 + src/lib/eina/eina_matrix.h | 359 +++++++++++++--------- src/lib/eina/eina_quad.h | 15 +- src/lib/eio/Eio.h | 2 + src/lib/eio/eio_model.h | 1 + src/lib/elocation/Elocation.h | 1 + src/lib/elua/Elua.h | 2 + src/lib/embryo/Embryo.h | 12 + src/lib/emile/Emile.h | 1 + src/lib/emile/emile_cipher.h | 1 + src/lib/emile/emile_compress.h | 1 + src/lib/emile/emile_image.h | 1 + src/lib/emotion/Emotion.h | 9 + src/lib/eo/Eo.h | 9 +- src/lib/eolian/Eolian.h | 1 + src/lib/ephysics/EPhysics.h | 7 + src/lib/escape/escape_libgen.h | 1 + src/lib/escape/escape_unistd.h | 1 + src/lib/escape/sys/mman.h | 1 + src/lib/ethumb/Ethumb.h | 4 + src/lib/ethumb_client/Ethumb_Client.h | 4 + src/lib/evas/Evas_Common.h | 2 + src/lib/evas/Evas_Eo.h | 24 +- src/lib/evas/Evas_Legacy.h | 2 + src/lib/evil/dirent.h | 1 + src/lib/evil/evil_dlfcn.h | 1 + src/lib/evil/evil_inet.h | 1 + src/lib/evil/evil_libgen.h | 1 + src/lib/evil/evil_locale.h | 1 + src/lib/evil/evil_main.h | 1 + src/lib/evil/evil_stdio.h | 1 + src/lib/evil/evil_stdlib.h | 1 + src/lib/evil/evil_string.h | 1 + src/lib/evil/evil_time.h | 1 + src/lib/evil/evil_unistd.h | 1 + src/lib/evil/pwd.h | 1 + src/lib/evil/sys/mman.h | 1 + 69 files changed, 556 insertions(+), 162 deletions(-) diff --git a/doc/main.dox b/doc/main.dox index 6ab3071..a5e0340 100644 --- a/doc/main.dox +++ b/doc/main.dox @@ -1,5 +1,20 @@ /** - * @mainpage Enlightenment Foundation Libraries (EFL) + * @defgroup EFL + * @ingroup CAPI_UI_FRAMEWORK + * + * @brief EFL is a collection of libraries that are independent or may build + * on top of each-other to provide useful features that complement + * an OS's existing environment, rather than wrap and abstract it, + * trying to be their own environment and OS in its entirety. + * + * This means that it expects you to use other system libraries and API's in + * conjunction with EFL libraries, to provide a whole working application or + * library, simply using EFL as a set of convenient pre-made libraries to + * accomplish a whole host of complex or painful tasks for you. + * + * See @ref EFL for more details. + * + * @page EFL * * The Enlightenment Project covers more than simple window management. It * also includes the EFL, or Enlightenment Foundation Libraries: a framework @@ -9,23 +24,24 @@ * @li @ref ecore_main operating system abstraction and integration. * @li @ref edje_main layout and theme library with super powers. * @li @ref eet_main binary data parser and serializer. - * @li @ref eeze_main hardware device manipulation and notification. - * @li @ref efreet_main freedesktop.org (xdg) menu and desktop integration. * @li @ref eina_main data types and low-level/basic abstractions. * @li @ref eio_main asynchronous input/output * @li @ref eldbus_main D-Bus integration. + * @li @ref evas_main drawing canvas. + * @internal + * @li @ref eeze_main hardware device manipulation and notification. + * @li @ref efreet_main freedesktop.org (xdg) menu and desktop integration. * @li @ref embryo_main embedded script language. * @li @ref emotion_main to play music and videos. * @li @ref eo_main generic object system. * @li @ref ephysics_main physics simulation integration and visual effects. * @li @ref escape_main playstation3 portability layer. * @li @ref ethumb_main to generate thumbnail images of files. - * @li @ref evas_main drawing canvas. * @li @ref evil_main microsoft windows portability layer. * @li @ref eolian_main an EO file parser and code generator. * @li @ref eina_cxx_main Eina C++ bindings. * @li @ref elocation_main awareness library. - * + * @endinternal */ /** @@ -153,97 +169,122 @@ */ /** + * @internal * @defgroup Eo + * @ingroup EFL * * @brief Generic object system. */ /** * @defgroup Evas + * @ingroup EFL * * @brief Drawing canvas. */ /** * @defgroup Eet + * @ingroup EFL * * @brief Binary data parser and serializer. */ /** * @defgroup Eina + * @ingroup EFL * * @brief Data types and low-level/basic abstractions. */ /** + * @internal * @defgroup Embryo + * @ingroup EFL * * @brief Embedded script language. */ /** + * @internal * @defgroup Evil + * @ingroup EFL * * @brief Microsoft Windows portability layer. */ /** + * @internal * @defgroup Escape + * @ingroup EFL * * @brief PlayStation3 portability layer. */ /** * @defgroup Ecore + * @ingroup EFL * * @brief Operating System Abstraction and Integration. */ /** * @defgroup Eio + * @ingroup EFL * * @brief Asynchronous input/output and file manipulation. */ /** * @defgroup Eldbus + * @ingroup EFL * * @brief D-Bus integration with EFL (Ecore). */ /** + * @internal * @defgroup Efreet + * @ingroup EFL * * @brief FreeDesktop.Org (XDG) menu and desktop integration. */ /** + * @internal * @defgroup Eeze + * @ingroup EFL * * @brief Hardware device manipulation and notification, wraps UDev and similar. */ /** * @defgroup Edje + * @ingroup EFL * * @brief Layout and theme library with super-powers. */ /** + * @internal * @defgroup Emotion + * @ingroup EFL * * @brief Plays music and videos. */ /** + * @internal * @defgroup Ethumb + * @ingroup EFL * * @brief Generates thumbnail images of files. */ - /** +/** + * @internal * @defgroup EPhysics + * @ingroup EFL * * @brief Physics simulation integration and visual effects. */ diff --git a/src/lib/ecore/Ecore_Common.h b/src/lib/ecore/Ecore_Common.h index d84332c..18be364 100644 --- a/src/lib/ecore/Ecore_Common.h +++ b/src/lib/ecore/Ecore_Common.h @@ -3194,6 +3194,8 @@ typedef Eo Ecore_Job; /**< A job handle */ */ /** + * @internal + * * @defgroup Ecore_Device_Group Ecore Device functions * @ingroup Ecore * diff --git a/src/lib/ecore/Ecore_Legacy.h b/src/lib/ecore/Ecore_Legacy.h index b457b97..c39cbec 100644 --- a/src/lib/ecore/Ecore_Legacy.h +++ b/src/lib/ecore/Ecore_Legacy.h @@ -3,7 +3,7 @@ extern "C" { #endif /** - * @ingroup Ecore_Poller_Group + * @addtogroup Ecore_Poller_Group * * @{ */ @@ -53,7 +53,7 @@ EAPI void *ecore_poller_del(Ecore_Poller *poller); */ /** - * @ingroup Ecore_Animator_Group + * @addtogroup Ecore_Animator_Group * * @{ */ @@ -160,7 +160,7 @@ EAPI void ecore_animator_thaw(Ecore_Animator *animator); */ /** - * @ingroup Ecore_Timer_Group + * @addtogroup Ecore_Timer_Group * * @{ */ @@ -223,7 +223,7 @@ EAPI void ecore_timer_thaw(Ecore_Timer *timer); */ /** - * @ingroup Ecore_Idle_Group + * @addtogroup Ecore_Idle_Group * * @{ */ @@ -309,7 +309,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter); */ /** - * @ingroup Ecore_Exe_Group + * @addtogroup Ecore_Exe_Group * * @{ */ @@ -321,7 +321,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter); */ /** - * @ingroup Ecore_Job_Group + * @addtogroup Ecore_Job_Group * * @{ */ diff --git a/src/lib/ecore_audio/Ecore_Audio.h b/src/lib/ecore_audio/Ecore_Audio.h index ec1f85b..1b66663 100644 --- a/src/lib/ecore_audio/Ecore_Audio.h +++ b/src/lib/ecore_audio/Ecore_Audio.h @@ -29,6 +29,8 @@ extern "C" #endif /** + * @internal + * * @defgroup Ecore_Audio_Group Ecore_Audio - Convenience audio API * @ingroup Ecore diff --git a/src/lib/ecore_audio/ecore_audio_obj.h b/src/lib/ecore_audio/ecore_audio_obj.h index ad5062b..917acc1 100644 --- a/src/lib/ecore_audio/ecore_audio_obj.h +++ b/src/lib/ecore_audio/ecore_audio_obj.h @@ -29,6 +29,7 @@ extern "C" #endif /** + * @internal * @defgroup ecore_audio_obj - Base Ecore_Audio object * @ingroup Ecore_Audio_Group * @{ diff --git a/src/lib/ecore_audio/ecore_audio_obj_in.h b/src/lib/ecore_audio/ecore_audio_obj_in.h index 9840de8..f9df45d 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_in.h +++ b/src/lib/ecore_audio/ecore_audio_obj_in.h @@ -29,6 +29,7 @@ extern "C" #endif /** + * @internal * @defgroup ecore_audio_obj_in - Ecore_Audio input object * @ingroup Ecore_Audio_Group * @{ @@ -42,4 +43,4 @@ extern "C" } #endif -#endif \ No newline at end of file +#endif 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 fb37b7c..ea689c6 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h +++ b/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h @@ -29,6 +29,7 @@ extern "C" #endif /** + * @internal * @defgroup ecore_audio_obj_in_sndfile - Ecore_Audio sndfile input * @ingroup Ecore_Audio_Group * @{ @@ -42,4 +43,4 @@ extern "C" } #endif -#endif \ No newline at end of file +#endif 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 bf6bee0..f0e36e0 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_in_tone.h +++ b/src/lib/ecore_audio/ecore_audio_obj_in_tone.h @@ -29,6 +29,7 @@ extern "C" #endif /** + * @internal * @defgroup ecore_audio_obj_in_tone - Ecore_Audio tone input * @ingroup Ecore_Audio_Group * @{ diff --git a/src/lib/ecore_audio/ecore_audio_obj_out.h b/src/lib/ecore_audio/ecore_audio_obj_out.h index e8d0819..8c61658 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_out.h +++ b/src/lib/ecore_audio/ecore_audio_obj_out.h @@ -29,6 +29,7 @@ extern "C" #endif /** + * @internal * @defgroup ecore_audio_obj_out - Ecore_Audio output object * @ingroup Ecore_Audio_Group * @{ @@ -42,4 +43,4 @@ extern "C" } #endif -#endif \ No newline at end of file +#endif 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 0e8ad1b..553c424 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h +++ b/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h @@ -29,6 +29,7 @@ extern "C" #endif /** + * @internal * @defgroup ecore_audio_obj_out_pulse - Ecore_Audio pulseaudio output * @ingroup Ecore_Audio_Group * @{ @@ -42,4 +43,4 @@ extern "C" } #endif -#endif \ No newline at end of file +#endif 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 0740cfc..2fc6604 100644 --- a/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h +++ b/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h @@ -29,6 +29,7 @@ extern "C" #endif /** + * @internal * @defgroup ecore_audio_obj_out_sndfile - Ecore_Audio sndfile output * @ingroup Ecore_Audio_Group * @{ diff --git a/src/lib/ecore_audio/ecore_audio_private.h b/src/lib/ecore_audio/ecore_audio_private.h index 13a7b6a..c6552df 100644 --- a/src/lib/ecore_audio/ecore_audio_private.h +++ b/src/lib/ecore_audio/ecore_audio_private.h @@ -63,6 +63,7 @@ extern int _ecore_audio_log_dom; #define CRI(...) EINA_LOG_DOM_CRIT(_ecore_audio_log_dom, __VA_ARGS__) /** + * @internal * @defgroup Ecore_Audio_Module_API_Group Ecore_Audio_Module_API - API for modules * @ingroup Ecore_Audio_Group * diff --git a/src/lib/ecore_avahi/Ecore_Avahi.h b/src/lib/ecore_avahi/Ecore_Avahi.h index 460ef80..e5da795 100644 --- a/src/lib/ecore_avahi/Ecore_Avahi.h +++ b/src/lib/ecore_avahi/Ecore_Avahi.h @@ -38,6 +38,8 @@ extern "C" { #endif /** + * @internal + * * @defgroup Ecore_Avahi_Group Ecore_Avahi - Avahi main loop integration function. * @ingroup Ecore * diff --git a/src/lib/ecore_fb/Ecore_Fb.h b/src/lib/ecore_fb/Ecore_Fb.h index 5a898f2..86b22b7 100644 --- a/src/lib/ecore_fb/Ecore_Fb.h +++ b/src/lib/ecore_fb/Ecore_Fb.h @@ -34,6 +34,8 @@ extern "C" { #endif /** + * @internal + * * @defgroup Ecore_FB_Group Ecore_FB - Frame buffer convenience functions. * @ingroup Ecore * diff --git a/src/lib/ecore_input/Ecore_Input.h b/src/lib/ecore_input/Ecore_Input.h index 06886fa..b44d07e 100644 --- a/src/lib/ecore_input/Ecore_Input.h +++ b/src/lib/ecore_input/Ecore_Input.h @@ -42,7 +42,7 @@ extern "C" { /** * @defgroup Ecore_Input_Group Ecore Input - * @ingroup Ecore_Group + * @ingroup Ecore * *@{ */ diff --git a/src/lib/ecore_wayland/Ecore_Wayland.h b/src/lib/ecore_wayland/Ecore_Wayland.h index 2e3bffd..b6d6e40 100644 --- a/src/lib/ecore_wayland/Ecore_Wayland.h +++ b/src/lib/ecore_wayland/Ecore_Wayland.h @@ -441,6 +441,8 @@ struct _Ecore_Wl_Event_Indicator_Flick }; /** + * @internal + * * @file * @brief Ecore functions for dealing with the Wayland window system * @@ -495,6 +497,8 @@ EAPI extern int ECORE_WL_EVENT_KEYMAP_UPDATE; EAPI extern int ECORE_WL_EVENT_INDICATOR_FLICK; /** + * @internal + * * @defgroup Ecore_Wl_Init_Group Wayland Library Init and Shutdown Functions * @ingroup Ecore_Wl_Group * @@ -502,6 +506,8 @@ EAPI extern int ECORE_WL_EVENT_INDICATOR_FLICK; */ /** + * @internal + * * Initialize the Wayland display connection to the given display. * * @param name Display target name. if @c NULL, the default display is @@ -514,6 +520,8 @@ EAPI extern int ECORE_WL_EVENT_INDICATOR_FLICK; EAPI int ecore_wl_init(const char *name); /** + * @internal + * * Shuts down the Ecore Wayland Library * * In shutting down the library, the Wayland display connection is terminated @@ -527,6 +535,8 @@ EAPI int ecore_wl_init(const char *name); EAPI int ecore_wl_shutdown(void); /** + * @internal + * * @defgroup Ecore_Wl_Flush_Group Wayland Synchronization Functions * @ingroup Ecore_Wl_Group * @@ -535,6 +545,8 @@ EAPI int ecore_wl_shutdown(void); */ /** + * @internal + * * Sends all Wayland commands to the Wayland Display. * * @ingroup Ecore_Wl_Flush_Group @@ -543,6 +555,8 @@ EAPI int ecore_wl_shutdown(void); EAPI void ecore_wl_flush(void); /** + * @internal + * * Flushes the command buffer and waits until all requests have been * processed by the server. * @@ -552,6 +566,8 @@ EAPI void ecore_wl_flush(void); EAPI void ecore_wl_sync(void); /** + * @internal + * * @defgroup Ecore_Wl_Display_Group Wayland Display Functions * @ingroup Ecore_Wl_Group * @@ -559,6 +575,8 @@ EAPI void ecore_wl_sync(void); */ /** + * @internal + * * Retrieves the Wayland Shm Interface used for the current Wayland connection. * * @return The current wayland shm interface, or NULL on error @@ -569,6 +587,8 @@ EAPI void ecore_wl_sync(void); EAPI struct wl_shm *ecore_wl_shm_get(void); /** + * @internal + * * Retrieves the Wayland Display Interface used for the current Wayland connection. * * @return The current wayland display interface, or NULL on error @@ -589,6 +609,8 @@ EAPI struct wl_display *ecore_wl_display_get(void); */ /** + * @internal + * * Retrieves the size of the current screen. * * @param w where to return the width. May be NULL. Returns 0 on error. @@ -600,6 +622,8 @@ EAPI struct wl_display *ecore_wl_display_get(void); EAPI void ecore_wl_screen_size_get(int *w, int *h); /** + * @internal + * * Retrieves the position of the current screen. * * @param x where to return the horizontal position. May be NULL. Returns 0 on error. @@ -611,6 +635,8 @@ EAPI void ecore_wl_screen_size_get(int *w, int *h); EAPI void ecore_wl_pointer_xy_get(int *x, int *y); /** + * @internal + * * Return the screen DPI * * This is a simplistic call to get DPI. It does not account for differing @@ -624,6 +650,8 @@ EAPI void ecore_wl_pointer_xy_get(int *x, int *y); EAPI int ecore_wl_dpi_get(void); /** + * @internal + * * Dispatch Wayland events * * Dispatches any events queued on the default queue. Wayland will attempt @@ -639,6 +667,8 @@ EAPI void ecore_wl_display_iterate(void); EAPI Eina_Bool ecore_wl_animator_source_set(Ecore_Animator_Source source); /** + * @internal + * * Retrieves the requested cursor from the cursor theme * * @param cursor_name The desired cursor name to be looked up in the theme @@ -649,6 +679,8 @@ EAPI Eina_Bool ecore_wl_animator_source_set(Ecore_Animator_Source source); EAPI struct wl_cursor *ecore_wl_cursor_get(const char *cursor_name); /** + * @internal + * * @defgroup Ecore_Wl_Input_Group Functions dealing with Wayland Input * @ingroup Ecore_Wl_Group * @@ -656,6 +688,8 @@ EAPI struct wl_cursor *ecore_wl_cursor_get(const char *cursor_name); */ /** + * @internal + * * @ingroup Ecore_Wl_Input_Group * @since 1.8 */ @@ -670,6 +704,8 @@ EAPI struct wl_seat *ecore_wl_input_seat_get(Ecore_Wl_Input *input); EAPI Eina_Inlist *ecore_wl_outputs_get(void); /** + * @internal + * * @ingroup Ecore_Wl_Input_Group * @since 1.12 */ @@ -684,6 +720,8 @@ EAPI struct xkb_keymap *ecore_wl_input_keymap_get(Ecore_Wl_Input *input); /** + * @internal + * * Retrieves the Wayland Globals Interface list used for the current Wayland connection. * * This call, if done after the ECORE_WL_EVENT_INTERFACES_BOUND event was @@ -703,6 +741,8 @@ EAPI struct xkb_keymap *ecore_wl_input_keymap_get(Ecore_Wl_Input *input); EAPI Eina_Inlist *ecore_wl_globals_get(void); /** + * @internal + * * Retrieves the Wayland Registry used for the current Wayland connection. * * @return The current wayland registry, or NULL on error @@ -713,6 +753,8 @@ EAPI Eina_Inlist *ecore_wl_globals_get(void); EAPI struct wl_registry *ecore_wl_registry_get(void); /** + * @internal + * * @defgroup Ecore_Wl_Window_Group Wayland Window functions. * @ingroup Ecore_Wl_Group * @@ -720,6 +762,8 @@ EAPI struct wl_registry *ecore_wl_registry_get(void); */ /** + * @internal + * * Creates a new window * * @param parent The parent window to use. If @p parent is @c 0, the root window @@ -738,6 +782,8 @@ EAPI struct wl_registry *ecore_wl_registry_get(void); EAPI Ecore_Wl_Window *ecore_wl_window_new(Ecore_Wl_Window *parent, int x, int y, int w, int h, int buffer_type); /** + * @internal + * * Deletes the given window * * @param win The given window @@ -748,6 +794,8 @@ EAPI Ecore_Wl_Window *ecore_wl_window_new(Ecore_Wl_Window *parent, int x, int y, EAPI void ecore_wl_window_free(Ecore_Wl_Window *win); /** + * @internal + * * Signals for Wayland to initiate a window move. * * The position requested (@p x, @p y) is not honored by Wayland because @@ -763,6 +811,8 @@ EAPI void ecore_wl_window_free(Ecore_Wl_Window *win); EAPI void ecore_wl_window_move(Ecore_Wl_Window *win, int x, int y); /** + * @internal + * * Signals for Wayland to initiate a window resize. * * The size requested (@p w, @p h) is not honored by Wayland because @@ -785,6 +835,8 @@ EAPI struct wl_compositor *ecore_wl_compositor_get(void); EAPI void ecore_wl_window_commit(Ecore_Wl_Window *win); /** + * @internal + * * Shows a window * * Synonymous to "mapping" a window in Wayland System terminology. @@ -797,6 +849,8 @@ EAPI void ecore_wl_window_commit(Ecore_Wl_Window *win); EAPI void ecore_wl_window_show(Ecore_Wl_Window *win); /** + * @internal + * * Hides a window * * Synonymous to "unmapping" a window in Wayland System terminology. @@ -809,6 +863,8 @@ EAPI void ecore_wl_window_show(Ecore_Wl_Window *win); EAPI void ecore_wl_window_hide(Ecore_Wl_Window *win); /** + * @internal + * * Raises a window * * @param win The window to raise. @@ -844,6 +900,8 @@ EAPI void ecore_wl_window_role_set(Ecore_Wl_Window *win, const char *role); EAPI int ecore_wl_window_active_angle_get(Ecore_Wl_Window *win); /** + * @internal + * * Iconify a window * * @param win The window to iconifiy @@ -866,6 +924,8 @@ EAPI Ecore_Wl_Input *ecore_wl_window_keyboard_get(Ecore_Wl_Window *win); EAPI void ecore_wl_window_stack_mode_set(Ecore_Wl_Window *win, Ecore_Wl_Window_Stack_Mode mode); /** + * @internal + * * Returns a wl_surface with no association to any wl_shell_surface. * * @param win The window which will use this newly created surface. @@ -880,6 +940,8 @@ EAPI void ecore_wl_window_alpha_set(Ecore_Wl_Window *win, Eina_Bool alpha); EAPI Eina_Bool ecore_wl_window_alpha_get(Ecore_Wl_Window *win); /** + * @internal + * * Returns the Ecore_Wl_Window from a wl_surface * * @param surface The surface for which to find the Ecore_Wl_Window from @@ -926,6 +988,8 @@ EAPI void ecore_wl_window_input_rect_add(Ecore_Wl_Window *win, Eina_Rectangle *i EAPI void ecore_wl_window_input_rect_subtract(Ecore_Wl_Window *win, Eina_Rectangle *input_rect); /** + * @internal + * * Set the input region of the Ecore_Wl_Window. * * To set an empty region, pass width and height as 0. @@ -944,6 +1008,8 @@ EAPI void ecore_wl_window_input_rect_subtract(Ecore_Wl_Window *win, Eina_Rectang EAPI void ecore_wl_window_input_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h); /** + * @internal + * * Set the opaque region of the Ecore_Wl_Window * * @param win The window @@ -958,6 +1024,8 @@ EAPI void ecore_wl_window_input_region_set(Ecore_Wl_Window *win, int x, int y, i EAPI void ecore_wl_window_opaque_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h); /** + * @internal + * * Set the rotation of the Ecore_Wl_Window * * @param win The window @@ -969,6 +1037,8 @@ EAPI void ecore_wl_window_opaque_region_set(Ecore_Wl_Window *win, int x, int y, EAPI void ecore_wl_window_rotation_set(Ecore_Wl_Window *win, int rotation); /** + * @internal + * * Get the rotation of the Ecore_Wl_Window * * @param win The window @@ -980,6 +1050,8 @@ EAPI void ecore_wl_window_rotation_set(Ecore_Wl_Window *win, int rotation); EAPI int ecore_wl_window_rotation_get(Ecore_Wl_Window *win); /** + * @internal + * * @defgroup Ecore_Wl_Dnd_Group Functions dealing with Wayland Drag-n-Drop * @ingroup Ecore_Wl_Group * @@ -987,36 +1059,48 @@ EAPI int ecore_wl_window_rotation_get(Ecore_Wl_Window *win); */ /** + * @internal + * * @deprecated use ecore_wl_dnd_selection_set * @since 1.7 */ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_set_selection(Ecore_Wl_Dnd *dnd, const char **types_offered); /** + * @internal + * * @deprecated use ecore_wl_dnd_selection_get * @since 1.7 */ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_get_selection(Ecore_Wl_Dnd *dnd, const char *type); /** + * @internal + * * @deprecated Do Not Use * @since 1.7 */ EINA_DEPRECATED EAPI Ecore_Wl_Dnd *ecore_wl_dnd_get(void); /** + * @internal + * * @deprecated use ecore_wl_dnd_drag_start * @since 1.7 */ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_start_drag(Ecore_Wl_Dnd *dnd); /** + * @internal + * * @deprecated use ecore_wl_dnd_selection_owner_has * @since 1.7 */ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_selection_has_owner(Ecore_Wl_Dnd *dnd); /** + * @internal + * * @return false on error, true otherwise * * @ingroup Ecore_Wl_Dnd_Group @@ -1025,6 +1109,8 @@ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_selection_has_owner(Ecore_Wl_Dnd *dn EAPI Eina_Bool ecore_wl_dnd_selection_set(Ecore_Wl_Input *input, const char **types_offered); /** + * @internal + * * @return false if type not found or on error, true otherwise * * @ingroup Ecore_Wl_Dnd_Group @@ -1033,6 +1119,8 @@ EAPI Eina_Bool ecore_wl_dnd_selection_set(Ecore_Wl_Input *input, const char **ty EAPI Eina_Bool ecore_wl_dnd_selection_get(Ecore_Wl_Input *input, const char *type); /** + * @internal + * * @return true if input has a selection source, false otherwise or on error * * @ingroup Ecore_Wl_Dnd_Group @@ -1041,6 +1129,8 @@ EAPI Eina_Bool ecore_wl_dnd_selection_get(Ecore_Wl_Input *input, const char *typ EAPI Eina_Bool ecore_wl_dnd_selection_owner_has(Ecore_Wl_Input *input); /** + * @internal + * * @return false on error, true otherwise * * @ingroup Ecore_Wl_Dnd_Group @@ -1049,18 +1139,24 @@ EAPI Eina_Bool ecore_wl_dnd_selection_owner_has(Ecore_Wl_Input *input); EAPI Eina_Bool ecore_wl_dnd_selection_clear(Ecore_Wl_Input *input); /** + * @internal + * * @ingroup Ecore_Wl_Dnd_Group * @since 1.8 */ EAPI void ecore_wl_dnd_drag_start(Ecore_Wl_Input *input, Ecore_Wl_Window *win, Ecore_Wl_Window *dragwin, int x, int y, int w, int h); /** + * @internal + * * @ingroup Ecore_Wl_Dnd_Group * @since 1.8 */ EAPI void ecore_wl_dnd_drag_end(Ecore_Wl_Input *input); /** + * @internal + * * @return false if type not found or on error, true otherwise * * @ingroup Ecore_Wl_Dnd_Group @@ -1069,12 +1165,16 @@ EAPI void ecore_wl_dnd_drag_end(Ecore_Wl_Input *input); EAPI Eina_Bool ecore_wl_dnd_drag_get(Ecore_Wl_Input *input, const char *type); /** + * @internal + * * @ingroup Ecore_Wl_Dnd_Group * @since 1.8 */ EAPI void ecore_wl_dnd_drag_types_set(Ecore_Wl_Input *input, const char **types_offered); /** + * @internal + * * @return the data types being offered for drag-and-drop, or NULL on error * * @ingroup Ecore_Wl_Dnd_Group @@ -1089,6 +1189,8 @@ EAPI struct wl_array *ecore_wl_dnd_drag_types_get(Ecore_Wl_Input *input); /* EAPI Ecore_Wl_Dnd_Source *ecore_wl_dnd_drag_source_create(Ecore_Wl_Dnd *dnd); */ /** + * @internal + * * Enable/disable server mode. * * With this enabled, the compositor acts as a Wayland server, iterating @@ -1100,6 +1202,8 @@ EAPI void ecore_wl_server_mode_set(Eina_Bool on); EAPI Eina_Bool ecore_wl_server_mode_get(void); /** + * @internal + * * @defgroup Ecore_Wl_Subsurf Functions to manipulate subsurfaces. * @ingroup Ecore_Wl_Group * @@ -1114,6 +1218,8 @@ EAPI Eina_Bool ecore_wl_server_mode_get(void); */ /** + * @internal + * * Create and return a new subsurface. * * Create a new surface (and subsurface interface), with the parent surface @@ -1131,6 +1237,8 @@ EAPI Eina_Bool ecore_wl_server_mode_get(void); EAPI Ecore_Wl_Subsurf *ecore_wl_subsurf_create(Ecore_Wl_Window *win); /** + * @internal + * * Destroy the given subsurface, as well as the surface associated with it. * * @param ess the subsurface @@ -1141,6 +1249,8 @@ EAPI Ecore_Wl_Subsurf *ecore_wl_subsurf_create(Ecore_Wl_Window *win); EAPI void ecore_wl_subsurf_del(Ecore_Wl_Subsurf *ess); /** + * @internal + * * Get the wl_surface for this subsurface * * @param ess the subsurface @@ -1152,6 +1262,8 @@ EAPI void ecore_wl_subsurf_del(Ecore_Wl_Subsurf *ess); EAPI struct wl_surface *ecore_wl_subsurf_surface_get(Ecore_Wl_Subsurf *ess); /** + * @internal + * * Set the position of this subsurface, relative to its parent surface. * If ess is defined and the x, y coordinates differ from the currently * tracked position, this also schedules a sub-surface position change. @@ -1166,6 +1278,8 @@ EAPI struct wl_surface *ecore_wl_subsurf_surface_get(Ecore_Wl_Subsurf *ess); EAPI void ecore_wl_subsurf_position_set(Ecore_Wl_Subsurf *ess, int x, int y); /** + * @internal + * * Get the position of this subsurface, relative to its parent surface. * Coordinates will be returned in x and y if non-NULL. * @@ -1179,6 +1293,8 @@ EAPI void ecore_wl_subsurf_position_set(Ecore_Wl_Subsurf *ess, int x, int y); EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y); /** + * @internal + * * Place subsurface on layer above a reference surface * * Moves the @param ess subsurface to just above the reference @param @@ -1195,6 +1311,8 @@ EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y); EAPI void ecore_wl_subsurf_place_above(Ecore_Wl_Subsurf *ess, struct wl_surface *surface); /** + * @internal + * * Place subsurface on layer below a reference surface * * See ecore_wl_subsurf_place_above. @@ -1208,6 +1326,8 @@ EAPI void ecore_wl_subsurf_place_above(Ecore_Wl_Subsurf *ess, struct wl_surface EAPI void ecore_wl_subsurf_place_below(Ecore_Wl_Subsurf *ess, struct wl_surface *surface); /** + * @internal + * * Enables or disables sub-surface synchronization * * When synchronization is enabled, surface commits on the subsurface @@ -1236,6 +1356,8 @@ EAPI void ecore_wl_subsurf_place_below(Ecore_Wl_Subsurf *ess, struct wl_surface EAPI void ecore_wl_subsurf_sync_set(Ecore_Wl_Subsurf *ess, Eina_Bool val); /** + * @internal + * * Set an opaque region for the given subsurface. * * This is an optimization hint to the compositor to allow it avoid diff --git a/src/lib/ecore_win32/Ecore_Win32.h b/src/lib/ecore_win32/Ecore_Win32.h index e30f01e..8e6c0ba 100644 --- a/src/lib/ecore_win32/Ecore_Win32.h +++ b/src/lib/ecore_win32/Ecore_Win32.h @@ -50,6 +50,8 @@ extern "C" { #endif /** + * @internal + * * @defgroup Ecore_Win32_Group Ecore_Win32 library * @ingroup Ecore * diff --git a/src/lib/ecore_x/Ecore_X.h b/src/lib/ecore_x/Ecore_X.h index 7337ae2..7d051f1 100644 --- a/src/lib/ecore_x/Ecore_X.h +++ b/src/lib/ecore_x/Ecore_X.h @@ -50,6 +50,8 @@ EAPI extern Ecore_X_Version *ecore_x_version; * @file * @brief Ecore functions for dealing with the X Windows System * + * @internal + * * @defgroup Ecore_X_Group Ecore_X - X11 Integration * @ingroup Ecore * diff --git a/src/lib/ector/Ector.h b/src/lib/ector/Ector.h index e08c2ed..334825b 100644 --- a/src/lib/ector/Ector.h +++ b/src/lib/ector/Ector.h @@ -36,6 +36,7 @@ extern "C" { #endif /** + * @internal * @page ector_main Ector * * @date 2014 (created) diff --git a/src/lib/edje/Edje_Common.h b/src/lib/edje/Edje_Common.h index d5f1c26..0d70053 100644 --- a/src/lib/edje/Edje_Common.h +++ b/src/lib/edje/Edje_Common.h @@ -2126,7 +2126,7 @@ EAPI const Edje_Perspective *edje_evas_global_perspective_get(const Evas *e); * affecting all the objects inside that have no particular perspective * set already. * - * @ingroup Edje_Audio + * @ingroup Edje * * @{ */ diff --git a/src/lib/eeze/Eeze.h b/src/lib/eeze/Eeze.h index 39096a0..93f9a5f 100644 --- a/src/lib/eeze/Eeze.h +++ b/src/lib/eeze/Eeze.h @@ -111,6 +111,7 @@ */ /** + * @internal * @defgroup Eeze_Main main * @ingroup Eeze * @@ -118,6 +119,7 @@ */ /** + * @internal * @defgroup Eeze_Udev udev * @ingroup Eeze_Main * @@ -125,6 +127,7 @@ */ /** + * @internal * @addtogroup Eeze_Udev * * These are the device subsystems of udev: @@ -191,6 +194,7 @@ extern "C" { #endif /** + * @internal * @addtogroup Eeze_Udev * @typedef Eeze_Udev_Event * @enum Eeze_Udev_Event @@ -218,6 +222,7 @@ typedef enum /** @} */ /** + * @internal * @addtogroup Eeze_Udev udev * @typedef Eeze_Udev_Type Eeze_Udev_Type * @enum Eeze_Udev_Type @@ -281,6 +286,7 @@ typedef enum struct Eeze_Udev_Watch; /** + * @internal * @addtogroup Eeze_Watch * @typedef Eeze_Udev_Watch Eeze_Udev_Watch * @brief Opaque structure to hold data for a udev watch @@ -304,6 +310,7 @@ typedef struct Eeze_Udev_Watch Eeze_Udev_Watch; EAPI extern Eeze_Version *eeze_version; /** + * @internal * @addtogroup Eeze_Watch * @typedef Eeze_Udev_Watch_Cb Eeze_Udev_Watch_Cb * @brief Callback type for use with #Eeze_Udev_Watch @@ -344,6 +351,7 @@ EAPI void *eeze_udev_get(void); /** + * @internal * @addtogroup Eeze_Find Find * * These are functions which find/supplement lists of devices. @@ -432,6 +440,7 @@ EAPI Eina_List *eeze_udev_find_by_subsystem_sysname(const char *subsystem, */ /** + * @internal * @addtogroup Eeze_Syspath Syspath * * These are functions which interact with the syspath (/sys/$PATH) of @@ -622,6 +631,7 @@ EAPI int eeze_udev_syspath_get_sysnum(const char *syspath); */ /** + * @internal * @addtogroup Eeze_Walks Walks * * These are functions which walk up the device chain. @@ -658,6 +668,7 @@ EAPI const char *eeze_udev_walk_get_sysattr(const char *syspath, const char */ /** + * @internal * @addtogroup Eeze_Watch Watch * * @brief These are functions which monitor udev for events. diff --git a/src/lib/eeze/Eeze_Disk.h b/src/lib/eeze/Eeze_Disk.h index 5497880..380324d 100644 --- a/src/lib/eeze/Eeze_Disk.h +++ b/src/lib/eeze/Eeze_Disk.h @@ -19,6 +19,7 @@ #endif /** + * @internal * @file Eeze_Disk.h * @brief Disk manipulation * @since 1.1 diff --git a/src/lib/eeze/Eeze_Net.h b/src/lib/eeze/Eeze_Net.h index 25bc27f..d88e50c 100644 --- a/src/lib/eeze/Eeze_Net.h +++ b/src/lib/eeze/Eeze_Net.h @@ -19,6 +19,7 @@ #endif /** + * @internal * @file Eeze_Net.h * @brief Network manipulation * diff --git a/src/lib/eeze/Eeze_Sensor.h b/src/lib/eeze/Eeze_Sensor.h index 014b734..d5fd34d 100644 --- a/src/lib/eeze/Eeze_Sensor.h +++ b/src/lib/eeze/Eeze_Sensor.h @@ -18,6 +18,7 @@ #include /** + * @internal * @file Eeze_Sensor.h * @brief Sensor information subsystem * @@ -90,6 +91,7 @@ typedef enum } Eeze_Sensor_Type; /** + * @internal * @defgroup Eeze_Sensor_Events Available eeze sensor events * @brief Sensor events that are emitted from the library as ecore events * @ingroup Eeze diff --git a/src/lib/efreet/Efreet_Mime.h b/src/lib/efreet/Efreet_Mime.h index cbde578..b799952 100644 --- a/src/lib/efreet/Efreet_Mime.h +++ b/src/lib/efreet/Efreet_Mime.h @@ -2,6 +2,7 @@ #define EFREET_MIME_H /** + * @internal * @file Efreet_Mime.h * @brief The file that must be included by any project wishing to use * @addtogroup Efreet_Mime Efreet_Mime: The XDG Shared Mime Info standard diff --git a/src/lib/efreet/Efreet_Trash.h b/src/lib/efreet/Efreet_Trash.h index 64af9ea..c5d796b 100644 --- a/src/lib/efreet/Efreet_Trash.h +++ b/src/lib/efreet/Efreet_Trash.h @@ -32,6 +32,7 @@ extern "C" { #endif /** + * @internal * @file Efreet_Trash.h * @brief Contains the methods used to support the FDO trash specification. * @addtogroup Efreet_Trash Efreet_Trash: The XDG Trash Specification diff --git a/src/lib/efreet/efreet_base.h b/src/lib/efreet/efreet_base.h index ca011d9..ecc927c 100644 --- a/src/lib/efreet/efreet_base.h +++ b/src/lib/efreet/efreet_base.h @@ -1,6 +1,7 @@ #ifndef EFREET_BASE_H #define EFREET_BASE_H /** + * @internal * @file efreet_base.h * @brief Contains the methods used to support the FDO base directory * specification. diff --git a/src/lib/efreet/efreet_desktop.h b/src/lib/efreet/efreet_desktop.h index 8f2c30a..d0f42a4 100644 --- a/src/lib/efreet/efreet_desktop.h +++ b/src/lib/efreet/efreet_desktop.h @@ -2,6 +2,7 @@ #define EFREET_DESKTOP_H /** + * @internal * @file efreet_desktop.h * @brief Contains the structures and methods used to support the * FDO desktop entry specificiation. diff --git a/src/lib/efreet/efreet_icon.h b/src/lib/efreet/efreet_icon.h index 0495622..e4e74ad 100644 --- a/src/lib/efreet/efreet_icon.h +++ b/src/lib/efreet/efreet_icon.h @@ -2,6 +2,7 @@ #define EFREET_ICON_H /** + * @internal * @file efreet_icon.h * @brief Contains the structures and methods used to support the FDO icon * theme specificiation. diff --git a/src/lib/efreet/efreet_menu.h b/src/lib/efreet/efreet_menu.h index b7f123a..fe38d04 100644 --- a/src/lib/efreet/efreet_menu.h +++ b/src/lib/efreet/efreet_menu.h @@ -2,6 +2,7 @@ #define EFREET_MENU_H /** + * @internal * @file efreet_menu.h * @brief Contains the structures and methods to support the Desktop * Menu Specification. diff --git a/src/lib/efreet/efreet_private.h b/src/lib/efreet/efreet_private.h index 139754d..1b8d6ba 100644 --- a/src/lib/efreet/efreet_private.h +++ b/src/lib/efreet/efreet_private.h @@ -35,6 +35,7 @@ #endif /** + * @internal * @file efreet_private.h * @brief Contains methods and defines that are private to the Efreet * implementaion diff --git a/src/lib/efreet/efreet_uri.h b/src/lib/efreet/efreet_uri.h index 32b1f51..7cfdaf9 100644 --- a/src/lib/efreet/efreet_uri.h +++ b/src/lib/efreet/efreet_uri.h @@ -2,6 +2,7 @@ #define EFREET_URI_H /** + * @internal * @file efreet_uri.h * @brief Contains the methods used to support the FDO URI specification. * @addtogroup Efreet_Uri Efreet_Uri: The FDO URI Specification functions diff --git a/src/lib/efreet/efreet_utils.h b/src/lib/efreet/efreet_utils.h index aef0511..68423ff 100644 --- a/src/lib/efreet/efreet_utils.h +++ b/src/lib/efreet/efreet_utils.h @@ -2,6 +2,7 @@ #define EFREET_UTILS_H /** + * @internal * @file efreet_utils.h * @brief Contains utility functions to ease usage of Efreet. * FDO desktop entry specificiation. diff --git a/src/lib/eina/eina_matrix.h b/src/lib/eina/eina_matrix.h index 338dd7e..2f9ad21 100644 --- a/src/lib/eina/eina_matrix.h +++ b/src/lib/eina/eina_matrix.h @@ -28,11 +28,20 @@ */ /** - * @defgroup Eina_Matrix_Type Matrices type - * @ingroup Eina_Basic - * @brief Matrix3 types + * @addtogroup Eina_Data_Types_Group Data Types + * + * @{ + */ + +/** + * @defgroup Eina_Matrix_Group Matrix + * * @{ */ + +/** + * @typedef Matrix3 types + */ typedef enum _Eina_Matrix_Type { EINA_MATRIX_TYPE_IDENTITY, /**< Identity matrix3 type */ @@ -42,18 +51,104 @@ typedef enum _Eina_Matrix_Type } Eina_Matrix_Type; /** + * @defgroup Eina_Matrix3_Group 3x3 Matrices in floating point + * + * @brief Matrix definition and operations + * + * @{ + */ + +/** + * @typedef Eina_Matrix3 + * Floating point matrix3 handler + */ +typedef struct _Eina_Matrix3 Eina_Matrix3; + +/** + * @struct _Eina_Matrix3 + * Floating point matrix3 handler + */ +struct _Eina_Matrix3 +{ + double xx; /**< xx in x' = (x * xx) + (y * xy) + xz */ + double xy; /**< xy in x' = (x * xx) + (y * xy) + xz */ + double xz; /**< xz in x' = (x * xx) + (y * xy) + xz */ + + double yx; /**< yx in y' = (x * yx) + (y * yy) + yz */ + double yy; /**< yy in y' = (x * yx) + (y * yy) + yz */ + double yz; /**< yz in y' = (x * yx) + (y * yy) + yz */ + + double zx; /**< zx in z' = (x * zx) + (y * zy) + zz */ + double zy; /**< zy in z' = (x * zx) + (y * zy) + zz */ + double zz; /**< zz in z' = (x * zx) + (y * zy) + zz */ +}; + +/** * @} - * @defgroup Eina_Matrix3_F16p16 Matrices in fixed point - * @ingroup Eina_Basic - * @brief Fixed point matrices operations + */ + +/** + * @defgroup Eina_Matrix4_Group 4x4 Matrices in floating point + * + * @brief Matrix definition and operations + * + * @{ + */ + +/** + * @typedef Eina_Matrix4 + * Floating point matrix4 handler + */ +typedef struct _Eina_Matrix4 Eina_Matrix4; + +/** + * @struct Eina_Matrix4 + * Floating point matrix4 handler + */ +struct _Eina_Matrix4 +{ + double xx; /**< xx in x' = (x * xx) + (y * xy) + (z * xz) + xw */ + double xy; /**< xy in x' = (x * xx) + (y * xy) + (z * xz) + xw */ + double xz; /**< xz in x' = (x * xx) + (y * xy) + (z * xz) + xw */ + double xw; /**< xw in x' = (x * xx) + (y * xy) + (z * xz) + xw */ + + double yx; /**< yx in y' = (x * yx) + (y * yy) + (z * yz) + yw */ + double yy; /**< yy in y' = (x * yx) + (y * yy) + (z * yz) + yw */ + double yz; /**< yz in y' = (x * yx) + (y * yy) + (z * yz) + yw */ + double yw; /**< yw in y' = (x * yx) + (y * yy) + (z * yz) + yw */ + + double zx; /**< zx in z' = (x * zx) + (y * zy) + (z * zz) + zw */ + double zy; /**< zy in z' = (x * zx) + (y * zy) + (z * zz) + zw */ + double zz; /**< zz in z' = (x * zx) + (y * zy) + (z * zz) + zw */ + double zw; /**< zw in z' = (x * zx) + (y * zy) + (z * zz) + zw */ + + double wx; /**< wx in w' = (x * wx) + (y * wy) + (z * wz) + ww */ + double wy; /**< wy in w' = (x * wx) + (y * wy) + (z * wz) + ww */ + double wz; /**< wz in w' = (x * wx) + (y * wy) + (z * wz) + ww */ + double ww; /**< ww in w' = (x * wx) + (y * wy) + (z * wz) + ww */ +}; + +/** + * @} + */ + +/** + * @defgroup Eina_Matrix3_F16p16_Group 3x3 Matrices in fixed point + * + * @brief Fixed point matrix operations * @{ */ /** + * @typedef Eina_Matrix3_F16p16 * Fixed point matrix3 handler */ typedef struct _Eina_Matrix3_F16p16 Eina_Matrix3_F16p16; +/** + * @struct Eina_Matrix3_F16p16 + * Fixed point matrix3 handler + */ struct _Eina_Matrix3_F16p16 { Eina_F16p16 xx; /**< xx in x' = (x * xx) + (y * xy) + xz */ @@ -103,9 +198,11 @@ EAPI Eina_Matrix_Type eina_matrix3_f16p16_type_get(const Eina_Matrix3_F16p16 *m) /** * @} - * @defgroup Eina_Matrix3 Matrices in floating point - * @ingroup Eina_Basic - * @brief Matrix definition and operations + */ + +/** + * @addtogroup Eina_Matrix3_Group + * * @{ */ @@ -117,25 +214,6 @@ EAPI Eina_Matrix_Type eina_matrix3_f16p16_type_get(const Eina_Matrix3_F16p16 *m) (m)->zx, (m)->zy, (m)->zz -/** - * Floating point matrix3 handler - */ -typedef struct _Eina_Matrix3 Eina_Matrix3; - -struct _Eina_Matrix3 -{ - double xx; /**< xx in x' = (x * xx) + (y * xy) + xz */ - double xy; /**< xy in x' = (x * xx) + (y * xy) + xz */ - double xz; /**< xz in x' = (x * xx) + (y * xy) + xz */ - - double yx; /**< yx in y' = (x * yx) + (y * yy) + yz */ - double yy; /**< yy in y' = (x * yx) + (y * yy) + yz */ - double yz; /**< yz in y' = (x * yx) + (y * yy) + yz */ - - double zx; /**< zx in z' = (x * zx) + (y * zy) + zz */ - double zy; /**< zy in z' = (x * zx) + (y * zy) + zz */ - double zz; /**< zz in z' = (x * zx) + (y * zy) + zz */ -}; /** * @brief Return the type of the given floating point matrix. @@ -397,54 +475,104 @@ EAPI Eina_Bool eina_matrix3_quad_square_map(Eina_Matrix3 *m, const Eina_Quad *q); /** - * @} - * @defgroup Eina_Matrix4 Matrices in floating point - * @ingroup Eina_Basic - * @brief Matrix definition and operations - * @{ + * @brief Set array to matrix. + * + * @param m The result matrix + * @param v The the array[9] for set + * + * Set to matrix first 9 elements from array + * + * @since 1.17 */ +EAPI void eina_matrix3_array_set(Eina_Matrix3 *m, const double *v); -typedef struct _Eina_Matrix4 Eina_Matrix4; -struct _Eina_Matrix4 -{ - double xx; /**< xx in x' = (x * xx) + (y * xy) + (z * xz) + xw */ - double xy; /**< xy in x' = (x * xx) + (y * xy) + (z * xz) + xw */ - double xz; /**< xz in x' = (x * xx) + (y * xy) + (z * xz) + xw */ - double xw; /**< xw in x' = (x * xx) + (y * xy) + (z * xz) + xw */ +/** + * @brief Copy matrix. + * + * @param dst The matrix copy + * @param src The matrix for copy. + * + * @since 1.16 + */ +EAPI void eina_matrix3_copy(Eina_Matrix3 *dst, const Eina_Matrix3 *src); - double yx; /**< yx in y' = (x * yx) + (y * yy) + (z * yz) + yw */ - double yy; /**< yy in y' = (x * yx) + (y * yy) + (z * yz) + yw */ - double yz; /**< yz in y' = (x * yx) + (y * yy) + (z * yz) + yw */ - double yw; /**< yw in y' = (x * yx) + (y * yy) + (z * yz) + yw */ +/** + * @brief Multiply two matrix + * + * @param out The resulting matrix + * @param a The first member of the multiplication + * @param b The second member of the multiplication + * + * @since 1.17 + */ +EAPI void eina_matrix3_multiply(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a, + const Eina_Matrix3 *mat_b); - double zx; /**< zx in z' = (x * zx) + (y * zy) + (z * zz) + zw */ - double zy; /**< zy in z' = (x * zx) + (y * zy) + (z * zz) + zw */ - double zz; /**< zz in z' = (x * zx) + (y * zy) + (z * zz) + zw */ - double zw; /**< zw in z' = (x * zx) + (y * zy) + (z * zz) + zw */ +/** + * @brief Multiply two matrix + * + * @param out The resulting matrix + * @param a The first member of the multiplication + * @param b The second member of the multiplication + * + * @since 1.17 + */ +EAPI void eina_matrix3_multiply_copy(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a, + const Eina_Matrix3 *mat_b); - double wx; /**< wx in w' = (x * wx) + (y * wy) + (z * wz) + ww */ - double wy; /**< wy in w' = (x * wx) + (y * wy) + (z * wz) + ww */ - double wz; /**< wz in w' = (x * wx) + (y * wy) + (z * wz) + ww */ - double ww; /**< ww in w' = (x * wx) + (y * wy) + (z * wz) + ww */ -}; +/** + * @brief Transform scale of matrix + * + * @param out The resulting matrix + * @param s_x The scale value for x + * @param s_y The scale value for y + * + * @since 1.17 + */ +EAPI void eina_matrix3_scale_transform_set(Eina_Matrix3 *out, double s_x, double s_y); + +/** + * @brief Transform position of matrix + * + * @param out The resulting matrix + * @param p_x The position value for x + * @param p_y The position value for y + * + * @since 1.17 + */ +EAPI void eina_matrix3_position_transform_set(Eina_Matrix3 *out, const double p_x, + const double p_y); + +/** + * @brief Set normal of the given matrix. + * + * @param out The result mtrix of normal + * @param m The matrix + * + * @since 1.17 + */ +EAPI void eina_normal3_matrix_get(Eina_Matrix3 *out, const Eina_Matrix4 *m); + +/** + * @brief Convert an Eina_Matrix3 into an Eina_Matrix4. + * + * @param m3 The destination Eina_Matrix3. + * @param m4 The source Eina_Matrix4. + * + * @since 1.15 + */ +EAPI void eina_matrix3_matrix4_to(Eina_Matrix4 *m4, const Eina_Matrix3 *m3); /** * @} - * @defgroup Eina_Matrix2 Matrices in floating point - * @ingroup Eina_Basic - * @brief Matrix definition and operations - * @{ */ -typedef struct _Eina_Matrix2 Eina_Matrix2; -struct _Eina_Matrix2 -{ - double xx; - double xy; +/** + * @addtogroup Eina_Matrix4_Group + * + * @{ + */ - double yx; - double yy; -}; /** * @brief Return the type of the given floating point matrix. * @@ -589,16 +717,6 @@ EAPI void eina_matrix4_transpose(Eina_Matrix4 *out, const Eina_Matrix4 *in); EAPI void eina_matrix4_matrix3_to(Eina_Matrix3 *m3, const Eina_Matrix4 *m4); /** - * @brief Convert an Eina_Matrix3 into an Eina_Matrix4. - * - * @param m3 The destination Eina_Matrix3. - * @param m4 The source Eina_Matrix4. - * - * @since 1.15 - */ -EAPI void eina_matrix3_matrix4_to(Eina_Matrix4 *m4, const Eina_Matrix3 *m3); - -/** * @brief Set an identity matrix * * @param out The matrix to set @@ -671,83 +789,35 @@ EAPI void eina_matrix4_ortho_set(Eina_Matrix4 *m, double dnear, double dfar); /** - * @brief Set array to matrix. - * - * @param m The result matrix - * @param v The the array[9] for set - * - * Set to matrix first 9 elements from array - * - * @since 1.17 - */ -EAPI void eina_matrix3_array_set(Eina_Matrix3 *m, const double *v); - -/** - * @brief Copy matrix. - * - * @param dst The matrix copy - * @param src The matrix for copy. - * - * @since 1.16 + * @} */ -EAPI void eina_matrix3_copy(Eina_Matrix3 *dst, const Eina_Matrix3 *src); -/** - * @brief Multiply two matrix - * - * @param out The resulting matrix - * @param a The first member of the multiplication - * @param b The second member of the multiplication - * - * @since 1.17 - */ -EAPI void eina_matrix3_multiply(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a, - const Eina_Matrix3 *mat_b); /** - * @brief Multiply two matrix - * - * @param out The resulting matrix - * @param a The first member of the multiplication - * @param b The second member of the multiplication + * @defgroup Eina_Matrix2_Group 2x2 Matrices in floating point * - * @since 1.17 + * @brief Matrix definition and operations + * @{ */ -EAPI void eina_matrix3_multiply_copy(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a, - const Eina_Matrix3 *mat_b); - + /** - * @brief Transform scale of matrix - * - * @param out The resulting matrix - * @param s_x The scale value for x - * @param s_y The scale value for y - * - * @since 1.17 + * @typedef Eina_Matrix2 + * Floating point matrix2 handler */ -EAPI void eina_matrix3_scale_transform_set(Eina_Matrix3 *out, double s_x, double s_y); +typedef struct _Eina_Matrix2 Eina_Matrix2; /** - * @brief Transform position of matrix - * - * @param out The resulting matrix - * @param p_x The position value for x - * @param p_y The position value for y - * - * @since 1.17 + * @struct Eina_Matrix2 + * Floating point matrix2 handler */ -EAPI void eina_matrix3_position_transform_set(Eina_Matrix3 *out, const double p_x, - const double p_y); +struct _Eina_Matrix2 +{ + double xx; + double xy; -/** - * @brief Set normal of the given matrix. - * - * @param out The result mtrix of normal - * @param m The matrix - * - * @since 1.17 - */ -EAPI void eina_normal3_matrix_get(Eina_Matrix3 *out, const Eina_Matrix4 *m); + double yx; + double yy; +}; /** * @brief Set the values of the coefficients of the given floating @@ -877,4 +947,13 @@ EAPI Eina_Matrix_Type eina_matrix2_type_get(const Eina_Matrix2 *m); /** * @} */ + +/** + * @} + */ + +/** + * @} + */ + #endif /*EINA_MATRIX3_H_*/ diff --git a/src/lib/eina/eina_quad.h b/src/lib/eina/eina_quad.h index 13192d2..93c0fb0 100644 --- a/src/lib/eina/eina_quad.h +++ b/src/lib/eina/eina_quad.h @@ -26,9 +26,16 @@ */ /** - * @defgroup Eina_Quad Quadrangles - * @ingroup Eina_Basic + * @addtogroup Eina_Data_Types_Group Data Types + * + * @{ + */ + +/** + * @defgroup Eina_Quad_Group Quadrangles + * * @brief Quadrangles operations + * * @{ */ @@ -79,4 +86,8 @@ EAPI void eina_quad_coords_get(const Eina_Quad *q, * @} */ +/** + * @} + */ + #endif diff --git a/src/lib/eio/Eio.h b/src/lib/eio/Eio.h index 7ee29fe..2ad8c56 100644 --- a/src/lib/eio/Eio.h +++ b/src/lib/eio/Eio.h @@ -423,7 +423,9 @@ EAPI Eio_File *eio_file_direct_stat(const char *path, */ /** + * @internal * @defgroup Eio_Management Eio file management API. + * @addtogroup Eio * * @brief A set of function to manage file asynchronously. * diff --git a/src/lib/eio/eio_model.h b/src/lib/eio/eio_model.h index e28870b..2fca972 100644 --- a/src/lib/eio/eio_model.h +++ b/src/lib/eio/eio_model.h @@ -20,6 +20,7 @@ * @li @ref Eo * @li @ref Eina * + * @internal * @defgroup Emodel_Eio EIO implementation wrapper for Emodel * * @addtogroup Emodel_Eio diff --git a/src/lib/elocation/Elocation.h b/src/lib/elocation/Elocation.h index 60002c0..c194023 100644 --- a/src/lib/elocation/Elocation.h +++ b/src/lib/elocation/Elocation.h @@ -1,4 +1,5 @@ /** + * @internal * @file Elocation.h * @brief Elocation Library * diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h index 4c0f9cb..77e6990 100644 --- a/src/lib/elua/Elua.h +++ b/src/lib/elua/Elua.h @@ -1,4 +1,5 @@ /** + * @internal * @file Elua.h * @brief Elua Library * @@ -88,6 +89,7 @@ extern "C" { * There is a comperehensive API reference available that should get you up * and running. * + * @internal * @addtogroup Elua * @{ */ diff --git a/src/lib/embryo/Embryo.h b/src/lib/embryo/Embryo.h index fc358ef..f4d11ad 100644 --- a/src/lib/embryo/Embryo.h +++ b/src/lib/embryo/Embryo.h @@ -457,6 +457,7 @@ extern "C" { #endif /** + * @internal * @defgroup Embryo_Library_Group Library Maintenance Functions * @ingroup Embryo * @@ -481,6 +482,7 @@ EAPI int embryo_init(void); EAPI int embryo_shutdown(void); /** + * @internal * @defgroup Embryo_Program_Creation_Group Program Creation and Destruction Functions * @ingroup Embryo * @@ -531,6 +533,7 @@ EAPI void embryo_program_free(Embryo_Program *ep); */ /** + * @internal * @defgroup Embryo_Func_Group Function Functions * @ingroup Embryo * @@ -545,6 +548,7 @@ EAPI void embryo_program_native_call_add(Embryo_Program *ep, const c */ /** + * @internal * @defgroup Embryo_Program_VM_Group Virtual Machine Functions * @ingroup Embryo * @@ -595,6 +599,7 @@ EAPI void embryo_program_vm_pop(Embryo_Program *ep); */ /** + * @internal * @defgroup Embryo_Swap_Group Byte Swapping Functions * @ingroup Embryo * @@ -633,6 +638,7 @@ EAPI Embryo_Function embryo_program_function_find(Embryo_Program *ep, const cha */ /** + * @internal * @defgroup Embryo_Public_Variable_Group Public Variable Access Functions * @ingroup Embryo * @@ -669,6 +675,7 @@ EAPI Embryo_Cell embryo_program_variable_get(Embryo_Program *ep, int num); */ /** + * @internal * @defgroup Embryo_Error_Group Error Functions * @ingroup Embryo * @@ -692,6 +699,7 @@ EAPI Embryo_Error embryo_program_error_get(Embryo_Program *ep); */ /** + * @internal * @defgroup Embryo_Program_Data_Group Program Data Functions * @ingroup Embryo * @@ -725,6 +733,7 @@ EAPI const char *embryo_error_string_get(Embryo_Error error); */ /** + * @internal * @defgroup Embryo_Data_String_Group Embryo Data String Functions * @ingroup Embryo * @@ -772,6 +781,7 @@ EAPI Embryo_Cell *embryo_data_address_get(Embryo_Program *ep, Embryo_Cell ad */ /** + * @internal * @defgroup Embryo_Heap_Group Heap Functions * @ingroup Embryo * @@ -798,6 +808,7 @@ EAPI void embryo_data_heap_pop(Embryo_Program *ep, Embryo_Cell down_ */ /** + * @internal * @defgroup Embryo_Run_Group Program Run Functions * @ingroup Embryo * @@ -910,6 +921,7 @@ EAPI int embryo_program_max_cycle_run_get(Embryo_Program *ep); */ /** + * @internal * @defgroup Embryo_Parameter_Group Function Parameter Functions * @ingroup Embryo * diff --git a/src/lib/emile/Emile.h b/src/lib/emile/Emile.h index 486acc3..e7094f5 100644 --- a/src/lib/emile/Emile.h +++ b/src/lib/emile/Emile.h @@ -67,6 +67,7 @@ extern "C" { */ /** + * @internal * @defgroup Emile_Group Top level functions * @ingroup Emile * Function that affect Emile as a whole. diff --git a/src/lib/emile/emile_cipher.h b/src/lib/emile/emile_cipher.h index 9d82d16..b709179 100644 --- a/src/lib/emile/emile_cipher.h +++ b/src/lib/emile/emile_cipher.h @@ -2,6 +2,7 @@ #define EMILE_CIPHER_H_ /** + * @internal * @defgroup Emile_Cipher_Group Top level functions * @ingroup Emile * Function that allow ciphering content. diff --git a/src/lib/emile/emile_compress.h b/src/lib/emile/emile_compress.h index d1539ac..ec5bfae 100644 --- a/src/lib/emile/emile_compress.h +++ b/src/lib/emile/emile_compress.h @@ -2,6 +2,7 @@ #define EMILE_COMPRESSION_H_ /** + * @internal * @defgroup Emile_Group_Compression Non destructive general purpose compression functions. * @ingroup Emile * Function that allow the compression and expansion of Eina_Binbuf with diff --git a/src/lib/emile/emile_image.h b/src/lib/emile/emile_image.h index bee101d..3db8e13 100644 --- a/src/lib/emile/emile_image.h +++ b/src/lib/emile/emile_image.h @@ -2,6 +2,7 @@ #define EMILE_IMAGE_H /** + * @internal * @defgroup Emile_Image_Group Top level functions * @ingroup Emile * Function that allow reading/saving image. diff --git a/src/lib/emotion/Emotion.h b/src/lib/emotion/Emotion.h index e2d7a7a..1f10fc9 100644 --- a/src/lib/emotion/Emotion.h +++ b/src/lib/emotion/Emotion.h @@ -289,6 +289,7 @@ extern "C" { /* api calls available */ /** + * @internal * @brief How to create, initialize, manipulate and connect to signals of an * Emotion object. * @defgroup Emotion_API API available for manipulating Emotion object. @@ -344,26 +345,32 @@ extern "C" { */ /** + * @internal * @defgroup Emotion_Init Creation and initialization functions */ /** + * @internal * @defgroup Emotion_Audio Audio control functions */ /** + * @internal * @defgroup Emotion_Video Video control functions */ /** + * @internal * @defgroup Emotion_Visualization Visualization control functions */ /** + * @internal * @defgroup Emotion_Info Miscellaneous information retrieval functions */ /** + * @internal * @defgroup Emotion_Ressource Video ressource management */ @@ -596,6 +603,7 @@ EAPI Eina_Bool emotion_object_file_set (Evas_Object *obj, const */ EAPI const char *emotion_object_file_get (const Evas_Object *obj); /** + * @internal * @defgroup Emotion_Play Play control functions * @ingroup Emotion * @@ -1297,6 +1305,7 @@ EAPI Eina_Bool emotion_object_extension_may_play_get(const char *file); EAPI Evas_Object *emotion_object_image_get(const Evas_Object *obj); /** + * @internal * @defgroup Emotion_Webcam API available for accessing webcam * @ingroup Emotion */ diff --git a/src/lib/eo/Eo.h b/src/lib/eo/Eo.h index 3e5ad42..53ae8a6 100644 --- a/src/lib/eo/Eo.h +++ b/src/lib/eo/Eo.h @@ -40,6 +40,7 @@ extern "C" { #endif /** + * @internal * @page eo_main Eo * * @date 2012 (created) @@ -94,7 +95,7 @@ extern "C" { * @ref Eo_Tutorial * - * + * @internal * @addtogroup Eo * @{ */ @@ -162,6 +163,7 @@ typedef Eina_Bool (*Eo_Event_Cb)(void *data, Eo *obj, const Eo_Event_Description #define EO_CLASS EO_BASE_CLASS /** + * @internal * @addtogroup Eo_Debug_Information Eo's Debug information helper. * @{ */ @@ -239,6 +241,7 @@ typedef unsigned int Eo_Op; #define EO_NOOP ((Eo_Op) 0) /** + * @internal * @addtogroup Eo_Events Eo's Event Handling * @{ */ @@ -268,6 +271,7 @@ typedef unsigned int Eo_Op; */ /** + * @internal * @addtogroup Eo_Class Eo Class * @{ */ @@ -854,6 +858,7 @@ EAPI Eina_Bool eo_manual_free(Eo *obj); EAPI Eina_Bool eo_destructed_is(const Eo *obj); /** + * @internal * @addtogroup Eo_Class_Class Eo's Class class. * @{ */ @@ -865,6 +870,7 @@ EAPI Eina_Bool eo_destructed_is(const Eo *obj); */ /** + * @internal * @addtogroup Eo_Class_Base Eo's Base class. * @{ */ @@ -924,6 +930,7 @@ typedef void (*eo_key_data_free_func)(void *); #define eo_wref_del_safe(wref) eo_weak_unref(wref) /** + * @internal * @addtogroup Eo_Events Eo's Event Handling * @{ */ diff --git a/src/lib/eolian/Eolian.h b/src/lib/eolian/Eolian.h index 9f47a98..0faefd4 100644 --- a/src/lib/eolian/Eolian.h +++ b/src/lib/eolian/Eolian.h @@ -37,6 +37,7 @@ extern "C" { #endif /** + * @internal * @page eolian_main Eolian (BETA) * * @date 2014 (created) diff --git a/src/lib/ephysics/EPhysics.h b/src/lib/ephysics/EPhysics.h index f1c3424..6c8bb1e 100644 --- a/src/lib/ephysics/EPhysics.h +++ b/src/lib/ephysics/EPhysics.h @@ -106,6 +106,7 @@ extern "C" { */ /** + * @internal * @brief Physics simulation integration and visual effects. * @defgroup EPhysics EPhysics * @@ -145,6 +146,7 @@ EAPI int ephysics_shutdown(void); */ /** + * @internal * @defgroup EPhysics_Quaternion EPhysics Quaternion * @ingroup EPhysics * @@ -468,6 +470,7 @@ EAPI double ephysics_quaternion_length2_get(const EPhysics_Quaternion *quat); */ /** + * @internal * @defgroup EPhysics_Shape EPhysics Shape * @ingroup EPhysics * @@ -655,6 +658,7 @@ EAPI Eina_Bool ephysics_shape_save(const EPhysics_Shape *shape, const char *file typedef struct _EPhysics_Body EPhysics_Body; /** + * @internal * @defgroup EPhysics_Camera EPhysics Camera * @ingroup EPhysics * @@ -875,6 +879,7 @@ EAPI Eina_Bool ephysics_camera_perspective_enabled_get(const EPhysics_Camera *ca */ /** + * @internal * @defgroup EPhysics_World EPhysics World * @ingroup EPhysics * @@ -1968,6 +1973,7 @@ EAPI Eina_Bool ephysics_world_stack_enable_get(const EPhysics_World *world); */ /** + * @internal * @defgroup EPhysics_Body EPhysics Body * @ingroup EPhysics * @@ -4513,6 +4519,7 @@ EAPI Eina_Bool ephysics_body_clockwise_get(const EPhysics_Body *body); */ /** + * @internal * @defgroup EPhysics_Constraint EPhysics Constraint * @ingroup EPhysics * diff --git a/src/lib/escape/escape_libgen.h b/src/lib/escape/escape_libgen.h index 4b63674..a358e3c 100644 --- a/src/lib/escape/escape_libgen.h +++ b/src/lib/escape/escape_libgen.h @@ -2,6 +2,7 @@ #define __ESCAPE_LIBGEN_H__ /** + * @internal * @file escape_libgen.h * @brief The file that provides functions ported from Unix in libgen.h. * @defgroup Escape_Libgen_Group Libgen.h functions. diff --git a/src/lib/escape/escape_unistd.h b/src/lib/escape/escape_unistd.h index 1ed1b5a..5521bcc 100644 --- a/src/lib/escape/escape_unistd.h +++ b/src/lib/escape/escape_unistd.h @@ -2,6 +2,7 @@ #define __ESCAPE_UNISTD_H__ /** + * @internal * @file escape_unistd.h * @brief The file that provides functions ported from Unix in unistd.h. * @defgroup Escape_Unistd_Group Unistd.h functions diff --git a/src/lib/escape/sys/mman.h b/src/lib/escape/sys/mman.h index aebbbc9..20de0fe 100644 --- a/src/lib/escape/sys/mman.h +++ b/src/lib/escape/sys/mman.h @@ -59,6 +59,7 @@ extern "C" { #define MAP_FAILED ((void *)-1) /** + * @internal * @file mman.h * @brief The file that provides the memory map functions * @defgroup Escape_Mman Functions that manage memory mappping. diff --git a/src/lib/ethumb/Ethumb.h b/src/lib/ethumb/Ethumb.h index 2e497e1..4123773 100644 --- a/src/lib/ethumb/Ethumb.h +++ b/src/lib/ethumb/Ethumb.h @@ -116,11 +116,13 @@ extern "C" { */ /** + * @internal * @defgroup Ethumb Ethumb * * @{ */ /** + * @internal * @defgroup Ethumb_Basics Ethumb Basics * * Functions that all users must know of to use Ethumb. @@ -171,6 +173,7 @@ EAPI void ethumb_free(Ethumb *e); */ /** + * @internal * @defgroup Ethumb_Setup Ethumb Fine Tune Setup * * How to fine tune thumbnail generation, setting size, aspect, @@ -492,6 +495,7 @@ EAPI unsigned int ethumb_document_page_get(const Ethumb *e) EINA_WARN_UNUSED_RES */ /** + * @internal * @addtogroup Ethumb_Basics Ethumb Basics * @{ */ diff --git a/src/lib/ethumb_client/Ethumb_Client.h b/src/lib/ethumb_client/Ethumb_Client.h index 1ec8178..ebd4799 100644 --- a/src/lib/ethumb_client/Ethumb_Client.h +++ b/src/lib/ethumb_client/Ethumb_Client.h @@ -34,6 +34,7 @@ extern "C" { #endif /** + * @internal * @defgroup Ethumb_Client Ethumb Client * @ingroup Ethumb * @@ -41,6 +42,7 @@ extern "C" { */ /** + * @internal * @defgroup Ethumb_Client_Basics Ethumb Client Basics * * Functions that all users must know of to use Ethumb_Client. @@ -137,6 +139,7 @@ EAPI void ethumb_client_on_server_die_callback_set(Ethumb_Client *client, Ethumb */ /** + * @internal * @defgroup Ethumb_Client_Setup Ethumb Client Fine Tune Setup * * How to fine tune thumbnail generation, setting size, aspect, orientation, @@ -181,6 +184,7 @@ EAPI void ethumb_client_thumb_path_get(Ethumb_Client *client, const char **path, */ /** + * @internal * @addtogroup Ethumb_Client_Basics Ethumb Client Basics * @{ */ diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h index 2a5ac25..6eff764 100755 --- a/src/lib/evas/Evas_Common.h +++ b/src/lib/evas/Evas_Common.h @@ -5022,6 +5022,8 @@ EAPI const Evas_Object_Box_Api *evas_object_box_smart_class_get(void) EINA_CONST */ /** + * @internal + * * @defgroup Evas_Cserve Shared Image Cache Server * @ingroup Evas * diff --git a/src/lib/evas/Evas_Eo.h b/src/lib/evas/Evas_Eo.h index e581315..3254933 100644 --- a/src/lib/evas/Evas_Eo.h +++ b/src/lib/evas/Evas_Eo.h @@ -161,7 +161,9 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; #include "canvas/evas_out.eo.h" - /** +/** + * @internal + * * @defgroup Evas_3D Evas 3D Extensions * * Evas extension to support 3D rendering. @@ -216,6 +218,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Types Types & Enums * @ingroup Evas_3D * @@ -223,6 +227,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Object Generic 3D Object Descriptions * @ingroup Evas_3D * @@ -241,6 +247,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Scene Scene Object * @ingroup Evas_3D * @@ -250,6 +258,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Node Node Object * @ingroup Evas_3D * @@ -260,6 +270,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Camera Camera Object * @ingroup Evas_3D * @@ -277,6 +289,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Light Light Object * @ingroup Evas_3D * @@ -288,6 +302,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Mesh Mesh Object * @ingroup Evas_3D * @@ -304,6 +320,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Primitive Primitive Object * @ingroup Evas_3D * @@ -313,6 +331,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Texture Texture Object * @ingroup Evas_3D * @@ -323,6 +343,8 @@ EAPI extern const Eo_Event_Description _EVAS_CANVAS_EVENT_VIEWPORT_RESIZE; */ /** + * @internal + * * @defgroup Evas_Canvas3D_Material Material Object * @ingroup Evas_3D * diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index 6a70146..ac50e49 100644 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -1707,6 +1707,8 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EIN */ /** + * @internal + * * @defgroup Evas_Object_Vg * @ingroup Evas * diff --git a/src/lib/evil/dirent.h b/src/lib/evil/dirent.h index 9c58019..7ca3a6c 100644 --- a/src/lib/evil/dirent.h +++ b/src/lib/evil/dirent.h @@ -19,6 +19,7 @@ /** + * @internal * @file dirent.h * @brief The file that provides functions ported from Unix in dirent.h. * @defgroup Evil_Dirent_Group Dirent.h functions diff --git a/src/lib/evil/evil_dlfcn.h b/src/lib/evil/evil_dlfcn.h index 1c05b1f..14ed6eb 100644 --- a/src/lib/evil/evil_dlfcn.h +++ b/src/lib/evil/evil_dlfcn.h @@ -6,6 +6,7 @@ /** + * @internal * @file evil_dlfcn.h * @brief The file that provides functions to manage dynamic-link libraries * @defgroup Evil_Dlfcn Functions that manage dynamic-link libraries. diff --git a/src/lib/evil/evil_inet.h b/src/lib/evil/evil_inet.h index fb4e072..f21c63c 100644 --- a/src/lib/evil/evil_inet.h +++ b/src/lib/evil/evil_inet.h @@ -22,6 +22,7 @@ /** + * @internal * @file evil_inet.h * @brief The file that provides functions ported from Unix in arpa/inet.h. * @defgroup Evil_Inet_Group Inet.h functions diff --git a/src/lib/evil/evil_libgen.h b/src/lib/evil/evil_libgen.h index b832d62..402ce54 100644 --- a/src/lib/evil/evil_libgen.h +++ b/src/lib/evil/evil_libgen.h @@ -3,6 +3,7 @@ /** + * @internal * @file evil_libgen.h * @brief The file that provides functions ported from Unix in libgen.h. * @defgroup Evil_Libgen_Group Libgen.h functions. diff --git a/src/lib/evil/evil_locale.h b/src/lib/evil/evil_locale.h index 4bf14ec..bcecddb 100644 --- a/src/lib/evil/evil_locale.h +++ b/src/lib/evil/evil_locale.h @@ -3,6 +3,7 @@ /** + * @internal * @file evil_locale.h * @brief The file that provides functions ported from Unix in locale.h. * @defgroup Evil_Locale_Group locale.h functions. diff --git a/src/lib/evil/evil_main.h b/src/lib/evil/evil_main.h index 963bf5e..54272a0 100644 --- a/src/lib/evil/evil_main.h +++ b/src/lib/evil/evil_main.h @@ -3,6 +3,7 @@ /** + * @internal * @file evil_main.h * @brief The file that provides functions to initialize and shut down Evil. * @defgroup Evil_Main_Group Main diff --git a/src/lib/evil/evil_stdio.h b/src/lib/evil/evil_stdio.h index 7b61a33..56884f1 100644 --- a/src/lib/evil/evil_stdio.h +++ b/src/lib/evil/evil_stdio.h @@ -3,6 +3,7 @@ /** + * @internal * @file evil_stdio.h * @brief The file that provides functions ported from Unix in stdio.h. * @defgroup Evil_Stdio_Group Stdio.h functions diff --git a/src/lib/evil/evil_stdlib.h b/src/lib/evil/evil_stdlib.h index 6f98489..4739ef4 100644 --- a/src/lib/evil/evil_stdlib.h +++ b/src/lib/evil/evil_stdlib.h @@ -3,6 +3,7 @@ /** + * @internal * @file evil_stdlib.h * @brief The file that provides functions ported from Unix in stdlib.h. * @defgroup Evil_Stdlib_Group Stdlib.h functions. diff --git a/src/lib/evil/evil_string.h b/src/lib/evil/evil_string.h index e1bf65b..9b0bede 100644 --- a/src/lib/evil/evil_string.h +++ b/src/lib/evil/evil_string.h @@ -3,6 +3,7 @@ /** + * @internal * @file evil_string.h * @brief The file that provides functions ported from Unix in string.h. * @defgroup Evil_String_Group String.h functions. diff --git a/src/lib/evil/evil_time.h b/src/lib/evil/evil_time.h index 34607de..3ea1587 100644 --- a/src/lib/evil/evil_time.h +++ b/src/lib/evil/evil_time.h @@ -3,6 +3,7 @@ /** + * @internal * @file evil_time.h * @brief The file that provides functions ported from Unix in time.h. * @defgroup Evil_Time_Group Time.h functions diff --git a/src/lib/evil/evil_unistd.h b/src/lib/evil/evil_unistd.h index dbc6cfe..60a166e 100644 --- a/src/lib/evil/evil_unistd.h +++ b/src/lib/evil/evil_unistd.h @@ -3,6 +3,7 @@ /** + * @internal * @file evil_unistd.h * @brief The file that provides functions ported from Unix in unistd.h. * @defgroup Evil_Unistd_Group Unistd.h functions diff --git a/src/lib/evil/pwd.h b/src/lib/evil/pwd.h index 2663490..4c0b277 100644 --- a/src/lib/evil/pwd.h +++ b/src/lib/evil/pwd.h @@ -3,6 +3,7 @@ /** + * @internal * @file pwd.h * @brief The file that provides functions ported from Unix in pwd.h. * @defgroup Evil_Pwd_Group Pwd.h functions diff --git a/src/lib/evil/sys/mman.h b/src/lib/evil/sys/mman.h index 0a36ebf..64d1f5e 100644 --- a/src/lib/evil/sys/mman.h +++ b/src/lib/evil/sys/mman.h @@ -64,6 +64,7 @@ extern "C" { /** + * @internal * @file mman.h * @brief The file that provides the memory map functions * @defgroup Evil_Mman Functions that manage memory mappping. -- 2.7.4