From: Myoungwoon Roy, Kim Date: Tue, 23 Jun 2020 08:29:35 +0000 (+0900) Subject: docs: Changes non public Tizen APIs in API reference to internal X-Git-Tag: submit/tizen/20200623.220408~26 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F15%2F236915%2F2;p=platform%2Fupstream%2Fefl.git docs: Changes non public Tizen APIs in API reference to internal Change-Id: I579e1af8a8006391bdb51fc63873ddb794cd7792 --- diff --git a/src/lib/ecore_audio/Ecore_Audio.h b/src/lib/ecore_audio/Ecore_Audio.h index 4e471c8..5ddec88 100644 --- a/src/lib/ecore_audio/Ecore_Audio.h +++ b/src/lib/ecore_audio/Ecore_Audio.h @@ -199,6 +199,8 @@ EAPI int ecore_audio_shutdown(void); //Legacy compatibility code /** + * @internal + * * @brief Get the name of the object * * @since 1.8 @@ -206,6 +208,8 @@ EAPI int ecore_audio_shutdown(void); */ EAPI const char* ecore_audio_obj_name_get(const Efl_Object* obj); /** + * @internal + * * @brief Name of the object * * @since 1.8 diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h index fc7fd91..a0fa761 100644 --- a/src/lib/ecore_con/Ecore_Con.h +++ b/src/lib/ecore_con/Ecore_Con.h @@ -1145,6 +1145,8 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs); */ /** + * @internal + * * @brief Creates a local path to connect the socket. * * In the old API, ecore_con_server_add() and @@ -2394,6 +2396,8 @@ EAPI void ecore_con_url_timeout_set(Ecore_Con_Url *url_con, double timeout); EAPI int ecore_con_url_status_code_get(Ecore_Con_Url *url_con); /** + * @internal + * * @brief Sets a maximum upload speed. * * @param url_obj Connection object @@ -2402,6 +2406,8 @@ EAPI int ecore_con_url_status_code_get(Ecore_Con_Url *url_con); EAPI void ecore_con_url_limit_upload_speed(Ecore_Con_Url *url_obj, off_t max_speed); /** + * @internal + * * @brief Sets a maximum download speed. * * @param url_obj Connection object diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index 0836207..886b29d 100755 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -226,6 +226,8 @@ EINA_DEPRECATED EAPI void ecore_evas_app_comp_sync_set(Eina_Bool do_sync) EINA_DEPRECATED EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); /** + * @internal + * * @brief Returns a list of supported engine names. * * @return Newly allocated list with engine names. Engine names @@ -235,6 +237,8 @@ EINA_DEPRECATED EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); EAPI Eina_List *ecore_evas_engines_get(void); /** + * @internal + * * @brief Free list returned by ecore_evas_engines_get() * * @param engines List with engine names @@ -242,6 +246,8 @@ EAPI Eina_List *ecore_evas_engines_get(void); EAPI void ecore_evas_engines_free(Eina_List *engines); /** + * @internal + * * @brief Creates a new Ecore_Evas based on engine name and common parameters. * * @param engine_name Engine name as returned by @@ -394,6 +400,8 @@ EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on); EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets the Ecore_Evas windows focus for a given seat. * * @param ee The Ecore_Evas @@ -410,6 +418,8 @@ EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee); EAPI void ecore_evas_focus_device_set(Ecore_Evas *ee, Eo *seat, Eina_Bool on); /** + * @internal + * * @brief Queries whether an Ecore_Evas' window is focused or not. * * @param ee The Ecore_Evas to set @@ -495,6 +505,8 @@ EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on); EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets another window that this window is a group member of. * * @param ee The Ecore_Evas @@ -511,6 +523,8 @@ EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee); EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group); /** + * @internal + * * @brief Gets the canvas group set. * * This returns the handle set by ecore_evas_window_group_set(). @@ -550,6 +564,8 @@ EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect); EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets The urgent hint flag. * * @param ee The Ecore_Evas @@ -564,6 +580,8 @@ EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee); EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent); /** + * @internal + * * @brief Gets the urgent state on the canvas window. * * This returns the value set by ecore_evas_urgent_set() @@ -577,6 +595,8 @@ EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent); EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets the modal state flag on the canvas window. * * @param ee The Ecore_Evas @@ -592,6 +612,8 @@ EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee); EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal); /** + * @internal + * * @brief Gets The modal flag. * * This returns the value set by ecore_evas_modal_set(). @@ -605,6 +627,8 @@ EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal); EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets the "i demand attention" flag on a canvas window. * * @param ee The Ecore_Evas @@ -619,6 +643,8 @@ EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee); EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand); /** + * @internal + * * @brief Gets the "i demand attention" flag. * * This returns the value set by ecore_evas_demand_attention_set(). @@ -753,6 +779,8 @@ EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee); EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets the window profile. * * @param ee The Ecore_Evas to set @@ -764,6 +792,8 @@ EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee); EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profile); /** + * @internal + * * @brief Gets the window profile. * * @param ee The Ecore_Evas to get the window profile from. @@ -775,6 +805,8 @@ EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profi EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets the array of available window profiles. * * @param ee The Ecore_Evas to set @@ -787,6 +819,8 @@ EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee); EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const char **profiles, const unsigned int count); /** + * @internal + * * @brief Gets the array of available window profiles. * * @param ee The Ecore_Evas to get available window profiles from. @@ -927,6 +961,8 @@ EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee); EAPI Eina_List *ecore_evas_aux_hints_allowed_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Creates an auxiliary hint of the Ecore_Evas. * * @param ee The Ecore_Evas @@ -1255,6 +1291,8 @@ EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee); /* engine/target specific init calls */ /** + * @internal + * * @brief Creates Ecore_Evas using software x11. * * @param disp_name The name of the Ecore_Evas to be created. @@ -1270,6 +1308,8 @@ EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee); EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); /** + * @internal + * * @brief Gets the window from Ecore_Evas using software x11. * * @param ee The Ecore_Evas from which to get the window. @@ -1282,6 +1322,8 @@ EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_ EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets the direct_resize of Ecore_Evas using software x11. * * @param ee The Ecore_Evas in which to set direct resize. @@ -1292,6 +1334,8 @@ EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee); EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); /** + * @internal + * * @brief Gets if the Ecore_Evas is being directly resized using software x11. * * @param ee The Ecore_Evas from which to get direct resize. @@ -1302,6 +1346,8 @@ EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, E EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Adds an extra window on Ecore_Evas using software x11. * * @param ee The Ecore_Evas for which to add the window. @@ -1312,6 +1358,8 @@ EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); /** + * @internal + * * @brief Creates a new Ecore_Evas which does not contain an XWindow. It will * only contain an XPixmap to render to * @@ -1324,6 +1372,8 @@ EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas * EAPI Ecore_Evas *ecore_evas_software_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); /** + * @internal + * * @brief Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas. * * @param ee The Ecore_Evas whose pixmap is desired. @@ -1355,6 +1405,8 @@ EAPI Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get(const Ecore_Evas *ee); #define ECORE_EVAS_GL_X11_SWAP_MODE_TRIPLE ECORE_EVAS_SWAP_MODE_TRIPLE /** + * @internal + * * @brief Creates Ecore_Evas using opengl x11. * * @param disp_name The name of the display of the Ecore_Evas to be created. @@ -1370,6 +1422,8 @@ EAPI Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get(const Ecore_Evas *ee); EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); /** + * @internal + * * @brief Create Ecore_Evas using OpenGL X11, with options * * @param disp_name The name of the display of the Ecore_Evas to be created. @@ -1409,6 +1463,8 @@ EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_ EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets direct_resize for Ecore_Evas using opengl x11. * * @param ee The Ecore_Evas in which to set direct resize. @@ -1419,6 +1475,8 @@ EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee); EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); /** + * @internal + * * @brief Gets if the Ecore_Evas is being directly resized using opengl x11. * * @param ee The Ecore_Evas from which to get direct resize. @@ -1430,6 +1488,8 @@ EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bo EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Adds extra window on Ecore_Evas using opengl x11. * * @param ee The Ecore_Evas for which to add the window. @@ -1440,6 +1500,8 @@ EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee); EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); /** + * @internal + * * @brief Sets the functions to be used before and after the swap callback. * * @param ee The Ecore_Evas for which to set the swap callback. @@ -1452,6 +1514,8 @@ EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ec EAPI void ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Evas *ee, void *data, void (*pre_cb) (void *data, Evas *e), void (*post_cb) (void *data, Evas *e)); /** + * @internal + * * @brief Creates a new Ecore_Evas which does not contain an XWindow. It will * only contain an XPixmap to render to. * @@ -1464,6 +1528,8 @@ EAPI void ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Ev EAPI Ecore_Evas *ecore_evas_gl_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); /** + * @internal + * * @brief Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas. * * @param ee The Ecore_Evas whose pixmap is desired. @@ -1499,6 +1565,8 @@ EAPI Eina_Bool ecore_evas_software_x11_16_direct_resize_get(const Ecore_Ev EAPI void ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win) EINA_DEPRECATED; /** + * @internal + * * @brief Creates Ecore_Evas using fb backend. * * @param disp_name The name of the display to be used. @@ -1538,6 +1606,8 @@ EAPI Ecore_DirectFB_Window *ecore_evas_directfb_window_get(const Ecore_Evas *ee) EAPI Ecore_Evas *ecore_evas_wayland_shm_new(const char *disp_name, unsigned int parent, int x, int y, int w, int h, Eina_Bool frame); /** + * @internal + * * @brief Create an Ecore_Evas window using the wayland-egl engine. * * @param disp_name Name of the Wayland display to connect to. @@ -1564,6 +1634,8 @@ EAPI Ecore_Evas *ecore_evas_wayland_shm_new(const char *disp_name, unsigned EAPI Ecore_Evas *ecore_evas_wayland_egl_new(const char *disp_name, unsigned int parent, int x, int y, int w, int h, Eina_Bool frame); /** + * @internal + * * @brief Begin resizing the Ecore_Evas window. * * @param ee The Ecore_Evas. @@ -1575,6 +1647,8 @@ EAPI Ecore_Evas *ecore_evas_wayland_egl_new(const char *disp_name, unsigned EAPI void ecore_evas_wayland_resize(Ecore_Evas *ee, int location); /** + * @internal + * * @brief Begin moving the Ecore_Evas window. * * @param ee The Ecore_Evas. @@ -1584,6 +1658,8 @@ EAPI void ecore_evas_wayland_resize(Ecore_Evas *ee, int location); EAPI void ecore_evas_wayland_move(Ecore_Evas *ee, int x, int y); /** + * @internal + * * @brief Set the pointer for the Ecore_Evas window. * * @param ee The Ecore_Evas. @@ -1595,6 +1671,8 @@ EAPI void ecore_evas_wayland_move(Ecore_Evas *ee, int x, int y); EAPI void ecore_evas_wayland_pointer_set(Ecore_Evas *ee, int hot_x, int hot_y); /** + * @internal + * * @brief Set the type of the Ecore_Evas window. * * Enables setting the window as top level, menu, dnd, etc. @@ -1608,6 +1686,8 @@ EAPI void ecore_evas_wayland_pointer_set(Ecore_Evas *ee, int hot_x, i EAPI void ecore_evas_wayland_type_set(Ecore_Evas *ee, int type); /** + * @internal + * * @brief Gets the window from Ecore_Evas using the wayland backend. * * @param ee The Ecore_Evas from which to get the window. @@ -1620,6 +1700,8 @@ EAPI void ecore_evas_wayland_type_set(Ecore_Evas *ee, int type); EAPI Ecore_Wl_Window *ecore_evas_wayland_window_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Gets the window from Ecore_Evas using the wayland2 backend. * * @param ee The Ecore_Evas from which to get the window. @@ -1634,6 +1716,8 @@ EAPI Ecore_Wl_Window *ecore_evas_wayland_window_get(const Ecore_Evas *ee); EAPI Ecore_Wl2_Window *ecore_evas_wayland2_window_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Gets the window from Ecore_Evas using the opengl_cocoa backend. * * @param ee The Ecore_Evas from which to get the window. @@ -1648,6 +1732,8 @@ EAPI Ecore_Wl2_Window *ecore_evas_wayland2_window_get(const Ecore_Evas *ee); EAPI Ecore_Cocoa_Window *ecore_evas_cocoa_window_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Create an Ecore_Evas window using the drm engine. * * @param device Name of the Wayland display to connect to. @@ -1668,6 +1754,8 @@ EAPI Ecore_Cocoa_Window *ecore_evas_cocoa_window_get(const Ecore_Evas *ee); EAPI Ecore_Evas *ecore_evas_drm_new(const char *device, unsigned int parent, int x, int y, int w, int h); /** + * @internal + * * @brief Create an Ecore_Evas window using the drm engine with GL support. * * @param device Name of the Wayland display to connect to. @@ -1789,6 +1877,8 @@ EAPI int ecore_evas_tbm_stride_get(Ecore_Evas *ee); /* TIZEN_ONLY(20160330): TBM Backend */ /** + * @internal + * * @brief Creates a new @c Ecore_Evas canvas bound to the Evas * @b ews (Ecore + Evas Single Process Windowing System) engine * @@ -1817,6 +1907,8 @@ EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h); /** + * @internal + * * @brief Returns the backing store image object that represents the given * window in EWS. * @@ -1834,6 +1926,8 @@ EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h); EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Calls the window to be deleted (freed), but can let user decide to * forbid it by using ecore_evas_callback_delete_request_set(). * @@ -1844,6 +1938,8 @@ EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee); EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee); /** + * @internal + * * @brief Creates an Evas image object with image data bound to an * own, internal @c Ecore_Evas canvas wrapper * @@ -1889,6 +1985,8 @@ EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee); EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target); /** + * @internal + * * @brief Retrieve the internal @c Ecore_Evas handle of an image * object created via ecore_evas_object_image_new(). * @@ -1899,6 +1997,8 @@ EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target); EAPI Ecore_Evas *ecore_evas_object_ecore_evas_get(Evas_Object *obj); /** + * @internal + * * @brief Retrieve the canvas bound to the internal @c Ecore_Evas * handle of an image object created via ecore_evas_object_image_new() * @@ -1909,6 +2009,8 @@ EAPI Ecore_Evas *ecore_evas_object_ecore_evas_get(Evas_Object *obj); EAPI Evas *ecore_evas_object_evas_get(Evas_Object *obj); /** + * @internal + * * @brief Creates a new @c Ecore_Evas canvas bound to the Evas * @b gdi (software) engine. * @@ -1932,6 +2034,8 @@ EAPI Ecore_Evas *ecore_evas_software_gdi_new(Ecore_Win32_Window *parent, int height); /** + * @internal + * * @brief Creates a new @c Ecore_Evas canvas bound to the Evas * @b DirectDraw (software) engine. * @@ -1973,6 +2077,8 @@ EAPI Ecore_Evas *ecore_evas_gl_glew_new(Ecore_Win32_Window *parent, EAPI Ecore_Win32_Window *ecore_evas_win32_window_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Creates a new @c Ecore_Evas canvas bound to the Evas * @b SDL engine. * @@ -1990,6 +2096,8 @@ EAPI Ecore_Evas *ecore_evas_sdl_new(const char* name, int w, int h, int full EAPI Ecore_Evas *ecore_evas_sdl16_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha); /** + * @internal + * * @brief Creates a new @c Ecore_Evas canvas bound to the Evas * @b SDL + gl engine. * @@ -2035,6 +2143,8 @@ EAPI Ecore_Evas *ecore_evas_software_wince_gdi_new(Ecore_WinCE_Window *paren EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee) EINA_DEPRECATED; /** + * @internal + * * @brief Creates a new @c Ecore_Evas canvas bound to the Evas * @b Cocoa engine. * @@ -2054,6 +2164,8 @@ EAPI Ecore_Evas *ecore_evas_cocoa_new(Ecore_Cocoa_Window *parent, int h); /** + * @internal + * * @brief Creates a new @c Ecore_Evas canvas bound to the Evas * @b psl1ght engine. * @@ -2068,6 +2180,8 @@ EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h) EINA_DEP /* generic manipulation calls */ /** + * @internal + * * @brief Gets the engine name used by this Ecore_Evas(window). * * @param ee Ecore_Evas whose engine's name is desired @@ -2248,6 +2362,8 @@ EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Eve EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** + * @internal + * * @brief Sets a callback for Ecore_Evas focus in events. * * @param ee The Ecore_Evas to set callbacks on @@ -2265,6 +2381,8 @@ EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Ev EAPI void ecore_evas_callback_focus_device_in_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func); /** + * @internal + * * @brief Sets a callback for Ecore_Evas focus out events. * * @param ee The Ecore_Evas to set callbacks on @@ -2310,6 +2428,8 @@ EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** + * @internal + * * @brief Sets a callback for Ecore_Evas mouse in events. * * @param ee The Ecore_Evas to set callbacks on @@ -2326,6 +2446,8 @@ EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Eve EAPI void ecore_evas_callback_device_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func); /** + * @internal + * * @brief Sets a callback for Ecore_Evas mouse out events. * * @param ee The Ecore_Evas to set callbacks on @@ -2442,6 +2564,8 @@ EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas EAPI Evas *ecore_evas_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Provides Managed move co-ordinates for an Ecore_Evas. * * @param ee The Ecore_Evas to move @@ -2453,6 +2577,8 @@ EAPI Evas *ecore_evas_get(const Ecore_Evas *ee); EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y); /** + * @internal + * * @brief Sets whether an Ecore_Evas is shaped or not. * * @param ee The Ecore_Evas to shape. @@ -2468,6 +2594,8 @@ EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y); EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped); /** + * @internal + * * @brief Queries whether an Ecore_Evas is shaped or not. * * @param ee The Ecore_Evas to query. @@ -2663,6 +2791,8 @@ EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int lay EAPI void ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y); /** + * @internal + * * @brief Sets the cursor for the default pointer device. * * @param ee The Ecore_Evas @@ -2697,6 +2827,8 @@ EAPI void ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, EAPI Evas_Object* ecore_evas_cursor_unset(Ecore_Evas *ee); /** + * @internal + * * @brief Unsets the cursor of the specified pointer device. * * @param ee The Ecore_Evas to unset the cursor. @@ -2714,6 +2846,8 @@ EAPI Evas_Object* ecore_evas_cursor_unset(Ecore_Evas *ee); EAPI Evas_Object *ecore_evas_cursor_device_unset(Ecore_Evas *ee, Efl_Input_Device *pointer); /** + * @internal + * * @brief Sets the cursor of an Ecore_Evas specified pointer device. * * @param ee The Ecore_Evas @@ -2734,6 +2868,8 @@ EAPI void ecore_evas_object_cursor_device_set(Ecore_Evas *ee, Efl_Input_Device * Evas_Object *obj, int layer, int hot_x, int hot_y); /** + * @internal + * * @brief Gets information about an Ecore_Evas' specified pointer device. * * @param ee The Ecore_Evas @@ -2753,6 +2889,8 @@ EAPI Eina_Bool ecore_evas_cursor_device_get(const Ecore_Evas *ee, Efl_Input_Devi int *hot_x, int *hot_y); /** + * @internal + * * @brief Tells the WM whether or not to ignore an Ecore_Evas' window. * * @param ee The Ecore_Evas. @@ -2764,6 +2902,8 @@ EAPI Eina_Bool ecore_evas_cursor_device_get(const Ecore_Evas *ee, Efl_Input_Devi EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on); /** + * @internal + * * @brief Queries whether an Ecore_Evas' window is overridden or not. * * @param ee The Ecore_Evas to set. @@ -2772,6 +2912,8 @@ EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on); EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets whether or not an Ecore_Evas' window should avoid damage. * * @param ee The Ecore_Evas @@ -2800,6 +2942,8 @@ EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee); EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on); /** + * @internal + * * @brief Queries whether an Ecore_Evas' window avoids damage or not. * * @param ee The Ecore_Evas to set @@ -2824,6 +2968,8 @@ EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn); EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Sets the sticky state of an Ecore_Evas window. * * @param ee The Ecore_Evas whose window's sticky state is set. @@ -2832,6 +2978,8 @@ EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee); EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky); /** + * @internal + * * @brief Returns the sticky state of an Ecore_Evas' window. * * @param ee The Ecore_Evas whose window's sticky state is returned. @@ -2886,6 +3034,8 @@ EAPI void ecore_evas_input_event_register(Ecore_Evas *ee); // TIZEN_ONLY(20160429): add multi_info(radius, pressure and angle) to Evas_Event_Mouse_XXX /** + * @internal + * * @brief Registers an @c Ecore_Evas to receive events through ecore_input_evas. * * @param ee The @c Ecore_Evas handle. @@ -2902,6 +3052,8 @@ EAPI void ecore_evas_input_event_register_with_multi(Ecore_Evas *ee); // TIZEN_ONLY(20170925): add multi_info(radius, pressure and angle) to Evas_Event_Mouse_XXX /** + * @internal + * * @brief Registers an @c Ecore_Evas to receive events through ecore_input_evas. * * @param ee The @c Ecore_Evas handle. @@ -2989,6 +3141,8 @@ EAPI void ecore_evas_draw_frame_set(Ecore_Evas *ee, Eina_Bool draw_frame) EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee) EINA_DEPRECATED; /** + * @internal + * * @brief Sets shadow geometry for client-side decorations. * * Note that the framespace contains both a shadow or glow around the window, @@ -2999,6 +3153,8 @@ EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee) EINA_DEPRECATED EAPI void ecore_evas_shadow_geometry_set(Ecore_Evas *ee, int x, int y, int w, int h); /** + * @internal + * * @brief Gets shadow geometry for client-side decorations. * * Note that the framespace contains both a shadow or glow around the window, @@ -3009,6 +3165,8 @@ EAPI void ecore_evas_shadow_geometry_set(Ecore_Evas *ee, int x, int y, in EAPI void ecore_evas_shadow_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); /** + * @internal + * * @brief Associates the given object to this ecore evas. * * @param ee The Ecore_Evas to associate to @a obj @@ -3052,6 +3210,8 @@ EAPI void ecore_evas_shadow_geometry_get(const Ecore_Evas *ee, int *x, in EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags); /** + * @internal + * * @brief Cancels the association set with ecore_evas_object_associate(). * * @param ee The Ecore_Evas to dissociate from @a obj @@ -3061,6 +3221,8 @@ EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj); /** + * @internal + * * @brief Gets the object associated with @p ee. * * @param ee The Ecore_Evas to get the object from. @@ -3072,6 +3234,8 @@ EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee); EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage); /** + * @internal + * * @brief Gets a list of all the ecore_evases. * * @return A list of ecore_evases. @@ -3083,6 +3247,8 @@ EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Get EAPI Eina_List *ecore_evas_ecore_evas_list_get(void); /** + * @internal + * * @brief Gets a list of all the sub ecore_evases. * * @param ee Ecore_Evas to get the list from. @@ -3091,6 +3257,8 @@ EAPI Eina_List *ecore_evas_ecore_evas_list_get(void); EAPI Eina_List *ecore_evas_sub_ecore_evas_list_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Set the window's client leader. * * @param ee Ecore_Evas for the window. @@ -3103,6 +3271,8 @@ EAPI Eina_List *ecore_evas_sub_ecore_evas_list_get(const Ecore_Evas *ee); EAPI void ecore_evas_x11_leader_set(Ecore_Evas *ee, Ecore_X_Window win); /** + * @internal + * * @brief Get the client leader. * * @param ee Ecore_Evas for the window. @@ -3113,6 +3283,8 @@ EAPI void ecore_evas_x11_leader_set(Ecore_Evas *ee, Ecore_X_Window win EAPI Ecore_X_Window ecore_evas_x11_leader_get(Ecore_Evas *ee); /** + * @internal + * * @brief Reset the client leader to default. * * @param ee Ecore_Evas for the window. @@ -3122,6 +3294,8 @@ EAPI Ecore_X_Window ecore_evas_x11_leader_get(Ecore_Evas *ee); EAPI void ecore_evas_x11_leader_default_set(Ecore_Evas *ee); /** + * @internal + * * @brief Set the rectangular region that can "contain" the pointer, replacing * any previously set region. * @@ -3139,6 +3313,8 @@ EAPI void ecore_evas_x11_leader_default_set(Ecore_Evas *ee); EAPI void ecore_evas_x11_shape_input_rectangle_set(Ecore_Evas *ee, int x, int y, int w, int h); /** + * @internal + * * @brief Extends the pointer containment region to the union of the new * and existing input rectangle. * @@ -3156,6 +3332,8 @@ EAPI void ecore_evas_x11_shape_input_rectangle_set(Ecore_Evas *ee, int EAPI void ecore_evas_x11_shape_input_rectangle_add(Ecore_Evas *ee, int x, int y, int w, int h); /** + * @internal + * * @brief Modifies the pointer containment region to subtract a rectangular region from it. * * @param ee The Ecore_Evas @@ -3172,6 +3350,8 @@ EAPI void ecore_evas_x11_shape_input_rectangle_add(Ecore_Evas *ee, int EAPI void ecore_evas_x11_shape_input_rectangle_subtract(Ecore_Evas *ee, int x, int y, int w, int h); /** + * @internal + * * @brief Disables input for the window. * * @param ee The Ecore_Evas @@ -3184,6 +3364,8 @@ EAPI void ecore_evas_x11_shape_input_rectangle_subtract(Ecore_Evas *ee EAPI void ecore_evas_x11_shape_input_empty(Ecore_Evas *ee); /** + * @internal + * * @brief Unsets the pointer containment for the window. * * @param ee The Ecore_Evas @@ -3196,6 +3378,8 @@ EAPI void ecore_evas_x11_shape_input_empty(Ecore_Evas *ee); EAPI void ecore_evas_x11_shape_input_reset(Ecore_Evas *ee); /** + * @internal + * * @brief Applies the pointer containment region to the client window. * * @param ee The Ecore_Evas @@ -3252,6 +3436,8 @@ EAPI Evas_Object *ecore_evas_vnc_start(Ecore_Evas *ee, const char *addr, int por #endif /** + * @internal + * * @brief Sets a callback for building new Evas. * * @param func The function to call @@ -3276,6 +3462,8 @@ EAPI void ecore_evas_callback_new_set(Evas *(*func)(int w, int h)); */ /** + * @internal + * * @brief Sets the engine to be used by the backing store engine. * * @param engine The engine to be set. @@ -3287,6 +3475,8 @@ EAPI void ecore_evas_callback_new_set(Evas *(*func)(int w, int h)); EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options); /** + * @internal + * * @brief Reconfigures the backing store used. * * @param x The X coordinate to be used. @@ -3300,6 +3490,8 @@ EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h); /** + * @internal + * * @brief Returns the internal backing store in use. * * @return The internal backing store in use. @@ -3313,6 +3505,8 @@ EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h); EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void); /** + * @internal + * * @brief Returns the internal backing store in use. * * @return The internal backing store in use. @@ -3326,11 +3520,15 @@ EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void); EAPI Evas *ecore_evas_ews_evas_get(void); /** + * @internal + * * @brief Gets the current background. */ EAPI Evas_Object *ecore_evas_ews_background_get(void); /** + * @internal + * * @brief Sets the current background, must be created by evas ecore_evas_ews_evas_get(). * * @param o The Evas_Object for which to set the background. @@ -3344,6 +3542,8 @@ EAPI Evas_Object *ecore_evas_ews_background_get(void); EAPI void ecore_evas_ews_background_set(Evas_Object *o); /** + * @internal + * * @brief Returns all Ecore_Evas* created by EWS. * * @return An eina list of Ecore_evases. @@ -3355,6 +3555,8 @@ EAPI void ecore_evas_ews_background_set(Evas_Object *o); EAPI const Eina_List *ecore_evas_ews_children_get(void); /** + * @internal + * * @brief Sets the identifier of the manager taking care of internal windows. * * @param manager any unique identifier address. @@ -3369,6 +3571,8 @@ EAPI const Eina_List *ecore_evas_ews_children_get(void); EAPI void ecore_evas_ews_manager_set(const void *manager); /** + * @internal + * * @brief Gets the identifier of the manager taking care of internal windows. * * @return the value set by ecore_evas_ews_manager_set() @@ -3419,6 +3623,8 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_ADD; /**< this event is received when a p EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a plug has disconnected from an extn socket @since 1.2 */ /** + * @internal + * * @brief Creates a new Ecore_Evas canvas for the new external ecore evas socket * * @param w The width of the canvas, in pixels @@ -3501,6 +3707,8 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a p EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h); /** + * @internal + * * @brief Creates a socket to provide the service for external ecore evas * socket. * @@ -3529,6 +3737,8 @@ EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h); EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname, int svcnum, Eina_Bool svcsys); /** + * @internal + * * @brief Sets the blocking about mouse events to Ecore Evas. * * @param ee The Ecore_Evas. @@ -3541,6 +3751,8 @@ EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname EAPI void ecore_evas_extn_socket_events_block_set(Ecore_Evas *ee, Eina_Bool events_block); /** + * @internal + * * @brief Gets the blocking about mouse events to Ecore Evas. * * @param ee The Ecore_Evas. @@ -3553,6 +3765,8 @@ EAPI void ecore_evas_extn_socket_events_block_set(Ecore_Evas *ee, Eina_Bool even EAPI Eina_Bool ecore_evas_extn_socket_events_block_get(Ecore_Evas *ee); /** + * @internal + * * @brief Locks the pixel data so the socket cannot change it. * * @param obj The image object returned by ecore_evas_extn_plug_new() to lock @@ -3577,6 +3791,8 @@ EAPI Eina_Bool ecore_evas_extn_socket_events_block_get(Ecore_Evas *ee); EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj); /** + * @internal + * * @brief Unlocks the pixel data so the socket can change it again. * * @param obj The image object returned by ecore_evas_extn_plug_new() to unlock @@ -3592,6 +3808,8 @@ EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj); EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj); /** + * @internal + * * @brief Creates a new external ecore evas plug. * * @param ee_target The Ecore_Evas containing the canvas in which the new image object will live. @@ -3623,6 +3841,8 @@ EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj); EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target); /** + * @internal + * * @brief Connects an external ecore evas plug to service provided by external * ecore evas socket. * @@ -3643,6 +3863,8 @@ EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcnam // TIZEN_ONLY(20160120): support visibility_change event /** + * @internal + * * @brief Query if the ecore evas is obscured or unobscured. * * @param ee The Ecore_Evas @@ -3684,6 +3906,8 @@ EAPI void ecore_evas_pointer_xy_get(const Ecore_Evas *ee, Evas_Coord *x, Evas_Co EAPI Eina_Bool ecore_evas_pointer_warp(const Ecore_Evas *ee, Evas_Coord x, Evas_Coord y); /** + * @internal + * * @brief Retrieves the coordinates of the mouse pointer. * * @param ee The Ecore_Evas containing the pointer @@ -3695,6 +3919,8 @@ EAPI Eina_Bool ecore_evas_pointer_warp(const Ecore_Evas *ee, Evas_Coord x, Evas_ EAPI void ecore_evas_pointer_device_xy_get(const Ecore_Evas *ee, const Efl_Input_Device *pointer, Evas_Coord *x, Evas_Coord *y); /** + * @internal + * * @brief Retrieves the Visual used for pixmap creation. * * @param ee The Ecore_Evas containing the pixmap @@ -3709,6 +3935,8 @@ EAPI void ecore_evas_pointer_device_xy_get(const Ecore_Evas *ee, const Efl_Input EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Retrieves the Colormap used for pixmap creation. * * @param ee The Ecore_Evas containing the pixmap @@ -3723,6 +3951,8 @@ EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee); EAPI unsigned long ecore_evas_pixmap_colormap_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Retrieves the depth used for pixmap creation. * * @param ee The Ecore_Evas containing the pixmap diff --git a/src/lib/ecore_imf/Ecore_IMF.h b/src/lib/ecore_imf/Ecore_IMF.h index d7e1b39..649fa14 100644 --- a/src/lib/ecore_imf/Ecore_IMF.h +++ b/src/lib/ecore_imf/Ecore_IMF.h @@ -2014,6 +2014,8 @@ EAPI void ecore_imf_context_bidi_direction_set(Ecore_IM EAPI Ecore_IMF_BiDi_Direction ecore_imf_context_bidi_direction_get(Ecore_IMF_Context *ctx); /** + * @internal + * * @ingroup Ecore_IMF_Context_Group * @brief Get the keyboard mode on the input panel. * @@ -2025,6 +2027,8 @@ EAPI Ecore_IMF_BiDi_Direction ecore_imf_context_bidi_direction_get(Ecore_IM EAPI Ecore_IMF_Input_Panel_Keyboard_Mode ecore_imf_context_keyboard_mode_get(Ecore_IMF_Context *ctx); /** + * @internal + * * @ingroup Ecore_IMF_Context_Group * @brief Set the prediction hint string to deliver to the input panel. * @@ -2041,6 +2045,8 @@ EAPI Ecore_IMF_Input_Panel_Keyboard_Mode ecore_imf_context_keyboard_mode_get(Eco EAPI void ecore_imf_context_prediction_hint_set(Ecore_IMF_Context *ctx, const char *prediction_hint); /** + * @internal + * * @ingroup Ecore_IMF_Context_Group * @brief Sets the allowed MIME type to deliver to the input panel. * @@ -2058,6 +2064,8 @@ EAPI void ecore_imf_context_prediction_hint_set(Ecore_I EAPI void ecore_imf_context_mime_type_accept_set(Ecore_IMF_Context *ctx, const char *mime_type); /** + * @internal + * * @ingroup Ecore_IMF_Context_Group * @brief Sets the x,y coordinates of the input panel. * @remarks This API can be used in floating mode. The coordinate is set to the last position of input panel when the values of x and y are -1, -1. @@ -2071,6 +2079,8 @@ EAPI void ecore_imf_context_mime_type_accept_set(Ecore_I EAPI void ecore_imf_context_input_panel_position_set(Ecore_IMF_Context *ctx, int x, int y); /** + * @internal + * * @ingroup Ecore_IMF_Context_Group * @brief Sets the prediction hint data at the specified key * @@ -2091,6 +2101,8 @@ EAPI void ecore_imf_context_input_panel_position_set(Eco EAPI Eina_Bool ecore_imf_context_prediction_hint_hash_set(Ecore_IMF_Context *ctx, const char *key, const char *value); /** + * @internal + * * @ingroup Ecore_IMF_Context_Group * @brief Removes the prediction hint data identified by a key * @@ -2107,6 +2119,8 @@ EAPI Eina_Bool ecore_imf_context_prediction_hint_hash_set(Eco EAPI Eina_Bool ecore_imf_context_prediction_hint_hash_del(Ecore_IMF_Context *ctx, const char *key); /** + * @internal + * * @ingroup Ecore_IMF_Context_Group * @brief Gets the hash table of prediction hint data * diff --git a/src/lib/ecore_input/Ecore_Input.h b/src/lib/ecore_input/Ecore_Input.h index 2ae7293..8e799dc 100644 --- a/src/lib/ecore_input/Ecore_Input.h +++ b/src/lib/ecore_input/Ecore_Input.h @@ -551,6 +551,8 @@ extern "C" { // /** + * @internal + * * Set deadzone of joystick event for an axis. * * The axis type joystick event occurs without user's control if joystick is @@ -564,6 +566,8 @@ extern "C" { EAPI void ecore_input_joystick_event_axis_deadzone_set(int event_axis_deadzone); /** + * @internal + * * Get deadzone of joystick event for an axis. * * @return deadzone of joystick event for an axis. @@ -572,6 +576,8 @@ extern "C" { EAPI int ecore_input_joystick_event_axis_deadzone_get(void); /** + * @internal + * * Get name of joystick * * This function returns the name string of the joysitck. If @p index diff --git a/src/lib/eina/eina_accessor.h b/src/lib/eina/eina_accessor.h index 96f9549..1c1ed51 100644 --- a/src/lib/eina/eina_accessor.h +++ b/src/lib/eina/eina_accessor.h @@ -359,6 +359,8 @@ EAPI Eina_Bool eina_accessor_unlock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1) (counter)++) /** + * @internal + * * @brief Creates an Eina_Accessor that wraps a plain fixed size C array * * @param[in] array The array diff --git a/src/lib/eina/eina_binbuf.h b/src/lib/eina/eina_binbuf.h index 1694020..dbc9d3a 100644 --- a/src/lib/eina/eina_binbuf.h +++ b/src/lib/eina/eina_binbuf.h @@ -135,6 +135,8 @@ EAPI void eina_binbuf_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); /** + * @internal + * * @brief Expands a buffer, making room for at least @p minimum_unused_space. * * @param[in,out] buf The Buffer to expand. @@ -165,6 +167,8 @@ EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); EAPI Eina_Rw_Slice eina_binbuf_expand(Eina_Binbuf *buf, size_t minimum_unused_space) EINA_ARG_NONNULL(1); /** + * @internal + * * @brief Marks more bytes as used. * * @param[in,out] buf The string buffer. @@ -373,6 +377,8 @@ EAPI size_t eina_binbuf_length_get(const Eina_Binbuf *buf) EINA_ARG_NONNULL(1) E EAPI Eina_Slice eina_binbuf_slice_get(const Eina_Binbuf *buf) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); /** + * @internal + * * @brief Gets a read-write slice of the buffer contents. * * @param[in,out] buf The string buffer. diff --git a/src/lib/eina/eina_file.h b/src/lib/eina/eina_file.h index c6bc94b..5c4ccb7 100644 --- a/src/lib/eina/eina_file.h +++ b/src/lib/eina/eina_file.h @@ -778,6 +778,8 @@ static inline size_t eina_file_path_join(char *dst, EAPI Eina_Bool eina_file_unlink(const char *pathname); /** + * @internal + * * @brief Make sure a file descriptor will be closed on exec. * @details This function is a wrapper around the fnctl() system call. It makes sure * that the fd will be closed whenever exec is called. diff --git a/src/lib/eina/eina_freeq.h b/src/lib/eina/eina_freeq.h index acbc59b..cc20ad0 100644 --- a/src/lib/eina/eina_freeq.h +++ b/src/lib/eina/eina_freeq.h @@ -62,18 +62,18 @@ * will be filled with this pattern value in every byte. The default value * is 0x77 (119). Memory is only filled if the size of the allocation is * less than the max that you can adjust with EINA_FREEQ_FILL_MAX. - * + * * @{ * * @since 1.19 - * + * * @typedef Eina_FreeQ * * A queue of pointers to free in the future. You may create custom free * queues of your own to defer freeing, use the main free queue where the * mainloop will free things as it iterates, or eina will free everything * on shut down. - * + * */ typedef struct _Eina_FreeQ Eina_FreeQ; @@ -133,7 +133,7 @@ eina_freeq_new(Eina_FreeQ_Type type); * @brief Free a free queue and anything that is queued in it. * * @param[in,out] fq The free queue to free and clear. - * + * * @since 1.19 */ EAPI void @@ -150,10 +150,12 @@ EAPI Eina_FreeQ_Type eina_freeq_type_get(Eina_FreeQ *fq); /** + * @internal + * * @brief Get the main loop free queue. * * @return The main loop free queue. - * + * * @since 1.19 */ EAPI Eina_FreeQ * @@ -185,13 +187,15 @@ eina_freeq_count_max_set(Eina_FreeQ *fq, int count); * * @param[in] fq The free queue to query * @return The maximum number of free items allowed or -1 for infinity - * + * * @since 1.19 */ EAPI int eina_freeq_count_max_get(Eina_FreeQ *fq); /** + * @internal + * * @brief Set the maximum amount of memory allowed * * @param[in,out] fq The free queue to alter @@ -207,7 +211,7 @@ eina_freeq_count_max_get(Eina_FreeQ *fq); * * @note Setting a memory limit on a postponed free queue leads to undefined * behavior. - * + * * @since 1.19 */ EAPI void @@ -232,7 +236,7 @@ eina_freeq_mem_max_get(Eina_FreeQ *fq); * This will free and thus remove all queued items from the free queue when * this function is called. When it returns the free queue should be * empty. - * + * * @since 1.19 */ EAPI void @@ -248,7 +252,7 @@ eina_freeq_clear(Eina_FreeQ *fq); * and thus reduce the amount of memory it is holding on to. This function * will return once it has removed @p count items or there are no more items * to remove from the queue. - * + * * @since 1.19 */ EAPI void @@ -259,13 +263,15 @@ eina_freeq_reduce(Eina_FreeQ *fq, int count); * * @param[in] fq The free queue to query * @return EINA_TRUE if there are items to free, EINA_FALSE otherwise - * + * * @since 1.19 */ EAPI Eina_Bool eina_freeq_ptr_pending(Eina_FreeQ *fq); /** + * @internal + * * @brief Add a pointer with free function and size to the free queue * * @param[in,out] fq The free queue to add the pointer to @@ -303,7 +309,7 @@ eina_freeq_ptr_pending(Eina_FreeQ *fq); * This note does not apply if you use a size of 0 for the pointer, but then * you lose canary debugging ability when using 0 sized pointers on the free * queue. - * + * * @since 1.19 */ EAPI void @@ -315,10 +321,10 @@ eina_freeq_ptr_add(Eina_FreeQ *fq, void *ptr, void (*free_func) (void *ptr), siz * @param[in] ptr The pointer to free * @param[in] free_func The function used to free the pointer with * @param[in] size The size of the data the pointer points to - * + * * This is the same as eina_freeq_ptr_add() but the main free queue is * fetched by eina_freeq_main_get(). - * + * * @since 1.19 */ static inline void @@ -331,12 +337,12 @@ eina_freeq_ptr_main_add(void *ptr, void (*free_func) (void *ptr), size_t size) * @brief Convenience macro for well known structures and types * * @param[in] ptr The pointer to free - * + * * This is the same as eina_freeq_ptr_main_add() but the free function is * assumed to be the libc free() function, and size is provided by * sizeof(*ptr), so it will not work on void pointers or will be inaccurate * for pointers to arrays. For arrays please use EINA_FREEQ_ARRAY_FREE() - * + * * @since 1.19 */ #define EINA_FREEQ_FREE(ptr) eina_freeq_ptr_main_add(ptr, NULL, sizeof(*(ptr))) @@ -345,12 +351,12 @@ eina_freeq_ptr_main_add(void *ptr, void (*free_func) (void *ptr), size_t size) * @brief Convenience macro for well known structures and types * * @param[in] ptr The pointer to free - * + * * This is the same as eina_freeq_ptr_main_add() but the free function is * assumed to be the libc free() function, and size is provided by * sizeof(*ptr), so it will not work on void pointers. Total size is multiplied * by the count @p n so it should work well for arrays of types. - * + * * @since 1.19 */ #define EINA_FREEQ_N_FREE(ptr, n) eina_freeq_ptr_main_add(ptr, NULL, sizeof(*(ptr)) * n) diff --git a/src/lib/eina/eina_iterator.h b/src/lib/eina/eina_iterator.h index 092a89c..859cf6b 100644 --- a/src/lib/eina/eina_iterator.h +++ b/src/lib/eina/eina_iterator.h @@ -285,6 +285,8 @@ EAPI Eina_Bool eina_iterator_lock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1); EAPI Eina_Bool eina_iterator_unlock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1); /** + * @internal + * * @brief Creates an Eina_Iterator that iterates through a * NUL-terminated C array. * @@ -302,6 +304,8 @@ EAPI Eina_Bool eina_iterator_unlock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1) EAPI Eina_Iterator *eina_carray_iterator_new(void** array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; /** + * @internal + * * @brief Creates an Eina_Iterator that iterates through a * C array of specified size. * @@ -350,6 +354,8 @@ EAPI Eina_Iterator *eina_carray_length_iterator_new(void** array, unsigned int s EAPI Eina_Iterator* eina_iterator_filter_new(Eina_Iterator *original, Eina_Each_Cb filter, Eina_Free_Cb free_cb, void *data) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; /** + * @internal + * * @brief Creates an Eina_Iterator that iterates through a series * of Eina_Iterator. * diff --git a/src/lib/eina/eina_str.h b/src/lib/eina/eina_str.h index 961ac58..f08f4c5 100644 --- a/src/lib/eina/eina_str.h +++ b/src/lib/eina/eina_str.h @@ -358,6 +358,8 @@ static inline size_t eina_strlen_bounded(const char *str, size_t maxlen) EINA_PU EAPI unsigned char *eina_memdup(unsigned char *mem, size_t size, Eina_Bool terminate); /** + * @internal + * * @brief Creates and update the buffer based on strftime output. * * @param[in] tm Pointer to a tm structure needed by strftime. diff --git a/src/lib/eina/eina_strbuf.h b/src/lib/eina/eina_strbuf.h index 73d1664..57e66f9 100644 --- a/src/lib/eina/eina_strbuf.h +++ b/src/lib/eina/eina_strbuf.h @@ -662,6 +662,8 @@ EAPI void eina_strbuf_rtrim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); EAPI void eina_strbuf_tolower(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); /** + * @internal + * * @brief Obtains substring from a source string buffer. * * @param[in] buf The string buffer. @@ -713,6 +715,8 @@ EAPI Eina_Rw_Slice eina_strbuf_rw_slice_get(const Eina_Strbuf *buf) EINA_WARN_UN EAPI char* eina_strbuf_release(Eina_Strbuf *buf) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); /** + * @internal + * * @brief Appends a strftime-style timestamp to the buffer. * * @param[in,out] buf The string buffer. @@ -741,6 +745,8 @@ EAPI char* eina_strbuf_release(Eina_Strbuf *buf) EINA_WARN_UNUSED_RESULT EINA_AR EAPI Eina_Bool eina_strbuf_append_strftime(Eina_Strbuf *buf, const char *fmt, const struct tm *tm); /** + * @internal + * * @brief Inserts a strftime-style timestamp into the buffer. * * @param[in,out] buf The string buffer. diff --git a/src/lib/eina/eina_thread.h b/src/lib/eina/eina_thread.h index 93542f2..83a7eee 100644 --- a/src/lib/eina/eina_thread.h +++ b/src/lib/eina/eina_thread.h @@ -143,6 +143,8 @@ EAPI void *eina_thread_join(Eina_Thread t); EAPI Eina_Bool eina_thread_name_set(Eina_Thread t, const char *name); /** + * @internal + * * @brief Attempts to cancel a running thread. * * This function sends a cancellation request to the thread, however @@ -166,6 +168,8 @@ EAPI Eina_Bool eina_thread_name_set(Eina_Thread t, const char *name); EAPI Eina_Bool eina_thread_cancel(Eina_Thread t); /** + * @internal + * * @brief Enables or disables if the current thread can be canceled. * * By default eina_thread_create() will return a thread with @@ -204,6 +208,8 @@ EAPI Eina_Bool eina_thread_cancel(Eina_Thread t); EAPI Eina_Bool eina_thread_cancellable_set(Eina_Bool cancellable, Eina_Bool *was_cancellable); /** + * @internal + * * If the current thread is cancellable, this introduces a * cancellation check point. Otherwise it's a no-operation. * @@ -290,6 +296,8 @@ EAPI void eina_thread_cancel_checkpoint(void); typedef void *(*Eina_Thread_Cancellable_Run_Cb)(void *data); /** + * @internal + * * This function will setup cleanup callback, turn the thread * cancellable, execute the given callback, reset the cancellable * state to its old value, run the cleanup callback and then return diff --git a/src/lib/eina/eina_value.h b/src/lib/eina/eina_value.h index 6197f7c..1931f2d 100644 --- a/src/lib/eina/eina_value.h +++ b/src/lib/eina/eina_value.h @@ -1109,6 +1109,8 @@ EAPI Eina_Bool eina_value_convert(const Eina_Value *value, Eina_Value *convert) EINA_ARG_NONNULL(1, 2); /** + * @internal + * * @brief Converts one value to Eina_Binbuf. * * @param[in,out] value Source value object. diff --git a/src/lib/embryo/Embryo.h b/src/lib/embryo/Embryo.h index 84e39ac..fe27eb6 100644 --- a/src/lib/embryo/Embryo.h +++ b/src/lib/embryo/Embryo.h @@ -465,6 +465,8 @@ extern "C" { /** + * @internal + * * Initialises the Embryo library. * @return The number of times the library has been initialised without being * shut down. @@ -473,6 +475,8 @@ extern "C" { EAPI int embryo_init(void); /** + * @internal + * * Shuts down the Embryo library. * @return The number of times the library has been initialised without being * shutdown. diff --git a/src/lib/eo/Eo.h b/src/lib/eo/Eo.h index 0ebbd53..bce4ac1 100644 --- a/src/lib/eo/Eo.h +++ b/src/lib/eo/Eo.h @@ -997,6 +997,8 @@ EAPI Eina_Bool efl_object_override(Eo *obj, const Efl_Object_Ops *ops); const Efl_Object_Ops ops = { _##ops##_descs, EINA_C_ARRAY_LENGTH(_##ops##_descs) } /** + * @internal + * * @brief Check if an object "is a" klass. * @param obj The object to check * @param klass The klass to check against. @@ -1622,6 +1624,8 @@ typedef Eo *(*Efl_Substitute_Ctor_Cb)(void *data, Eo *obj_id); EAPI Eo * _efl_add_internal_start_bindings(const char *file, int line, const Efl_Class *klass_id, Eo *parent, Eina_Bool ref, Eina_Bool is_fallback, Efl_Substitute_Ctor_Cb substitute_ctor, void *sub_ctor_data); /** + * @internal + * * @brief Unrefs the object and reparents it to NULL. * * Because efl_del() unrefs and reparents to NULL, it doesn't really delete the @@ -1777,6 +1781,8 @@ EAPI void efl_data_xunref_internal(const Eo *obj, void *data, const Eo *ref_obj) EAPI Eo *efl_ref(const Eo *obj); /** + * @internal + * * @brief Decrement the object's reference count by 1 and free it if needed. * @param obj the object to work on. * diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h index baf6569..9099e97 100644 --- a/src/lib/evas/Evas_Common.h +++ b/src/lib/evas/Evas_Common.h @@ -940,6 +940,8 @@ EAPI void evas_render_updates_free(Eina_List *updates); EAPI Evas_Device *evas_device_add(Evas *e); /** + * @internal + * * Add a new device type * * @param e The canvas to create the device node for. @@ -3043,6 +3045,8 @@ EAPI Eina_Bool evas_cserve_stats_get(Evas_Cserve_Stats *stats) EINA_WARN_UNUSE EAPI void evas_cserve_image_cache_contents_clean(Evas_Cserve_Image_Cache *cache); /** + * @internal + * * Retrieves the current configuration of the Evas image caching * server. * @@ -3062,6 +3066,8 @@ EAPI void evas_cserve_image_cache_contents_clean(Evas_Cserve_Image_Cache EAPI Eina_Bool evas_cserve_config_get(Evas_Cserve_Config *config) EINA_WARN_UNUSED_RESULT; /** + * @internal + * * Changes the configurations of the Evas image caching server. * * @param config A bitmap cache configuration handle with fields set diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index e4e3a58..4bfbf57 100755 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -993,6 +993,8 @@ EAPI Evas_Modifier_Mask evas_key_modifier_mask_get(const Evas *evas, const char EAPI Eina_Bool evas_key_modifier_is_set(const Evas_Modifier *m, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); /** + * @internal + * * Checks the state of a given modifier key of a given seat, at the time of the * call. If the modifier is set, such as shift being pressed, this * function returns @c Eina_True. @@ -1040,6 +1042,8 @@ EAPI Eina_Bool evas_seat_key_modifier_is_set(const Evas_Modifier *m, EAPI Eina_Bool evas_key_lock_is_set(const Evas_Lock *l, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); /** + * @internal + * * Checks the state of a given lock key of a given seat, at the time of the call. If * the lock is set, such as caps lock, this function returns @c * Eina_True. @@ -3489,6 +3493,8 @@ EAPI void evas_object_intercept_focus_set_callback_add(Evas_Object *obj, Evas_O EAPI void *evas_object_intercept_focus_set_callback_del(Evas_Object *obj, Evas_Object_Intercept_Focus_Set_Cb func) EINA_ARG_NONNULL(1, 2); /** + * @internal + * * Set the callback function that intercepts a focus set event of an object. * * @param obj The given canvas object pointer. @@ -3506,6 +3512,8 @@ EAPI void *evas_object_intercept_focus_set_callback_del(Evas_Object *obj, Evas_O EAPI void evas_object_intercept_device_focus_set_callback_add(Evas_Object *obj, Evas_Object_Intercept_Device_Focus_Set_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); /** + * @internal + * * Unset the callback function that intercepts a focus set event of an object. * * @param obj The given canvas object pointer. @@ -8412,6 +8420,8 @@ EAPI void evas_map_point_coord_set(Evas_Map *m, int idx, Evas_Coord x EAPI void evas_map_point_coord_get(const Evas_Map *m, int idx, Evas_Coord *x, Evas_Coord *y, Evas_Coord *z); /** + * @internal + * * Change the map point's coordinate precisely. * * This sets the fixed point's coordinate in the map precisely. @@ -8427,6 +8437,8 @@ EAPI void evas_map_point_coord_get(const Evas_Map *m, int idx, Evas_C EAPI void evas_map_point_precise_coord_set(Evas_Map *m, int idx, double x, double y, double z); /** + * @internal + * * Get the map point's precise coordinate. * * This returns the coordinates of the given point in the map.