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

doxygen: fix typos and some wrong expressions in API reference. 

Summary: I had fixed some typos and some wrong expressions, such as capital letters, singular, and orders of groups in API reference doxygen.

Test Plan: Doxygen revision

Reviewers: stefan, cedric, raster, Jaehyun_Cho, jpeg

Subscribers: conr2d

Differential Revision: https://phab.enlightenment.org/D4658

Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
This commit is contained in:
Myoungwoon Roy, Kim 2017-02-15 16:30:18 -08:00 committed by Cedric BAIL
parent 48627996d7
commit 5d389a1df6
3 changed files with 114 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib/ecore_input/Ecore_Input.h
View File

@ -415,7 +415,7 @@ extern "C" {
};
/**
* Initialises the Ecore Event system.
* Initializes the Ecore Event system.
*/
EAPI int ecore_event_init(void);
/**
@ -424,7 +424,7 @@ extern "C" {
EAPI int ecore_event_shutdown(void);
/**
* Return the Ecore modifier event integer associated to a
* Returns the Ecore modifier event integer associated to a
* Ecore_Event_Modifier modifier event.
*
* @param modifier A Ecore_Event_Modifier event.
@ -446,7 +446,7 @@ extern "C" {
EAPI Ecore_Event_Modifier ecore_event_update_modifier(const char *key, Ecore_Event_Modifiers *modifiers, int inc);
/**
* Handle a sequence of key symbols to make a final compose string.
* Handles a sequence of key symbols to make a final compose string.
*
* The final compose string seqstr_ret is allocated in this function and
* thus shall be freed when not needed anymore.

50
src/lib/ecore_ipc/Ecore_Ipc.h
View File

@ -327,18 +327,18 @@ EAPI extern int ECORE_IPC_EVENT_CLIENT_DATA;
EAPI extern int ECORE_IPC_EVENT_SERVER_DATA;
/**
* @brief Initialises the Ecore IPC library.
* @ingroup Ecore_IPC_Group
* @brief Initializes the Ecore IPC library.
* @return Number of times the library has been initialised without
* being shut down.
* @ingroup Ecore_IPC_Group
*/
EAPI int ecore_ipc_init(void);
/**
* @ingroup Ecore_IPC_Group
* @brief Shuts down the Ecore IPC library.
* @return Number of times the library has been initialised without being
* shut down.
* @ingroup Ecore_IPC_Group
*/
EAPI int ecore_ipc_shutdown(void);
@ -350,6 +350,7 @@ EAPI int ecore_ipc_shutdown(void);
*/
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Creates an IPC server that listens for connections.
*
* For more details about the @p compl_type, @p name and @p port
@ -360,12 +361,12 @@ EAPI int ecore_ipc_shutdown(void);
* @param port Number to identify with socket used for connection.
* @param data Data to associate with the IPC server.
* @return New IPC server. If there is an error, @c NULL is returned.
* @ingroup Ecore_IPC_Server_Group
* @todo Need to add protocol type parameter to this function.
*/
EAPI Ecore_Ipc_Server *ecore_ipc_server_add(Ecore_Ipc_Type type, const char *name, int port, const void *data);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Creates an IPC server object to represent the IPC server listening
* on the given port.
*
@ -379,44 +380,44 @@ EAPI Ecore_Ipc_Server *ecore_ipc_server_add(Ecore_Ipc_Type type, const char *nam
* IPC connection.
* @param data Data to associate with the server.
* @return A new IPC server. @c NULL is returned on error.
* @ingroup Ecore_IPC_Server_Group
* @todo Need to add protocol type parameter.
*/
EAPI Ecore_Ipc_Server *ecore_ipc_server_connect(Ecore_Ipc_Type type, char *name, int port, const void *data);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Closes the connection and frees the given IPC server.
* @param svr The given IPC server.
* @return The data associated with the server when it was created.
* @ingroup Ecore_IPC_Server_Group
*/
EAPI void *ecore_ipc_server_del(Ecore_Ipc_Server *svr);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Retrieves the data associated with the given IPC server.
* @param svr The given IPC server.
* @return The associated data.
* @ingroup Ecore_IPC_Server_Group
*/
EAPI void *ecore_ipc_server_data_get(Ecore_Ipc_Server *svr);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Retrieves whether the given IPC server is currently connected.
* @param svr The given IPC server.
* @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise.
* @ingroup Ecore_IPC_Server_Group
*/
EAPI Eina_Bool ecore_ipc_server_connected_get(Ecore_Ipc_Server *svr);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Retrieves the list of clients for this server.
* @param svr The given IPC server.
* @return An Eina_List with the clients.
* @ingroup Ecore_IPC_Server_Group
*/
EAPI Eina_List *ecore_ipc_server_clients_get(Ecore_Ipc_Server *svr);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Sends a message to the given IPC server.
*
* The content of the parameters, excluding the @p svr parameter, is up to
@ -431,13 +432,13 @@ EAPI Eina_List *ecore_ipc_server_clients_get(Ecore_Ipc_Server *svr);
* @param data The data to send as part of the message.
* @param size Length of the data, in bytes, to send.
* @return Number of bytes sent. @c 0 is returned if there is an error.
* @ingroup Ecore_IPC_Server_Group
* @todo This function needs to become an IPC message.
* @todo Fix up the documentation: Make sure what ref_to and response are.
*/
EAPI int ecore_ipc_server_send(Ecore_Ipc_Server *svr, int major, int minor, int ref, int ref_to, int response, const void *data, int size);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Sets a limit on the number of clients that can be handled concurrently
* by the given server, and a policy on what to do if excess clients try to
* connect.
@ -457,29 +458,29 @@ EAPI int ecore_ipc_server_send(Ecore_Ipc_Server *svr, int major, i
* drops. This causes the kernel to queue up to 4096
* connections (or your kernel's limit, whichever is
* lower).
* @ingroup Ecore_IPC_Server_Group
*/
EAPI void ecore_ipc_server_client_limit_set(Ecore_Ipc_Server *svr, int client_limit, char reject_excess_clients);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Sets the max data payload size for an Ipc message in bytes
*
* @param svr The given server.
* @param size The maximum data payload size in bytes.
* @ingroup Ecore_IPC_Server_Group
*/
EAPI void ecore_ipc_server_data_size_max_set(Ecore_Ipc_Server *srv, int size);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Gets the max data payload size for an Ipc message in bytes
*
* @param svr The given server.
* @return The maximum data payload in bytes.
* @ingroup Ecore_IPC_Server_Group
*/
EAPI int ecore_ipc_server_data_size_max_get(Ecore_Ipc_Server *srv);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Gets the IP address of a server that has been connected to.
*
* @param svr The given server.
@ -487,15 +488,14 @@ EAPI int ecore_ipc_server_data_size_max_get(Ecore_Ipc_Server *srv)
* the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation.
* This string should not be modified or trusted to stay valid after
* deletion for the @p svr object. If no IP is known NULL is returned.
* @ingroup Ecore_IPC_Server_Group
*/
EAPI const char *ecore_ipc_server_ip_get(Ecore_Ipc_Server *svr);
/**
* @ingroup Ecore_IPC_Server_Group
* @brief Flushes all pending data to the given server. Will return when done.
*
* @param svr The given server.
* @ingroup Ecore_IPC_Server_Group
*/
EAPI void ecore_ipc_server_flush(Ecore_Ipc_Server *svr);
@ -507,6 +507,7 @@ EAPI void ecore_ipc_server_flush(Ecore_Ipc_Server *svr);
*/
/**
* @ingroup Ecore_IPC_Client_Group
* @brief Sends a message to the given IPC client.
*
* @param cl The given IPC client.
@ -519,68 +520,68 @@ EAPI void ecore_ipc_server_flush(Ecore_Ipc_Server *svr);
* @param size Length of the data, in bytes, to send.
* @return The number of bytes sent. @c 0 will be returned if there is
* an error.
* @ingroup Ecore_IPC_Client_Group
* @todo This function needs to become an IPC message.
* @todo Make sure ref_to and response parameters are described correctly.
*/
EAPI int ecore_ipc_client_send(Ecore_Ipc_Client *cl, int major, int minor, int ref, int ref_to, int response, const void *data, int size);
/**
* @ingroup Ecore_IPC_Client_Group
* @brief Retrieves the IPC server that the given IPC client is connected to.
*
* @param cl The given IPC client.
* @return The IPC server the IPC client is connected to.
* @ingroup Ecore_IPC_Client_Group
*/
EAPI Ecore_Ipc_Server *ecore_ipc_client_server_get(Ecore_Ipc_Client *cl);
/**
* @ingroup Ecore_IPC_Client_Group
* @brief Closes the connection and frees memory allocated to the given IPC
* client.
*
* @param cl The given client.
* @return Data associated with the client.
* @ingroup Ecore_IPC_Client_Group
*/
EAPI void *ecore_ipc_client_del(Ecore_Ipc_Client *cl);
/**
* @ingroup Ecore_IPC_Client_Group
* @brief Sets the IPC data associated with the given IPC client to @p data.
*
* @param cl The given IPC client.
* @param data The data to associate with the IPC client.
* @ingroup Ecore_IPC_Client_Group
*/
EAPI void ecore_ipc_client_data_set(Ecore_Ipc_Client *cl, const void *data);
/**
* @ingroup Ecore_IPC_Client_Group
* @brief Retrieves the data that has been associated with the given IPC client.
*
* @param cl The given client.
* @return The data associated with the IPC client.
* @ingroup Ecore_IPC_Client_Group
*/
EAPI void *ecore_ipc_client_data_get(Ecore_Ipc_Client *cl);
/**
* @ingroup Ecore_IPC_Client_Group
* @brief Sets the max data payload size for an Ipc message in bytes
*
* @param cl The given client.
* @param size The maximum data payload size in bytes.
* @ingroup Ecore_IPC_Client_Group
*/
EAPI void ecore_ipc_client_data_size_max_set(Ecore_Ipc_Client *cl, int size);
/**
* @ingroup Ecore_IPC_Client_Group
* @brief Gets the max data payload size for an Ipc message in bytes
*
* @param cl The given client.
* @return The maximum data payload size in bytes on success, @c -1 on failure.
* @ingroup Ecore_IPC_Client_Group
*/
EAPI int ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl);
/**
* @ingroup Ecore_IPC_Client_Group
* @brief Gets the IP address of a client that has been connected to.
*
* @param cl The given client.
@ -589,23 +590,22 @@ EAPI int ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl);
* This string should not be modified or trusted to stay valid after
* deletion for the @p cl object. If no IP is known @c NULL is
* returned.
* @ingroup Ecore_IPC_Client_Group
*/
EAPI const char *ecore_ipc_client_ip_get(Ecore_Ipc_Client *cl);
/**
* @ingroup Ecore_IPC_Client_Group
* @brief Flushes all pending data to the given client. Will return when done.
*
* @param cl The given client.
* @ingroup Ecore_IPC_Client_Group
*/
EAPI void ecore_ipc_client_flush(Ecore_Ipc_Client *cl);
/**
* @ingroup Ecore_Con_Client_Group
* @brief Returns if SSL support is available
*
* @return 1 if SSL is available, 0 if it is not.
* @ingroup Ecore_Con_Client_Group
*/
EAPI int ecore_ipc_ssl_available_get(void);
/* FIXME: need to add a callback to "ok" large ipc messages greater than */

173
src/lib/ecore_wayland/Ecore_Wayland.h
View File

@ -227,11 +227,10 @@ struct _Ecore_Wl_Event_Interfaces_Bound
/**
* @file
* @brief Ecore functions for dealing with the Wayland window system
* @brief Ecore functions for dealing with the Wayland window system.
*
* @defgroup Ecore_Wl_Group Ecore_Wayland - Wayland integration
* @ingroup Ecore
* Ecore_Wl provides a wrapper and convenience functions for using the
* Wayland protocol in implementing a window system. Function groups for
* this part of the library include the following:
@ -270,19 +269,20 @@ EAPI extern int ECORE_WL_EVENT_INTERFACES_BOUND;
*/
/**
* Initialize the Wayland display connection to the given display.
* @ingroup Ecore_Wl_Init_Group
* @brief Initializes the Wayland display connection to the given display.
*
* @param name Display target name. if @c NULL, the default display is
* assumed.
* @return The number of times the library has been initialized without being
* shut down. 0 is returned if an error occurs.
* shut down. @c 0 is returned if an error occurs.
*
* @ingroup Ecore_Wl_Init_Group
*/
EAPI int ecore_wl_init(const char *name);
/**
* Shuts down the Ecore Wayland Library
* @ingroup Ecore_Wl_Init_Group
* @brief Shuts down the Ecore Wayland Library.
*
* In shutting down the library, the Wayland display connection is terminated
* and any event handlers for it are removed.
@ -290,7 +290,6 @@ EAPI int ecore_wl_init(const char *name);
* @return The number of times the library has been initialized without
* being shut down.
*
* @ingroup Ecore_Wl_Init_Group
*/
EAPI int ecore_wl_shutdown(void);
@ -303,18 +302,18 @@ EAPI int ecore_wl_shutdown(void);
*/
/**
* Sends all Wayland commands to the Wayland Display.
*
* @ingroup Ecore_Wl_Flush_Group
* @brief Sends all Wayland commands to the Wayland Display.
*
* @since 1.2
*/
EAPI void ecore_wl_flush(void);
/**
* Flushes the command buffer and waits until all requests have been
* @ingroup Ecore_Wl_Flush_Group
* @brief Flushes the command buffer and waits until all requests have been
* processed by the server.
*
* @ingroup Ecore_Wl_Flush_Group
* @since 1.2
*/
EAPI void ecore_wl_sync(void);
@ -327,27 +326,27 @@ EAPI void ecore_wl_sync(void);
*/
/**
* Retrieves the Wayland Shm Interface used for the current Wayland connection.
* @ingroup Ecore_Wl_Display_Group
* @brief Retrieves the Wayland Shm Interface used for the current Wayland connection.
*
* @return The current wayland shm interface, or NULL on error
*
* @ingroup Ecore_Wl_Display_Group
* @since 1.2
*/
EAPI struct wl_shm *ecore_wl_shm_get(void);
/**
* Retrieves the Wayland Display Interface used for the current Wayland connection.
* @ingroup Ecore_Wl_Display_Group
* @brief Retrieves the Wayland Display Interface used for the current Wayland connection.
*
* @return The current wayland display interface, or NULL on error
*
* @ingroup Ecore_Wl_Display_Group
* @since 1.2
*/
EAPI struct wl_display *ecore_wl_display_get(void);
/**
* Retrieves the Compositor interface.
* @brief Retrieves the Compositor interface.
*
* This interface is used by clients to request the creation of surfaces and
* regions.
@ -357,29 +356,29 @@ EAPI struct wl_display *ecore_wl_display_get(void);
*/
/**
* Retrieves the size of the current screen.
*
* @param w where to return the width. May be NULL. Returns 0 on error.
* @param h where to return the height. May be NULL. Returns 0 on error.
*
* @ingroup Ecore_Wl_Display_Group
* @brief Retrieves the size of the current screen.
*
* @param w Where to return the width. May be NULL. Returns @c 0 on error.
* @param h Where to return the height. May be NULL. Returns @c 0 on error.
*
* @since 1.2
*/
EAPI void ecore_wl_screen_size_get(int *w, int *h);
/**
* Retrieves the position of the current screen.
*
* @param x where to return the horizontal position. May be NULL. Returns 0 on error.
* @param y where to return the vertical position. May be NULL. Returns 0 on error.
*
* @ingroup Ecore_Wl_Display_Group
* @brief Retrieves the position of the current screen.
*
* @param x Where to return the horizontal position. May be NULL. Returns @c 0 on error.
* @param y Where to return the vertical position. May be NULL. Returns @c 0 on error.
*
* @since 1.2
*/
EAPI void ecore_wl_pointer_xy_get(int *x, int *y);
/**
* Return the screen DPI
* @brief Returns the screen DPI.
*
* This is a simplistic call to get DPI. It does not account for differing
* DPI in the x and y axes nor does it account for multihead or xinerama and
@ -392,7 +391,7 @@ EAPI void ecore_wl_pointer_xy_get(int *x, int *y);
EAPI int ecore_wl_dpi_get(void);
/**
* Dispatch Wayland events
* @brief Dispatches Wayland events.
*
* Dispatches any events queued on the default queue. Wayland will attempt
* to read from the display fd and queue things up according to the proxy
@ -407,7 +406,7 @@ EAPI void ecore_wl_display_iterate(void);
EAPI Eina_Bool ecore_wl_animator_source_set(Ecore_Animator_Source source);
/**
* Retrieves the requested cursor from the cursor theme
* @brief Retrieves the requested cursor from the cursor theme.
*
* @param cursor_name The desired cursor name to be looked up in the theme
* @return the cursor or NULL if the cursor cannot be found
@ -420,7 +419,7 @@ EAPI struct wl_cursor *ecore_wl_cursor_get(const char *cursor_name);
* @defgroup Ecore_Wl_Input_Group Functions dealing with Wayland Input
* @ingroup Ecore_Wl_Group
*
* Functions to interface with Wayland Input
* Functions to interface with Wayland Input.
*/
/**
@ -452,7 +451,8 @@ EAPI struct xkb_keymap *ecore_wl_input_keymap_get(Ecore_Wl_Input *input);
/**
* Retrieves the Wayland Globals Interface list used for the current Wayland connection.
* @ingroup Ecore_Wl_Display_Group
* @brief 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
* received already, won't block the mainloop or trigger a dispatch. It will
@ -465,17 +465,16 @@ EAPI struct xkb_keymap *ecore_wl_input_keymap_get(Ecore_Wl_Input *input);
*
* @return The current wayland globals interface list, or NULL on error
*
* @ingroup Ecore_Wl_Display_Group
* @since 1.7.6
*/
EAPI Eina_Inlist *ecore_wl_globals_get(void);
/**
* Retrieves the Wayland Registry used for the current Wayland connection.
* @ingroup Ecore_Wl_Display_Group
* @brief Retrieves the Wayland Registry used for the current Wayland connection.
*
* @return The current wayland registry, or NULL on error
*
* @ingroup Ecore_Wl_Display_Group
* @since 1.7.6
*/
EAPI struct wl_registry *ecore_wl_registry_get(void);
@ -488,7 +487,8 @@ EAPI struct wl_registry *ecore_wl_registry_get(void);
*/
/**
* Creates a new window
* @ingroup Ecore_Wl_Window_Group
* @brief Creates a new window.
*
* @param parent The parent window to use. If @p parent is @c 0, the root window
* of the default display is used.
@ -500,23 +500,23 @@ EAPI struct wl_registry *ecore_wl_registry_get(void);
*
* @return The new window, or NULL on failure
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI Ecore_Wl_Window *ecore_wl_window_new(Ecore_Wl_Window *parent, int x, int y, int w, int h, int buffer_type);
/**
* Deletes the given window
* @ingroup Ecore_Wl_Window_Group
* @brief Deletes the given window.
*
* @param win The given window
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_free(Ecore_Wl_Window *win);
/**
* Signals for Wayland to initiate a window move.
* @ingroup Ecore_Wl_Window_Group
* @brief Signals for Wayland to initiate a window move.
*
* The position requested (@p x, @p y) is not honored by Wayland because
* Wayland does not allow specific window placement to be set.
@ -525,13 +525,13 @@ EAPI void ecore_wl_window_free(Ecore_Wl_Window *win);
* @param x X Position
* @param y Y Position
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_move(Ecore_Wl_Window *win, int x, int y);
/**
* Signals for Wayland to initiate a window resize.
* @ingroup Ecore_Wl_Window_Group
* @brief Signals for Wayland to initiate a window resize.
*
* The size requested (@p w, @p h) is not honored by Wayland because
* Wayland does not allow specific window sizes to be set.
@ -541,7 +541,6 @@ EAPI void ecore_wl_window_move(Ecore_Wl_Window *win, int x, int y);
* @param h Height
* @param location The edge of the window from where the resize should start.
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_resize(Ecore_Wl_Window *win, int w, int h, int location);
@ -552,35 +551,35 @@ EAPI void ecore_wl_window_buffer_attach(Ecore_Wl_Window *win, struct wl_buffer *
EAPI void ecore_wl_window_commit(Ecore_Wl_Window *win);
/**
* Shows a window
* @ingroup Ecore_Wl_Window_Group
* @brief Shows a window.
*
* Synonymous to "mapping" a window in Wayland System terminology.
*
* @param win The window to show.
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_show(Ecore_Wl_Window *win);
/**
* Hides a window
* @ingroup Ecore_Wl_Window_Group
* @brief Hides a window.
*
* Synonymous to "unmapping" a window in Wayland System terminology.
*
* @param win The window to hide.
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_hide(Ecore_Wl_Window *win);
/**
* Raises a window
* @ingroup Ecore_Wl_Window_Group
* @brief Raises a window.
*
* @param win The window to raise.
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_raise(Ecore_Wl_Window *win);
@ -603,11 +602,11 @@ EAPI void ecore_wl_window_cursor_default_restore(Ecore_Wl_Window *win);
EAPI void ecore_wl_window_parent_set(Ecore_Wl_Window *win, Ecore_Wl_Window *parent);
/**
* Iconify a window
* @ingroup Ecore_Wl_Window_Group
* @brief Iconifies a window.
*
* @param win The window to iconifiy
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.12
*/
EAPI void ecore_wl_window_iconified_set(Ecore_Wl_Window *win, Eina_Bool iconified);
@ -622,12 +621,12 @@ EAPI int ecore_wl_window_surface_id_get(Ecore_Wl_Window *win);
EAPI Ecore_Wl_Input *ecore_wl_window_keyboard_get(Ecore_Wl_Window *win);
/**
* Returns a wl_surface with no association to any wl_shell_surface.
* @ingroup Ecore_Wl_Window_Group
* @brief Returns a wl_surface with no association to any wl_shell_surface.
*
* @param win The window which will use this newly created surface.
* @return wl_surface or NULL on error
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI struct wl_surface *ecore_wl_window_surface_create(Ecore_Wl_Window *win);
@ -636,18 +635,19 @@ 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);
/**
* Returns the Ecore_Wl_Window from a wl_surface
* @ingroup Ecore_Wl_Window_Group
* @brief Returns the Ecore_Wl_Window from a wl_surface.
*
* @param surface The surface for which to find the Ecore_Wl_Window from
* @return the Ecore_Wl_Window associated with this surface, or NULL if not found
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI Ecore_Wl_Window *ecore_wl_window_surface_find(struct wl_surface *surface);
/**
* Set the input region of the Ecore_Wl_Window.
* @ingroup Ecore_Wl_Window_Group
* @brief Sets the input region of the Ecore_Wl_Window.
*
* To set an empty region, pass width and height as 0.
*
@ -659,13 +659,13 @@ EAPI Ecore_Wl_Window *ecore_wl_window_surface_find(struct wl_surface *surface);
* @param w The width of the region.
* @param h The height of the region.
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI void ecore_wl_window_input_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h);
/**
* Set the opaque region of the Ecore_Wl_Window
* @ingroup Ecore_Wl_Window_Group
* @brief Sets the opaque region of the Ecore_Wl_Window.
*
* @param win The window
* @param x The left point of the region.
@ -673,29 +673,28 @@ EAPI void ecore_wl_window_input_region_set(Ecore_Wl_Window *win, int x, int y, i
* @param w The width of the region.
* @param h The height of the region.
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI void ecore_wl_window_opaque_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h);
/**
* Set the rotation of the Ecore_Wl_Window
* @ingroup Ecore_Wl_Window_Group
* @brief Sets the rotation of the Ecore_Wl_Window.
*
* @param win The window
* @param rotation The degree of rotation for this window
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI void ecore_wl_window_rotation_set(Ecore_Wl_Window *win, int rotation);
/**
* Get the rotation of the Ecore_Wl_Window
* @ingroup Ecore_Wl_Window_Group
* @brief Gets the rotation of the Ecore_Wl_Window.
*
* @param win The window
* @return The degree of rotation for this window
*
* @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI int ecore_wl_window_rotation_get(Ecore_Wl_Window *win);
@ -738,33 +737,33 @@ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_start_drag(Ecore_Wl_Dnd *dnd);
EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_selection_has_owner(Ecore_Wl_Dnd *dnd);
/**
* @ingroup Ecore_Wl_Dnd_Group
* @return false on error, true otherwise
*
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_selection_set(Ecore_Wl_Input *input, const char **types_offered);
/**
* @ingroup Ecore_Wl_Dnd_Group
* @return false if type not found or on error, true otherwise
*
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_selection_get(Ecore_Wl_Input *input, const char *type);
/**
* @ingroup Ecore_Wl_Dnd_Group
* @return true if input has a selection source, false otherwise or on error
*
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_selection_owner_has(Ecore_Wl_Input *input);
/**
* @ingroup Ecore_Wl_Dnd_Group
* @return false on error, true otherwise
*
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_selection_clear(Ecore_Wl_Input *input);
@ -782,9 +781,9 @@ EAPI void ecore_wl_dnd_drag_start(Ecore_Wl_Input *input, Ecore_Wl_Window *win, E
EAPI void ecore_wl_dnd_drag_end(Ecore_Wl_Input *input);
/**
* @ingroup Ecore_Wl_Dnd_Group
* @return false if type not found or on error, true otherwise
*
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_drag_get(Ecore_Wl_Input *input, const char *type);
@ -796,9 +795,9 @@ EAPI Eina_Bool ecore_wl_dnd_drag_get(Ecore_Wl_Input *input, const char *type);
EAPI void ecore_wl_dnd_drag_types_set(Ecore_Wl_Input *input, const char **types_offered);
/**
* @ingroup Ecore_Wl_Dnd_Group
* @return the data types being offered for drag-and-drop, or NULL on error
*
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI struct wl_array *ecore_wl_dnd_drag_types_get(Ecore_Wl_Input *input);
@ -810,7 +809,7 @@ 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); */
/**
* Enable/disable server mode.
* Enables/disables server mode.
*
* With this enabled, the compositor acts as a Wayland server, iterating
* the display and dispatching events. With it disabled, the process is
@ -833,7 +832,8 @@ EAPI void ecore_wl_server_mode_set(Eina_Bool on);
*/
/**
* Create and return a new subsurface.
* @ingroup Ecore_Wl_Subsurf
* @brief Creates and returns a new subsurface.
*
* Create a new surface (and subsurface interface), with the parent surface
* being the one associated with the given @param win.
@ -844,34 +844,34 @@ EAPI void ecore_wl_server_mode_set(Eina_Bool on);
* @return the allocated and initialized Ecore_Wl_Subsurf object, or
* NULL on failure
*
* @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI Ecore_Wl_Subsurf *ecore_wl_subsurf_create(Ecore_Wl_Window *win);
/**
* Destroy the given subsurface, as well as the surface associated with it.
* @ingroup Ecore_Wl_Subsurf
* @brief Destroys the given subsurface, as well as the surface associated with it.
*
* @param ess the subsurface
*
* @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_del(Ecore_Wl_Subsurf *ess);
/**
* Get the wl_surface for this subsurface
* @ingroup Ecore_Wl_Subsurf
* @brief Gets the wl_surface for this subsurface.
*
* @param ess the subsurface
* @return the wl_surface associated with this subsurface, or NULL on failure
*
* @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI struct wl_surface *ecore_wl_subsurf_surface_get(Ecore_Wl_Subsurf *ess);
/**
* Set the position of this subsurface, relative to its parent surface.
* @ingroup Ecore_Wl_Subsurf
* @brief Sets 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.
*
@ -879,26 +879,26 @@ EAPI struct wl_surface *ecore_wl_subsurf_surface_get(Ecore_Wl_Subsurf *ess);
* @param x coordinate in the parent surface
* @param y coordinate in the parent surface
*
* @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_position_set(Ecore_Wl_Subsurf *ess, int x, int y);
/**
* Get the position of this subsurface, relative to its parent surface.
* @ingroup Ecore_Wl_Subsurf
* @brief Gets the position of this subsurface, relative to its parent surface.
* Coordinates will be returned in x and y if non-NULL.
*
* @param ess the subsurface
* @param x coordinate in the parent surface, or NULL to ignore
* @param y coordinate in the parent surface, or NULL to ignore
*
* @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y);
/**
* Place subsurface on layer above a reference surface
* @ingroup Ecore_Wl_Subsurf
* @brief Places subsurface on layer above a reference surface.
*
* Moves the @param ess subsurface to just above the reference @param
* surface, changing the z-order. The reference @param surface must
@ -908,26 +908,26 @@ EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y);
* @param ess the subsurface
* @param surface the sibling reference surface
*
* @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_place_above(Ecore_Wl_Subsurf *ess, struct wl_surface *surface);
/**
* Place subsurface on layer below a reference surface
* @ingroup Ecore_Wl_Subsurf
* @brief Places subsurface on layer below a reference surface.
*
* See ecore_wl_subsurf_place_above.
*
* @param ess the subsurface
* @param surface the sibling reference surface
*
* @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_place_below(Ecore_Wl_Subsurf *ess, struct wl_surface *surface);
/**
* Enables or disables sub-surface synchronization
* @ingroup Ecore_Wl_Subsurf
* @brief Enables or disables sub-surface synchronization.
*
* When synchronization is enabled, surface commits on the subsurface
* will be cached and only applied when the parent surface's state is
@ -949,13 +949,13 @@ EAPI void ecore_wl_subsurf_place_below(Ecore_Wl_Subsurf *ess, struct wl_surface
* @param ess the subsurface
* @param val true to enable synchronization, false to desynchronize
*
* @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_sync_set(Ecore_Wl_Subsurf *ess, Eina_Bool val);
/**
* Set an opaque region for the given subsurface.
* @ingroup Ecore_Wl_Subsurf
* @brief Sets an opaque region for the given subsurface.
*
* This is an optimization hint to the compositor to allow it avoid
* redrawing content unnecessarily. Note that marking transparent
@ -969,7 +969,6 @@ EAPI void ecore_wl_subsurf_sync_set(Ecore_Wl_Subsurf *ess, Eina_Bool val);
* @param w width to set as opaque
* @param h height to set as opaque
*
* @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_opaque_region_set(Ecore_Wl_Subsurf *ess, int x, int y, int w, int h);