summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore/Ecore.h141
-rw-r--r--legacy/ecore/src/lib/ecore/ecore_exe.c4
-rw-r--r--legacy/ecore/src/lib/ecore/ecore_getopt.c17
-rw-r--r--legacy/ecore/src/lib/ecore/ecore_pipe.c2
-rw-r--r--legacy/ecore/src/lib/ecore_con/Ecore_Con.h48
-rw-r--r--legacy/ecore/src/lib/ecore_con/ecore_con_private.h12
-rw-r--r--legacy/ecore/src/lib/ecore_con/ecore_con_ssl.c14
-rw-r--r--legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h148
-rw-r--r--legacy/ecore/src/lib/ecore_evas/ecore_evas.c33
-rw-r--r--legacy/ecore/src/lib/ecore_fb/ecore_fb_li.c9
-rw-r--r--legacy/ecore/src/lib/ecore_file/ecore_file.c87
-rw-r--r--legacy/ecore/src/lib/ecore_file/ecore_file_download.c14
-rw-r--r--legacy/ecore/src/lib/ecore_file/ecore_file_path.c13
-rw-r--r--legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c31
-rw-r--r--legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c5
-rwxr-xr-xlegacy/ecore/src/lib/ecore_win32/ecore_win32_dnd.c14
-rw-r--r--legacy/ecore/src/lib/ecore_win32/ecore_win32_window.c36
-rw-r--r--legacy/ecore/src/lib/ecore_wince/ecore_wince_window.c12
-rw-r--r--legacy/ecore/src/lib/ecore_x/Ecore_X.h48
-rw-r--r--legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c8
-rw-r--r--legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_composite.c3
-rw-r--r--legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c7
-rw-r--r--legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c258
-rw-r--r--legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c8
-rw-r--r--legacy/ecore/src/lib/ecore_x/xlib/ecore_x_gesture.c5
-rw-r--r--legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr.c9
-rw-r--r--legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_11.c34
-rw-r--r--legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c238
28 files changed, 686 insertions, 572 deletions
diff --git a/legacy/ecore/src/lib/ecore/Ecore.h b/legacy/ecore/src/lib/ecore/Ecore.h
index 3c3063498a..69de165c70 100644
--- a/legacy/ecore/src/lib/ecore/Ecore.h
+++ b/legacy/ecore/src/lib/ecore/Ecore.h
@@ -680,7 +680,7 @@ struct _Ecore_Event_Signal_Realtime /** Realtime event */
680 * @param type The type of the event this handler will get called for 680 * @param type The type of the event this handler will get called for
681 * @param func The function to call when the event is found in the queue 681 * @param func The function to call when the event is found in the queue
682 * @param data A data pointer to pass to the called function @p func 682 * @param data A data pointer to pass to the called function @p func
683 * @return A new Event handler, or NULL on failure 683 * @return A new Event handler, or @c NULL on failure.
684 * 684 *
685 * Add an event handler to the list of handlers. This will, on success, return 685 * Add an event handler to the list of handlers. This will, on success, return
686 * a handle to the event handler object that was created, that can be used 686 * a handle to the event handler object that was created, that can be used
@@ -706,7 +706,7 @@ EAPI Ecore_Event_Handler *ecore_event_handler_add(int type, Ecore_Event_Handler_
706 * 706 *
707 * Delete a specified event handler from the handler list. On success this will 707 * Delete a specified event handler from the handler list. On success this will
708 * delete the event handler and return the pointer passed as @p data when the 708 * delete the event handler and return the pointer passed as @p data when the
709 * handler was added by ecore_event_handler_add(). On failure NULL will be 709 * handler was added by ecore_event_handler_add(). On failure @c NULL will be
710 * returned. Once a handler is deleted it will no longer be called. 710 * returned. Once a handler is deleted it will no longer be called.
711 */ 711 */
712EAPI void *ecore_event_handler_del(Ecore_Event_Handler *event_handler); 712EAPI void *ecore_event_handler_del(Ecore_Event_Handler *event_handler);
@@ -775,23 +775,24 @@ EAPI int ecore_event_type_new(void);
775 * @param func_filter Function to call on each event 775 * @param func_filter Function to call on each event
776 * @param func_end Function to call after the queue has been filtered 776 * @param func_end Function to call after the queue has been filtered
777 * @param data Data to pass to the filter functions 777 * @param data Data to pass to the filter functions
778 * @return A filter handle on success, NULL otherwise 778 * @return A filter handle on success, @c NULL otherwise.
779 * 779 *
780 * Adds a callback to filter events from the event queue. Filters are called on 780 * Adds a callback to filter events from the event queue. Filters are called on
781 * the queue just before Event handler processing to try and remove redundant 781 * the queue just before Event handler processing to try and remove redundant
782 * events. Just as processing is about to start @a func_start is called and 782 * events. Just as processing is about to start @a func_start is called and
783 * passed the @a data pointer, the return value of this functions is passed to 783 * passed the @a data pointer, the return value of this functions is passed to
784 * @a func_filter as loop_data. @a func_filter is also passed @a data and the 784 * @a func_filter as loop_data. @a func_filter is also passed @a data and the
785 * event type and event structure. If this @a func_filter returns #EINA_FALSE, 785 * event type and event structure. If this @a func_filter returns
786 * the event is removed from the queue, if it returns #EINA_TRUE, the event is 786 * @c EINA_FALSE, the event is removed from the queue, if it returns
787 * kept. When processing is finished @p func_end is called and is passed the 787 * @c EINA_TRUE, the event is kept. When processing is finished @p func_end is
788 * loop_data(returned by @c func_start) and @p data pointer to clean up. 788 * called and is passed the loop_data(returned by @c func_start) and @p data
789 * pointer to clean up.
789 */ 790 */
790EAPI Ecore_Event_Filter *ecore_event_filter_add(Ecore_Data_Cb func_start, Ecore_Filter_Cb func_filter, Ecore_End_Cb func_end, const void *data); 791EAPI Ecore_Event_Filter *ecore_event_filter_add(Ecore_Data_Cb func_start, Ecore_Filter_Cb func_filter, Ecore_End_Cb func_end, const void *data);
791/** 792/**
792 * @brief Delete an event filter. 793 * @brief Delete an event filter.
793 * @param ef The event filter handle 794 * @param ef The event filter handle
794 * @return The data set for the filter on success, NULL otherwise 795 * @return The data set for the filter on success, @c NULL otherwise.
795 * 796 *
796 * Delete a filter that has been added by its @p ef handle. 797 * Delete a filter that has been added by its @p ef handle.
797 */ 798 */
@@ -814,7 +815,7 @@ EAPI int ecore_event_current_type_get(void);
814/** 815/**
815 * @brief Return the current event type pointer handled. 816 * @brief Return the current event type pointer handled.
816 * @return The current event pointer being handled if inside a handler callback, 817 * @return The current event pointer being handled if inside a handler callback,
817 * NULL otherwise 818 * @c NULL otherwise.
818 * 819 *
819 * If the program is currently inside an Ecore event handler callback this 820 * If the program is currently inside an Ecore event handler callback this
820 * will return the pointer of the current event being processed. 821 * will return the pointer of the current event being processed.
@@ -900,7 +901,7 @@ struct _Ecore_Exe_Event_Del /** Process exit event */
900{ 901{
901 pid_t pid; /**< The process ID of the process that exited */ 902 pid_t pid; /**< The process ID of the process that exited */
902 int exit_code; /**< The exit code of the process */ 903 int exit_code; /**< The exit code of the process */
903 Ecore_Exe *exe; /**< The handle to the exited process, or NULL if not found */ 904 Ecore_Exe *exe; /**< The handle to the exited process, or @c NULL if not found */
904 int exit_signal; /** < The signal that caused the process to exit */ 905 int exit_signal; /** < The signal that caused the process to exit */
905 Eina_Bool exited : 1; /** < set to 1 if the process exited of its own accord */ 906 Eina_Bool exited : 1; /** < set to 1 if the process exited of its own accord */
906 Eina_Bool signalled : 1; /** < set to 1 id the process exited due to uncaught signal */ 907 Eina_Bool signalled : 1; /** < set to 1 id the process exited due to uncaught signal */
@@ -921,7 +922,7 @@ struct _Ecore_Exe_Event_Data /** Data from a child process event */
921 Ecore_Exe *exe; /**< The handle to the process */ 922 Ecore_Exe *exe; /**< The handle to the process */
922 void *data; /**< the raw binary data from the child process that was received */ 923 void *data; /**< the raw binary data from the child process that was received */
923 int size; /**< the size of this data in bytes */ 924 int size; /**< the size of this data in bytes */
924 Ecore_Exe_Event_Data_Line *lines; /**< an array of line data if line buffered, the last one has it's line member set to NULL */ 925 Ecore_Exe_Event_Data_Line *lines; /**< an array of line data if line buffered, the last one has it's line member set to @c NULL */
925}; 926};
926 927
927EAPI void ecore_exe_run_priority_set(int pri); 928EAPI void ecore_exe_run_priority_set(int pri);
@@ -1075,8 +1076,8 @@ EAPI void ecore_main_fd_handler_prepare_callback_set(Ecore_Fd_Handler *fd_handle
1075/** 1076/**
1076 * @brief Marks an FD handler for deletion. 1077 * @brief Marks an FD handler for deletion.
1077 * @param fd_handler The FD handler. 1078 * @param fd_handler The FD handler.
1078 * @return The data pointer set using @ref ecore_main_fd_handler_add, for @a 1079 * @return The data pointer set using @ref ecore_main_fd_handler_add, for
1079 * fd_handler on success, @c NULL otherwise. 1080 * @a fd_handler on success, @c NULL otherwise.
1080 * This function marks an fd handler to be deleted during an iteration of the 1081 * This function marks an fd handler to be deleted during an iteration of the
1081 * main loop. It does NOT close the associated fd! 1082 * main loop. It does NOT close the associated fd!
1082 * 1083 *
@@ -1095,9 +1096,9 @@ EAPI int ecore_main_fd_handler_fd_get(Ecore_Fd_Handler *fd_handler);
1095/** 1096/**
1096 * @brief Gets which flags are active on an FD handler. 1097 * @brief Gets which flags are active on an FD handler.
1097 * @param fd_handler The given FD handler. 1098 * @param fd_handler The given FD handler.
1098 * @param flags The flags, @c ECORE_FD_READ, @c ECORE_FD_WRITE or @c 1099 * @param flags The flags, @c ECORE_FD_READ, @c ECORE_FD_WRITE or
1099 * ECORE_FD_ERROR to query. 1100 * @c ECORE_FD_ERROR to query.
1100 * @return #EINA_TRUE if any of the given flags are active, #EINA_FALSE 1101 * @return @c EINA_TRUE if any of the given flags are active, @c EINA_FALSE
1101 * otherwise. 1102 * otherwise.
1102 */ 1103 */
1103EAPI Eina_Bool ecore_main_fd_handler_active_get(Ecore_Fd_Handler *fd_handler, Ecore_Fd_Handler_Flags flags); 1104EAPI Eina_Bool ecore_main_fd_handler_active_get(Ecore_Fd_Handler *fd_handler, Ecore_Fd_Handler_Flags flags);
@@ -1308,10 +1309,10 @@ typedef Eina_Bool (*Ecore_Timeline_Cb)(void *data, double pos);
1308 * @param data The data to pass to the function 1309 * @param data The data to pass to the function
1309 * @return A handle to the new animator 1310 * @return A handle to the new animator
1310 * 1311 *
1311 * This function adds a animator and returns its handle on success and NULL on 1312 * This function adds a animator and returns its handle on success and @c NULL
1312 * failure. The function @p func will be called every N seconds where N is the 1313 * on failure. The function @p func will be called every N seconds where N is
1313 * @p frametime interval set by ecore_animator_frametime_set(). The function 1314 * the @p frametime interval set by ecore_animator_frametime_set(). The
1314 * will be passed the @p data pointer as its parameter. 1315 * function will be passed the @p data pointer as its parameter.
1315 * 1316 *
1316 * When the animator @p func is called, it must return a value of either 1 or 1317 * When the animator @p func is called, it must return a value of either 1 or
1317 * 0. If it returns 1 (or ECORE_CALLBACK_RENEW), it will be called again at 1318 * 0. If it returns 1 (or ECORE_CALLBACK_RENEW), it will be called again at
@@ -1360,7 +1361,7 @@ EAPI Ecore_Animator *ecore_animator_timeline_add(double runtime, Ecore_Timeline_
1360 * 1361 *
1361 * Delete the specified @p animator from the set of animators that are 1362 * Delete the specified @p animator from the set of animators that are
1362 * executed during main loop execution. This function returns the data 1363 * executed during main loop execution. This function returns the data
1363 * parameter that was being passed to the callback on success, or NULL on 1364 * parameter that was being passed to the callback on success, or @c NULL on
1364 * failure. After this call returns the specified animator object @p animator 1365 * failure. After this call returns the specified animator object @p animator
1365 * is invalid and should not be used again. It will not get called again after 1366 * is invalid and should not be used again. It will not get called again after
1366 * deletion. 1367 * deletion.
@@ -1521,7 +1522,7 @@ EAPI Ecore_Animator_Source ecore_animator_source_get(void);
1521 * to allow the source of ticks to be dynamically enabled or disabled as 1522 * to allow the source of ticks to be dynamically enabled or disabled as
1522 * needed, the @p func when set is called to enable the tick source to 1523 * needed, the @p func when set is called to enable the tick source to
1523 * produce tick events that call ecore_animator_custom_tick(). If @p func 1524 * produce tick events that call ecore_animator_custom_tick(). If @p func
1524 * is NULL then no function is called to begin custom ticking. 1525 * is @c NULL then no function is called to begin custom ticking.
1525 * 1526 *
1526 * @see ecore_animator_source_set() 1527 * @see ecore_animator_source_set()
1527 * @see ecore_animator_custom_source_tick_end_callback_set() 1528 * @see ecore_animator_custom_source_tick_end_callback_set()
@@ -1535,10 +1536,10 @@ EAPI void ecore_animator_custom_source_tick_begin_callback_set(Ecore_Cb func, co
1535 * @param data The data passed to the tick end function as its parameter 1536 * @param data The data passed to the tick end function as its parameter
1536 * 1537 *
1537 * This function is a matching pair to the function set by 1538 * This function is a matching pair to the function set by
1538 *ecore_animator_custom_source_tick_begin_callback_set() and is called 1539 * ecore_animator_custom_source_tick_begin_callback_set() and is called
1539 * when ticking is to stop. If @p func is NULL then no function will be 1540 * when ticking is to stop. If @p func is @c NULL then no function will be
1540 * called to stop ticking. For more information please see 1541 * called to stop ticking. For more information please see
1541 *ecore_animator_custom_source_tick_begin_callback_set(). 1542 * ecore_animator_custom_source_tick_begin_callback_set().
1542 * 1543 *
1543 * @see ecore_animator_source_set() 1544 * @see ecore_animator_source_set()
1544 * @see ecore_animator_custom_source_tick_begin_callback_set() 1545 * @see ecore_animator_custom_source_tick_begin_callback_set()
@@ -1594,8 +1595,8 @@ EAPI double ecore_loop_time_get(void);
1594 * } 1595 * }
1595 * ecore_timer_add(interval_in_seconds, my_func, data_given_to_function); 1596 * ecore_timer_add(interval_in_seconds, my_func, data_given_to_function);
1596 * @endcode 1597 * @endcode
1597 * @note If the function was to be executed only once simply return EINA_FALSE 1598 * @note If the function was to be executed only once simply return
1598 * instead. 1599 * @c EINA_FALSE instead.
1599 * 1600 *
1600 * An example that shows the usage of a lot of these: 1601 * An example that shows the usage of a lot of these:
1601 * @li @ref ecore_timer_example_c 1602 * @li @ref ecore_timer_example_c
@@ -1678,12 +1679,12 @@ typedef struct _Ecore_Idle_Exiter Ecore_Idle_Exiter; /**< A handle for idle exi
1678 * Add an idler handler. 1679 * Add an idler handler.
1679 * @param func The function to call when idling. 1680 * @param func The function to call when idling.
1680 * @param data The data to be passed to this @p func call. 1681 * @param data The data to be passed to this @p func call.
1681 * @return A idler handle if successfully added. NULL otherwise. 1682 * @return A idler handle if successfully added, @c NULL otherwise.
1682 * 1683 *
1683 * Add an idler handle to the event loop, returning a handle on 1684 * Add an idler handle to the event loop, returning a handle on
1684 * success and NULL otherwise. The function @p func will be called 1685 * success and @c NULL otherwise. The function @p func will be called
1685 * repeatedly while no other events are ready to be processed, as 1686 * repeatedly while no other events are ready to be processed, as
1686 * long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0 1687 * long as it returns @c 1 (or ECORE_CALLBACK_RENEW). A return of @c 0
1687 * (or ECORE_CALLBACK_CANCEL) deletes the idler. 1688 * (or ECORE_CALLBACK_CANCEL) deletes the idler.
1688 * 1689 *
1689 * Idlers are useful for progressively prossessing data without blocking. 1690 * Idlers are useful for progressively prossessing data without blocking.
@@ -1693,7 +1694,7 @@ EAPI Ecore_Idler *ecore_idler_add(Ecore_Task_Cb func, const void *data);
1693/** 1694/**
1694 * Delete an idler callback from the list to be executed. 1695 * Delete an idler callback from the list to be executed.
1695 * @param idler The handle of the idler callback to delete 1696 * @param idler The handle of the idler callback to delete
1696 * @return The data pointer passed to the idler callback on success. NULL 1697 * @return The data pointer passed to the idler callback on success, @c NULL
1697 * otherwise. 1698 * otherwise.
1698 */ 1699 */
1699EAPI void *ecore_idler_del(Ecore_Idler *idler); 1700EAPI void *ecore_idler_del(Ecore_Idler *idler);
@@ -1822,7 +1823,7 @@ typedef void (*Ecore_Thread_Notify_Cb)(void *data, Ecore_Thread *thread, void *m
1822 * @param func_cancel Function to call from main loop if the thread running 1823 * @param func_cancel Function to call from main loop if the thread running
1823 * @p func_blocking is cancelled or fails to start (may be NULL) 1824 * @p func_blocking is cancelled or fails to start (may be NULL)
1824 * @param data User context data to pass to all callbacks. 1825 * @param data User context data to pass to all callbacks.
1825 * @return A new thread handler, or NULL on failure 1826 * @return A new thread handler, or @c NULL on failure.
1826 * 1827 *
1827 * This function will try to create a new thread to run @p func_blocking in, 1828 * This function will try to create a new thread to run @p func_blocking in,
1828 * or if the maximum number of concurrent threads has been reached, will 1829 * or if the maximum number of concurrent threads has been reached, will
@@ -1882,7 +1883,7 @@ EAPI Ecore_Thread *ecore_thread_run(Ecore_Thread_Cb func_blocking, Ecore_Thread_
1882 * @p func_heavy is cancelled or fails to start 1883 * @p func_heavy is cancelled or fails to start
1883 * @param data User context data to pass to all callback. 1884 * @param data User context data to pass to all callback.
1884 * @param try_no_queue If you want to run outside of the thread pool. 1885 * @param try_no_queue If you want to run outside of the thread pool.
1885 * @return A new thread handler, or NULL on failure 1886 * @return A new thread handler, or @c NULL on failure.
1886 * 1887 *
1887 * See ecore_thread_run() for a general description of this function. 1888 * See ecore_thread_run() for a general description of this function.
1888 * 1889 *
@@ -1918,26 +1919,26 @@ EAPI Ecore_Thread *ecore_thread_feedback_run(Ecore_Thread_Cb func_heavy, Ecore_T
1918 * Cancel a running thread. 1919 * Cancel a running thread.
1919 * 1920 *
1920 * @param thread The thread to cancel. 1921 * @param thread The thread to cancel.
1921 * @return Will return EINA_TRUE if the thread has been cancelled, 1922 * @return Will return @c EINA_TRUE if the thread has been cancelled,
1922 * EINA_FALSE if it is pending. 1923 * @c EINA_FALSE if it is pending.
1923 * 1924 *
1924 * This function can be called both in the main loop or in the running thread. 1925 * This function can be called both in the main loop or in the running thread.
1925 * 1926 *
1926 * This function cancels a running thread. If @p thread can be immediately 1927 * This function cancels a running thread. If @p thread can be immediately
1927 * cancelled (it's still pending execution after creation or rescheduling), 1928 * cancelled (it's still pending execution after creation or rescheduling),
1928 * then the @c cancel callback will be called, @p thread will be freed and 1929 * then the @c cancel callback will be called, @p thread will be freed and
1929 * the function will return EINA_TRUE. 1930 * the function will return @c EINA_TRUE.
1930 * 1931 *
1931 * If the thread is already running, then this function returns EINA_FALSE 1932 * If the thread is already running, then this function returns @c EINA_FALSE
1932 * after marking the @p thread as pending cancellation. For the thread to 1933 * after marking the @p thread as pending cancellation. For the thread to
1933 * actually be terminated, it needs to return from the user function back 1934 * actually be terminated, it needs to return from the user function back
1934 * into Ecore control. This can happen in several ways: 1935 * into Ecore control. This can happen in several ways:
1935 * @li The function ends and returns normally. If it hadn't been cancelled, 1936 * @li The function ends and returns normally. If it hadn't been cancelled,
1936 * @c func_end would be called here, but instead @c func_cancel will happen. 1937 * @c func_end would be called here, but instead @c func_cancel will happen.
1937 * @li The function returns after requesting to be rescheduled with 1938 * @li The function returns after requesting to be rescheduled with
1938 *ecore_thread_reschedule(). 1939 * ecore_thread_reschedule().
1939 * @li The function is prepared to leave early by checking if 1940 * @li The function is prepared to leave early by checking if
1940 *ecore_thread_check() returns EINA_TRUE. 1941 * ecore_thread_check() returns @c EINA_TRUE.
1941 * 1942 *
1942 * The user function can cancel itself by calling ecore_thread_cancel(), but 1943 * The user function can cancel itself by calling ecore_thread_cancel(), but
1943 * it should always use the ::Ecore_Thread handle passed to it and never 1944 * it should always use the ::Ecore_Thread handle passed to it and never
@@ -1945,7 +1946,7 @@ EAPI Ecore_Thread *ecore_thread_feedback_run(Ecore_Thread_Cb func_heavy, Ecore_T
1945 * other way. 1946 * other way.
1946 * 1947 *
1947 * @p thread will be freed and should not be used again if this function 1948 * @p thread will be freed and should not be used again if this function
1948 * returns EINA_TRUE or after the @c func_cancel callback returns. 1949 * returns @c EINA_TRUE or after the @c func_cancel callback returns.
1949 * 1950 *
1950 * @see ecore_thread_check() 1951 * @see ecore_thread_check()
1951 */ 1952 */
@@ -1954,13 +1955,13 @@ EAPI Eina_Bool ecore_thread_cancel(Ecore_Thread *thread);
1954 * Checks if a thread is pending cancellation 1955 * Checks if a thread is pending cancellation
1955 * 1956 *
1956 * @param thread The thread to test. 1957 * @param thread The thread to test.
1957 * @return EINA_TRUE if the thread is pending cancellation, 1958 * @return @c EINA_TRUE if the thread is pending cancellation,
1958 * EINA_FALSE if it is not. 1959 * @c EINA_FALSE if it is not.
1959 * 1960 *
1960 * This function can be called both in the main loop or in the running thread. 1961 * This function can be called both in the main loop or in the running thread.
1961 * 1962 *
1962 * When ecore_thread_cancel() is called on an already running task, the 1963 * When ecore_thread_cancel() is called on an already running task, the
1963 * thread is marked as pending cancellation. This function returns EINA_TRUE 1964 * thread is marked as pending cancellation. This function returns @c EINA_TRUE
1964 * if this mark is set for the given @p thread and can be used from the 1965 * if this mark is set for the given @p thread and can be used from the
1965 * main loop thread to check if a still active thread has been cancelled, 1966 * main loop thread to check if a still active thread has been cancelled,
1966 * or from the user function running in the thread to check if it should 1967 * or from the user function running in the thread to check if it should
@@ -1975,13 +1976,13 @@ EAPI Eina_Bool ecore_thread_check(Ecore_Thread *thread);
1975 * 1976 *
1976 * @param thread The current ::Ecore_Thread context to send data from 1977 * @param thread The current ::Ecore_Thread context to send data from
1977 * @param msg_data Data to be transmitted to the main loop 1978 * @param msg_data Data to be transmitted to the main loop
1978 * @return EINA_TRUE if @p msg_data was successfully sent to main loop, 1979 * @return @c EINA_TRUE if @p msg_data was successfully sent to main loop,
1979 * EINA_FALSE if anything goes wrong. 1980 * @c EINA_FALSE if anything goes wrong.
1980 * 1981 *
1981 * You should use this function only in the @c func_heavy call. 1982 * You should use this function only in the @c func_heavy call.
1982 * 1983 *
1983 * Only the address to @p msg_data will be sent and once this function 1984 * Only the address to @p msg_data will be sent and once this function
1984 * returns EINA_TRUE, the job running in the thread should never touch the 1985 * returns @c EINA_TRUE, the job running in the thread should never touch the
1985 * contents of it again. The data sent should be malloc()'ed or something 1986 * contents of it again. The data sent should be malloc()'ed or something
1986 * similar, as long as it's not memory local to the thread that risks being 1987 * similar, as long as it's not memory local to the thread that risks being
1987 * overwritten or deleted once it goes out of scope or the thread finishes. 1988 * overwritten or deleted once it goes out of scope or the thread finishes.
@@ -1996,8 +1997,8 @@ EAPI Eina_Bool ecore_thread_feedback(Ecore_Thread *thread, const void *msg_data)
1996 * Asks for the function in the thread to be called again at a later time 1997 * Asks for the function in the thread to be called again at a later time
1997 * 1998 *
1998 * @param thread The current ::Ecore_Thread context to rescheduled 1999 * @param thread The current ::Ecore_Thread context to rescheduled
1999 * @return EINA_TRUE if the task was successfully rescheduled, 2000 * @return @c EINA_TRUE if the task was successfully rescheduled,
2000 * EINA_FALSE if anything goes wrong. 2001 * @c EINA_FALSE if anything goes wrong.
2001 * 2002 *
2002 * This function should be called only from the same function represented 2003 * This function should be called only from the same function represented
2003 * by @p thread. 2004 * by @p thread.
@@ -2007,7 +2008,7 @@ EAPI Eina_Bool ecore_thread_feedback(Ecore_Thread *thread, const void *msg_data)
2007 * If no other tasks are waiting or there are sufficient threads available, 2008 * If no other tasks are waiting or there are sufficient threads available,
2008 * the rescheduled task will be launched again immediately. 2009 * the rescheduled task will be launched again immediately.
2009 * 2010 *
2010 * This should never return EINA_FALSE, unless it was called from the wrong 2011 * This should never return @c EINA_FALSE, unless it was called from the wrong
2011 * thread or with the wrong arguments. 2012 * thread or with the wrong arguments.
2012 * 2013 *
2013 * The @c func_end callback set when the thread is created will not be 2014 * The @c func_end callback set when the thread is created will not be
@@ -2025,7 +2026,7 @@ EAPI Eina_Bool ecore_thread_reschedule(Ecore_Thread *thread);
2025 * through the Ecore_Thread API. 2026 * through the Ecore_Thread API.
2026 * 2027 *
2027 * @note Jobs started through the ecore_thread_feedback_run() function with 2028 * @note Jobs started through the ecore_thread_feedback_run() function with
2028 * the @c try_no_queue parameter set to EINA_TRUE will not be accounted for 2029 * the @c try_no_queue parameter set to @c EINA_TRUE will not be accounted for
2029 * in the return of this function unless the thread creation fails and it 2030 * in the return of this function unless the thread creation fails and it
2030 * falls back to using one from the pool. 2031 * falls back to using one from the pool.
2031 */ 2032 */
@@ -2120,7 +2121,7 @@ EAPI int ecore_thread_available_get(void);
2120 * @param cb Function to free the data when removed from the hash 2121 * @param cb Function to free the data when removed from the hash
2121 * @param direct If true, this will not copy the key string (like 2122 * @param direct If true, this will not copy the key string (like
2122 * eina_hash_direct_add()) 2123 * eina_hash_direct_add())
2123 * @return EINA_TRUE on success, EINA_FALSE on failure 2124 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
2124 * 2125 *
2125 * Ecore Thread has a mechanism to share data across several worker functions 2126 * Ecore Thread has a mechanism to share data across several worker functions
2126 * that run on the same system thread. That is, the data is stored per 2127 * that run on the same system thread. That is, the data is stored per
@@ -2174,7 +2175,7 @@ EAPI int ecore_thread_available_get(void);
2174 * change the value under a @p key, or you don't know if one exists already, 2175 * change the value under a @p key, or you don't know if one exists already,
2175 * you can use ecore_thread_local_data_set(). 2176 * you can use ecore_thread_local_data_set().
2176 * 2177 *
2177 * Neither @p key nor @p value may be NULL and @p key will be copied in the 2178 * Neither @p key nor @p value may be @c NULL and @p key will be copied in the
2178 * hash, unless @p direct is set, in which case the string used should not 2179 * hash, unless @p direct is set, in which case the string used should not
2179 * be freed until the data is removed from the hash. 2180 * be freed until the data is removed from the hash.
2180 * 2181 *
@@ -2183,7 +2184,7 @@ EAPI int ecore_thread_available_get(void);
2183 * because @p thread was terminated and the hash destroyed. This parameter 2184 * because @p thread was terminated and the hash destroyed. This parameter
2184 * may be NULL, in which case @p value needs to be manually freed after 2185 * may be NULL, in which case @p value needs to be manually freed after
2185 * removing it from the hash with either ecore_thread_local_data_del() or 2186 * removing it from the hash with either ecore_thread_local_data_del() or
2186 *ecore_thread_local_data_set(), but it's very unlikely that this is what 2187 * ecore_thread_local_data_set(), but it's very unlikely that this is what
2187 * you want. 2188 * you want.
2188 * 2189 *
2189 * This function, and all of the others in the @c ecore_thread_local_data 2190 * This function, and all of the others in the @c ecore_thread_local_data
@@ -2212,8 +2213,8 @@ EAPI Eina_Bool ecore_thread_local_data_add(Ecore_Thread *thread, const char *key
2212 * If the hash already contains something under @p key, the data will be 2213 * If the hash already contains something under @p key, the data will be
2213 * replaced by @p value and the old value will be returned. 2214 * replaced by @p value and the old value will be returned.
2214 * 2215 *
2215 * NULL will also be returned if either @p key or @p value are NULL, or if 2216 * @c NULL will also be returned if either @p key or @p value are @c NULL, or
2216 * an error occurred. 2217 * if an error occurred.
2217 * 2218 *
2218 * This function, and all of the others in the @c ecore_thread_local_data 2219 * This function, and all of the others in the @c ecore_thread_local_data
2219 * family of functions, can only be called within the worker function running 2220 * family of functions, can only be called within the worker function running
@@ -2230,7 +2231,7 @@ EAPI void *ecore_thread_local_data_set(Ecore_Thread *thread, const char *key, vo
2230 * 2231 *
2231 * @param thread The thread context the data belongs to 2232 * @param thread The thread context the data belongs to
2232 * @param key The name under which the data is stored 2233 * @param key The name under which the data is stored
2233 * @return The value under the given key, or NULL on error 2234 * @return The value under the given key, or @c NULL on error.
2234 * 2235 *
2235 * Finds and return the data stored in the shared hash under the key @p key. 2236 * Finds and return the data stored in the shared hash under the key @p key.
2236 * 2237 *
@@ -2248,11 +2249,11 @@ EAPI void *ecore_thread_local_data_find(Ecore_Thread *thread, const char *key);
2248 * 2249 *
2249 * @param thread The thread context the data belongs to 2250 * @param thread The thread context the data belongs to
2250 * @param key The name under which the data is stored 2251 * @param key The name under which the data is stored
2251 * @return EINA_TRUE on success, EINA_FALSE on failure 2252 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
2252 * 2253 *
2253 * If there's any data stored associated with @p key in the global hash, 2254 * If there's any data stored associated with @p key in the global hash,
2254 * this function will remove it from it and return EINA_TRUE. If no data 2255 * this function will remove it from it and return @c EINA_TRUE. If no data
2255 * exists or an error occurs, it returns EINA_FALSE. 2256 * exists or an error occurs, it returns @c EINA_FALSE.
2256 * 2257 *
2257 * If the data was added to the hash with a free function, then it will 2258 * If the data was added to the hash with a free function, then it will
2258 * also be freed after removing it from the hash, otherwise it requires 2259 * also be freed after removing it from the hash, otherwise it requires
@@ -2277,7 +2278,7 @@ EAPI Eina_Bool ecore_thread_local_data_del(Ecore_Thread *thread, const char *key
2277 * @param cb Function to free the data when removed from the hash 2278 * @param cb Function to free the data when removed from the hash
2278 * @param direct If true, this will not copy the key string (like 2279 * @param direct If true, this will not copy the key string (like
2279 * eina_hash_direct_add()) 2280 * eina_hash_direct_add())
2280 * @return EINA_TRUE on success, EINA_FALSE on failure 2281 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
2281 * 2282 *
2282 * Ecore Thread keeps a hash that can be used to share data across several 2283 * Ecore Thread keeps a hash that can be used to share data across several
2283 * threads, including the main loop one, without having to manually handle 2284 * threads, including the main loop one, without having to manually handle
@@ -2288,7 +2289,7 @@ EAPI Eina_Bool ecore_thread_local_data_del(Ecore_Thread *thread, const char *key
2288 * change the value under a @p key, or you don't know if one exists already, 2289 * change the value under a @p key, or you don't know if one exists already,
2289 * you can use ecore_thread_global_data_set(). 2290 * you can use ecore_thread_global_data_set().
2290 * 2291 *
2291 * Neither @p key nor @p value may be NULL and @p key will be copied in the 2292 * Neither @p key nor @p value may be @c NULL and @p key will be copied in the
2292 * hash, unless @p direct is set, in which case the string used should not 2293 * hash, unless @p direct is set, in which case the string used should not
2293 * be freed until the data is removed from the hash. 2294 * be freed until the data is removed from the hash.
2294 * 2295 *
@@ -2322,8 +2323,8 @@ EAPI Eina_Bool ecore_thread_global_data_add(const char *key, void *value, Eina_F
2322 * If the hash already contains something under @p key, the data will be 2323 * If the hash already contains something under @p key, the data will be
2323 * replaced by @p value and the old value will be returned. 2324 * replaced by @p value and the old value will be returned.
2324 * 2325 *
2325 * NULL will also be returned if either @p key or @p value are NULL, or if 2326 * @c NULL will also be returned if either @p key or @p value are @c NULL, or
2326 * an error occurred. 2327 * if an error occurred.
2327 * 2328 *
2328 * @see ecore_thread_global_data_add() 2329 * @see ecore_thread_global_data_add()
2329 * @see ecore_thread_global_data_del() 2330 * @see ecore_thread_global_data_del()
@@ -2334,7 +2335,7 @@ EAPI void *ecore_thread_global_data_set(const char *key, void *value, Eina_Free_
2334 * Gets data stored in the hash shared by all threads 2335 * Gets data stored in the hash shared by all threads
2335 * 2336 *
2336 * @param key The name under which the data is stored 2337 * @param key The name under which the data is stored
2337 * @return The value under the given key, or NULL on error 2338 * @return The value under the given key, or @c NULL on error.
2338 * 2339 *
2339 * Finds and return the data stored in the shared hash under the key @p key. 2340 * Finds and return the data stored in the shared hash under the key @p key.
2340 * 2341 *
@@ -2351,11 +2352,11 @@ EAPI void *ecore_thread_global_data_find(const char *key);
2351 * Deletes from the shared hash the data corresponding to the given key 2352 * Deletes from the shared hash the data corresponding to the given key
2352 * 2353 *
2353 * @param key The name under which the data is stored 2354 * @param key The name under which the data is stored
2354 * @return EINA_TRUE on success, EINA_FALSE on failure 2355 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
2355 * 2356 *
2356 * If there's any data stored associated with @p key in the global hash, 2357 * If there's any data stored associated with @p key in the global hash,
2357 * this function will remove it from it and return EINA_TRUE. If no data 2358 * this function will remove it from it and return @c EINA_TRUE. If no data
2358 * exists or an error occurs, it returns EINA_FALSE. 2359 * exists or an error occurs, it returns @c EINA_FALSE.
2359 * 2360 *
2360 * If the data was added to the hash with a free function, then it will 2361 * If the data was added to the hash with a free function, then it will
2361 * also be freed after removing it from the hash, otherwise it requires 2362 * also be freed after removing it from the hash, otherwise it requires
@@ -2375,15 +2376,15 @@ EAPI Eina_Bool ecore_thread_global_data_del(const char *key);
2375 * 2376 *
2376 * @param key The name under which the data is stored 2377 * @param key The name under which the data is stored
2377 * @param seconds The amount of time in seconds to wait for the data. 2378 * @param seconds The amount of time in seconds to wait for the data.
2378 * @return The value under the given key, or NULL on error 2379 * @return The value under the given key, or @c NULL on error.
2379 * 2380 *
2380 * Finds and return the data stored in the shared hash under the key @p key. 2381 * Finds and return the data stored in the shared hash under the key @p key.
2381 * 2382 *
2382 * If there's nothing in the hash under the given @p key, the function 2383 * If there's nothing in the hash under the given @p key, the function
2383 * will block and wait up to @p seconds seconds for some other thread to 2384 * will block and wait up to @p seconds seconds for some other thread to
2384 * add it with either ecore_thread_global_data_add() or 2385 * add it with either ecore_thread_global_data_add() or
2385 *ecore_thread_global_data_set(). If after waiting there's still no data 2386 * ecore_thread_global_data_set(). If after waiting there's still no data
2386 * to get, NULL will be returned. 2387 * to get, @c NULL will be returned.
2387 * 2388 *
2388 * If @p seconds is 0, then no waiting will happen and this function works 2389 * If @p seconds is 0, then no waiting will happen and this function works
2389 * like ecore_thread_global_data_find(). If @p seconds is less than 0, then 2390 * like ecore_thread_global_data_find(). If @p seconds is less than 0, then
diff --git a/legacy/ecore/src/lib/ecore/ecore_exe.c b/legacy/ecore/src/lib/ecore/ecore_exe.c
index b59d2cc370..719bc17542 100644
--- a/legacy/ecore/src/lib/ecore/ecore_exe.c
+++ b/legacy/ecore/src/lib/ecore/ecore_exe.c
@@ -733,7 +733,7 @@ ecore_exe_callback_pre_free_set(Ecore_Exe *exe,
733 * @param exe The child process to send to 733 * @param exe The child process to send to
734 * @param data The data to send 734 * @param data The data to send
735 * @param size The size of the data to send, in bytes 735 * @param size The size of the data to send, in bytes
736 * @return EINA_TRUE if successful, EINA_FALSE on failure. 736 * @return @c EINA_TRUE if successful, @c EINA_FALSE on failure.
737 */ 737 */
738EAPI Eina_Bool 738EAPI Eina_Bool
739ecore_exe_send(Ecore_Exe *exe, 739ecore_exe_send(Ecore_Exe *exe,
@@ -1145,7 +1145,7 @@ ecore_exe_pid_get(const Ecore_Exe *exe)
1145/** 1145/**
1146 * Retrieves the command of the given spawned process. 1146 * Retrieves the command of the given spawned process.
1147 * @param exe Handle to the given spawned process. 1147 * @param exe Handle to the given spawned process.
1148 * @return The command on success. NULL otherwise. This string is the 1148 * @return The command on success, @c NULL otherwise. This string is the
1149 * pointer to the internal value and must not be modified in 1149 * pointer to the internal value and must not be modified in
1150 * any way. 1150 * any way.
1151 */ 1151 */
diff --git a/legacy/ecore/src/lib/ecore/ecore_getopt.c b/legacy/ecore/src/lib/ecore/ecore_getopt.c
index 8d023dc97f..984cffd038 100644
--- a/legacy/ecore/src/lib/ecore/ecore_getopt.c
+++ b/legacy/ecore/src/lib/ecore/ecore_getopt.c
@@ -1674,7 +1674,7 @@ _ecore_getopt_parse_find_long_other(const Ecore_Getopt *parser,
1674/** 1674/**
1675 * Check parser for duplicate entries, print them out. 1675 * Check parser for duplicate entries, print them out.
1676 * 1676 *
1677 * @return EINA_TRUE if there are duplicates, EINA_FALSE otherwise. 1677 * @return @c EINA_TRUE if there are duplicates, @c EINA_FALSE otherwise.
1678 */ 1678 */
1679EAPI Eina_Bool 1679EAPI Eina_Bool
1680ecore_getopt_parser_has_duplicates(const Ecore_Getopt *parser) 1680ecore_getopt_parser_has_duplicates(const Ecore_Getopt *parser)
@@ -1743,8 +1743,9 @@ _ecore_getopt_find_help(const Ecore_Getopt *parser)
1743 * (others than @c ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES), are expected 1743 * (others than @c ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES), are expected
1744 * to provide a value in @c def to be used. 1744 * to provide a value in @c def to be used.
1745 * 1745 *
1746 * The following actions will store 1 on value as a boolean 1746 * The following actions will store @c 1 on value as a boolean
1747 * (@c value->boolp) if it's not NULL to indicate these actions were executed: 1747 * (@c value->boolp) if it's not @c NULL to indicate these actions were
1748 * executed:
1748 * - @c ECORE_GETOPT_ACTION_HELP 1749 * - @c ECORE_GETOPT_ACTION_HELP
1749 * - @c ECORE_GETOPT_ACTION_VERSION 1750 * - @c ECORE_GETOPT_ACTION_VERSION
1750 * - @c ECORE_GETOPT_ACTION_COPYRIGHT 1751 * - @c ECORE_GETOPT_ACTION_COPYRIGHT
@@ -1758,7 +1759,7 @@ _ecore_getopt_find_help(const Ecore_Getopt *parser)
1758 * integer and so on. 1759 * integer and so on.
1759 * 1760 *
1760 * If parser is in strict mode (see @c Ecore_Getopt->strict), then any 1761 * If parser is in strict mode (see @c Ecore_Getopt->strict), then any
1761 * error will abort parsing and -1 is returned. Otherwise it will try 1762 * error will abort parsing and @c -1 is returned. Otherwise it will try
1762 * to continue as far as possible. 1763 * to continue as far as possible.
1763 * 1764 *
1764 * This function may reorder @a argv elements. 1765 * This function may reorder @a argv elements.
@@ -1845,7 +1846,7 @@ error:
1845 * Utility to free list and nodes allocated by @a ECORE_GETOPT_ACTION_APPEND. 1846 * Utility to free list and nodes allocated by @a ECORE_GETOPT_ACTION_APPEND.
1846 * 1847 *
1847 * @param list pointer to list to be freed. 1848 * @param list pointer to list to be freed.
1848 * @return always NULL, so you can easily make your list head NULL. 1849 * @return always @c NULL, so you can easily make your list head @c NULL.
1849 */ 1850 */
1850EAPI Eina_List * 1851EAPI Eina_List *
1851ecore_getopt_list_free(Eina_List *list) 1852ecore_getopt_list_free(Eina_List *list)
@@ -1863,7 +1864,7 @@ ecore_getopt_list_free(Eina_List *list)
1863 * @param str Geometry value 1864 * @param str Geometry value
1864 * @param storage must be a pointer to @c Eina_Rectangle and will be used to 1865 * @param storage must be a pointer to @c Eina_Rectangle and will be used to
1865 * store the four values passed in the given string. 1866 * store the four values passed in the given string.
1866 * @return EINA_TRUE on success, EINA_FALSE on incorrect geometry value. 1867 * @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect geometry value.
1867 * 1868 *
1868 * @c callback_data value is ignored, you can safely use @c NULL. 1869 * @c callback_data value is ignored, you can safely use @c NULL.
1869 */ 1870 */
@@ -1890,9 +1891,9 @@ ecore_getopt_callback_geometry_parse(const Ecore_Getopt *parser __UNUSED__,
1890 * 1891 *
1891 * @param str size value 1892 * @param str size value
1892 * @param storage must be a pointer to @c Eina_Rectangle and will be used to 1893 * @param storage must be a pointer to @c Eina_Rectangle and will be used to
1893 * store the two values passed in the given string and 0 in the x and y 1894 * store the two values passed in the given string and @c 0 in the x and y
1894 * fields. 1895 * fields.
1895 * @return EINA_TRUE on success, EINA_FALSE on incorrect size value. 1896 * @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect size value.
1896 * 1897 *
1897 * @c callback_data value is ignored, you can safely use @c NULL. 1898 * @c callback_data value is ignored, you can safely use @c NULL.
1898 */ 1899 */
diff --git a/legacy/ecore/src/lib/ecore/ecore_pipe.c b/legacy/ecore/src/lib/ecore/ecore_pipe.c
index eb4a1dc96a..debdbe846d 100644
--- a/legacy/ecore/src/lib/ecore/ecore_pipe.c
+++ b/legacy/ecore/src/lib/ecore/ecore_pipe.c
@@ -373,7 +373,7 @@ ecore_pipe_write_close(Ecore_Pipe *p)
373 * @param p The Ecore_Pipe object. 373 * @param p The Ecore_Pipe object.
374 * @param buffer The data to write into the pipe. 374 * @param buffer The data to write into the pipe.
375 * @param nbytes The size of the @p buffer in bytes 375 * @param nbytes The size of the @p buffer in bytes
376 * @return Returns EINA_TRUE on a successful write, EINA_FALSE on an error 376 * @return @c EINA_TRUE on a successful write, @c EINA_FALSE on error.
377 */ 377 */
378EAPI Eina_Bool 378EAPI Eina_Bool
379ecore_pipe_write(Ecore_Pipe *p, 379ecore_pipe_write(Ecore_Pipe *p,
diff --git a/legacy/ecore/src/lib/ecore_con/Ecore_Con.h b/legacy/ecore/src/lib/ecore_con/Ecore_Con.h
index e497a19bcd..6eaf63c471 100644
--- a/legacy/ecore/src/lib/ecore_con/Ecore_Con.h
+++ b/legacy/ecore/src/lib/ecore_con/Ecore_Con.h
@@ -681,8 +681,8 @@ EAPI int ecore_con_shutdown(void);
681 * @param name IP address or server name to translate. 681 * @param name IP address or server name to translate.
682 * @param done_cb Callback to notify when done. 682 * @param done_cb Callback to notify when done.
683 * @param data User data to be given to done_cb. 683 * @param data User data to be given to done_cb.
684 * @return EINA_TRUE if the request did not fail to be set up, EINA_FALSE if it 684 * @return @c EINA_TRUE if the request did not fail to be set up, @c EINA_FALSE
685 * failed. 685 * if it failed.
686 * 686 *
687 * This function performs a DNS lookup on the hostname specified by @p name, 687 * This function performs a DNS lookup on the hostname specified by @p name,
688 * then calls @p done_cb with the result and the @p data given as parameter. 688 * then calls @p done_cb with the result and the @p data given as parameter.
@@ -915,7 +915,7 @@ EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr,
915 * Retrieves whether the given server is currently connected. 915 * Retrieves whether the given server is currently connected.
916 * 916 *
917 * @param svr The given server. 917 * @param svr The given server.
918 * @return #EINA_TRUE if the server is connected. #EINA_FALSE otherwise. 918 * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise.
919 */ 919 */
920EAPI Eina_Bool ecore_con_server_connected_get(Ecore_Con_Server *svr); 920EAPI Eina_Bool ecore_con_server_connected_get(Ecore_Con_Server *svr);
921/** 921/**
@@ -1013,7 +1013,8 @@ EAPI void ecore_con_server_client_limit_set(Ecore_Con_Server *svr,
1013 * @return A pointer to an internal string that contains the IP address of 1013 * @return A pointer to an internal string that contains the IP address of
1014 * the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation. 1014 * the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation.
1015 * This string should not be modified or trusted to stay valid after 1015 * This string should not be modified or trusted to stay valid after
1016 * deletion for the @p svr object. If no IP is known NULL is returned. 1016 * deletion for the @p svr object. If no IP is known @c NULL is
1017 * returned.
1017 */ 1018 */
1018EAPI const char * ecore_con_server_ip_get(Ecore_Con_Server *svr); 1019EAPI const char * ecore_con_server_ip_get(Ecore_Con_Server *svr);
1019/** 1020/**
@@ -1167,7 +1168,7 @@ EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl);
1167 * the connected client in the form "XXX.YYY.ZZZ.AAA" IP notation. 1168 * the connected client in the form "XXX.YYY.ZZZ.AAA" IP notation.
1168 * 1169 *
1169 * The returned string should not be modified, freed or trusted to stay valid 1170 * The returned string should not be modified, freed or trusted to stay valid
1170 * after deletion for the @p cl object. If no IP is known NULL is returned. 1171 * after deletion for the @p cl object. If no IP is known @c NULL is returned.
1171 */ 1172 */
1172EAPI const char * ecore_con_client_ip_get(Ecore_Con_Client *cl); 1173EAPI const char * ecore_con_client_ip_get(Ecore_Con_Client *cl);
1173/** 1174/**
@@ -1228,7 +1229,7 @@ EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double
1228 * Returns whether the client is still connected 1229 * Returns whether the client is still connected
1229 * 1230 *
1230 * @param cl The given client. 1231 * @param cl The given client.
1231 * @return #EINA_TRUE if connected, else EINA_FALSE 1232 * @return @c EINA_TRUE if connected, @c EINA_FALSE otherwise.
1232 */ 1233 */
1233EAPI Eina_Bool ecore_con_client_connected_get(Ecore_Con_Client *cl); 1234EAPI Eina_Bool ecore_con_client_connected_get(Ecore_Con_Client *cl);
1234/** 1235/**
@@ -1361,7 +1362,7 @@ typedef enum _Ecore_Con_Url_Http_Version
1361 * Change the HTTP version used for the request 1362 * Change the HTTP version used for the request
1362 * @param url_con Connection object through which the request will be sent. 1363 * @param url_con Connection object through which the request will be sent.
1363 * @param version The version to be used 1364 * @param version The version to be used
1364 * @return EINA_TRUE on success, EINA_FALSE on failure to change version 1365 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure to change version.
1365 * @since 1.2 1366 * @since 1.2
1366 * @see ecore_con_url_pipeline_get() 1367 * @see ecore_con_url_pipeline_get()
1367 */ 1368 */
@@ -1388,7 +1389,7 @@ EAPI int ecore_con_url_shutdown(void);
1388 1389
1389/** 1390/**
1390 * Enable or disable HTTP 1.1 pipelining. 1391 * Enable or disable HTTP 1.1 pipelining.
1391 * @param enable EINA_TRUE will turn it on, EINA_FALSE will disable it. 1392 * @param enable @c EINA_TRUE will turn it on, @c EINA_FALSE will disable it.
1392 * 1393 *
1393 * Pipelining allows to send one request after another one, without having to 1394 * Pipelining allows to send one request after another one, without having to
1394 * wait for the reply of the first request. The respective replies are received 1395 * wait for the reply of the first request. The respective replies are received
@@ -1404,7 +1405,7 @@ EAPI int ecore_con_url_shutdown(void);
1404EAPI void ecore_con_url_pipeline_set(Eina_Bool enable); 1405EAPI void ecore_con_url_pipeline_set(Eina_Bool enable);
1405/** 1406/**
1406 * Is HTTP 1.1 pipelining enable ? 1407 * Is HTTP 1.1 pipelining enable ?
1407 * @return EINA_TRUE if it is enable. 1408 * @return @c EINA_TRUE if it is enable.
1408 * 1409 *
1409 * @see ecore_con_url_pipeline_set() 1410 * @see ecore_con_url_pipeline_set()
1410 */ 1411 */
@@ -1416,7 +1417,7 @@ EAPI Eina_Bool ecore_con_url_pipeline_get(void);
1416 * @param url URL that will receive requests. Can be changed using 1417 * @param url URL that will receive requests. Can be changed using
1417 * ecore_con_url_url_set. 1418 * ecore_con_url_url_set.
1418 * 1419 *
1419 * @return NULL on error, a new Ecore_Con_Url on success. 1420 * @return @c NULL on error, a new Ecore_Con_Url on success.
1420 * 1421 *
1421 * Creates and initializes a new Ecore_Con_Url connection object that can be 1422 * Creates and initializes a new Ecore_Con_Url connection object that can be
1422 * used for sending requests. 1423 * used for sending requests.
@@ -1431,7 +1432,7 @@ EAPI Ecore_Con_Url * ecore_con_url_new(const char *url);
1431 * @param url URL that will receive requests 1432 * @param url URL that will receive requests
1432 * @param custom_request Custom request (e.g. GET, POST, HEAD, PUT, etc) 1433 * @param custom_request Custom request (e.g. GET, POST, HEAD, PUT, etc)
1433 * 1434 *
1434 * @return NULL on error, a new Ecore_Con_Url on success. 1435 * @return @c NULL on error, a new Ecore_Con_Url on success.
1435 * 1436 *
1436 * Creates and initializes a new Ecore_Con_Url for a custom request (e.g. HEAD, 1437 * Creates and initializes a new Ecore_Con_Url for a custom request (e.g. HEAD,
1437 * SUBSCRIBE and other obscure HTTP requests). This object should be used like 1438 * SUBSCRIBE and other obscure HTTP requests). This object should be used like
@@ -1456,8 +1457,7 @@ EAPI void ecore_con_url_free(Ecore_Con_Url *url_con);
1456 * @param url_con Connection object through which the request will be sent. 1457 * @param url_con Connection object through which the request will be sent.
1457 * @param url URL that will receive the request 1458 * @param url URL that will receive the request
1458 * 1459 *
1459 * @return EINA_TRUE on success, EINA_FALSE on error. 1460 * @return @c EINA_TRUE on success, @c EINA_FALSE on error.
1460 *
1461 */ 1461 */
1462EAPI Eina_Bool ecore_con_url_url_set(Ecore_Con_Url *url_con, 1462EAPI Eina_Bool ecore_con_url_url_set(Ecore_Con_Url *url_con,
1463 const char *url); 1463 const char *url);
@@ -1465,7 +1465,8 @@ EAPI Eina_Bool ecore_con_url_url_set(Ecore_Con_Url *url_con,
1465 * Gets the URL to send the request to. 1465 * Gets the URL to send the request to.
1466 * 1466 *
1467 * @param url_con Connection object through which the request will be sent. 1467 * @param url_con Connection object through which the request will be sent.
1468 * @return URL that will receive the request, NULL on failure. URL is stringshared. 1468 * @return URL that will receive the request, @c NULL on failure. URL is
1469 * stringshared.
1469 * @since 1.1 1470 * @since 1.1
1470 */ 1471 */
1471EAPI const char *ecore_con_url_url_get(Ecore_Con_Url *url_con); 1472EAPI const char *ecore_con_url_url_get(Ecore_Con_Url *url_con);
@@ -1578,9 +1579,10 @@ EAPI int ecore_con_url_received_bytes_get(Ecore_Con_Url *url_con);
1578 * @param password Password to use in authentication 1579 * @param password Password to use in authentication
1579 * @param safe Whether to use "safer" methods (eg, NOT http basic auth) 1580 * @param safe Whether to use "safer" methods (eg, NOT http basic auth)
1580 * 1581 *
1581 * @return #EINA_TRUE on success, #EINA_FALSE on error. 1582 * @return @c EINA_TRUE on success, @c EINA_FALSE on error.
1582 * 1583 *
1583 * ATTENTION: requires libcurl >= 7.19.1 to work, otherwise will always return 0. 1584 * @attention Requires libcurl >= 7.19.1 to work, otherwise will always return
1585 * @c 0.
1584 */ 1586 */
1585EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con, 1587EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con,
1586 const char *username, 1588 const char *username,
@@ -1591,7 +1593,7 @@ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con,
1591 * 1593 *
1592 * @param url_con Connection object to perform a request on, previously created 1594 * @param url_con Connection object to perform a request on, previously created
1593 * 1595 *
1594 * @return #EINA_TRUE on success, #EINA_FALSE on error. 1596 * @return @c EINA_TRUE on success, @c EINA_FALSE on error.
1595 * 1597 *
1596 * The request is performed immediately, but you need to setup event handlers 1598 * The request is performed immediately, but you need to setup event handlers
1597 * for #ECORE_CON_EVENT_URL_DATA, #ECORE_CON_EVENT_URL_COMPLETE or 1599 * for #ECORE_CON_EVENT_URL_DATA, #ECORE_CON_EVENT_URL_COMPLETE or
@@ -1618,7 +1620,7 @@ EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con);
1618 * @param content_type Content type of the payload (e.g. text/xml). Can be @c 1620 * @param content_type Content type of the payload (e.g. text/xml). Can be @c
1619 * NULL. 1621 * NULL.
1620 * 1622 *
1621 * @return #EINA_TRUE on success, #EINA_FALSE on error. 1623 * @return @c EINA_TRUE on success, @c EINA_FALSE on error.
1622 * 1624 *
1623 * The request starts immediately, but you need to setup event handlers 1625 * The request starts immediately, but you need to setup event handlers
1624 * for #ECORE_CON_EVENT_URL_DATA, #ECORE_CON_EVENT_URL_COMPLETE or 1626 * for #ECORE_CON_EVENT_URL_DATA, #ECORE_CON_EVENT_URL_COMPLETE or
@@ -1659,12 +1661,14 @@ EAPI void ecore_con_url_time(Ecore_Con_Url *url_con,
1659 1661
1660/** 1662/**
1661 * @brief Uploads a file to an ftp site. 1663 * @brief Uploads a file to an ftp site.
1664 *
1662 * @param url_con The Ecore_Con_Url object to send with 1665 * @param url_con The Ecore_Con_Url object to send with
1663 * @param filename The path to the file to send 1666 * @param filename The path to the file to send
1664 * @param user The username to log in with 1667 * @param user The username to log in with
1665 * @param pass The password to log in with 1668 * @param pass The password to log in with
1666 * @param upload_dir The directory to which the file should be uploaded 1669 * @param upload_dir The directory to which the file should be uploaded
1667 * @return #EINA_TRUE on success, else #EINA_FALSE. 1670 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1671 *
1668 * Upload @p filename to an ftp server set in @p url_con using @p user 1672 * Upload @p filename to an ftp server set in @p url_con using @p user
1669 * and @p pass to directory @p upload_dir 1673 * and @p pass to directory @p upload_dir
1670 */ 1674 */
@@ -1864,7 +1868,7 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con,
1864 * @param url_con Connection object that will use the proxy. 1868 * @param url_con Connection object that will use the proxy.
1865 * @param proxy Porxy string or @c NULL to disable 1869 * @param proxy Porxy string or @c NULL to disable
1866 * 1870 *
1867 * @return #EINA_TRUE on success, #EINA_FALSE on error. 1871 * @return @c EINA_TRUE on success, @c EINA_FALSE on error.
1868 * @since 1.2 1872 * @since 1.2
1869 */ 1873 */
1870EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy); 1874EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy);
@@ -1877,7 +1881,7 @@ EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy
1877 * @param url_con Connection object that will use the proxy. 1881 * @param url_con Connection object that will use the proxy.
1878 * @param username Username string. 1882 * @param username Username string.
1879 * 1883 *
1880 * @return #EINA_TRUE on success, #EINA_FALSE on error. 1884 * @return @c EINA_TRUE on success, @c EINA_FALSE on error.
1881 * 1885 *
1882 * @see ecore_con_url_proxy_set() 1886 * @see ecore_con_url_proxy_set()
1883 * 1887 *
@@ -1893,7 +1897,7 @@ EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const ch
1893 * @param url_con Connection object that will use the proxy. 1897 * @param url_con Connection object that will use the proxy.
1894 * @param password Password string. 1898 * @param password Password string.
1895 * 1899 *
1896 * @return #EINA_TRUE on success, #EINA_FALSE on error. 1900 * @return @c EINA_TRUE on success, @c EINA_FALSE on error.
1897 * 1901 *
1898 * @see ecore_con_url_proxy_set() 1902 * @see ecore_con_url_proxy_set()
1899 * 1903 *
diff --git a/legacy/ecore/src/lib/ecore_con/ecore_con_private.h b/legacy/ecore/src/lib/ecore_con/ecore_con_private.h
index 91f5d397e5..4f8f79230b 100644
--- a/legacy/ecore/src/lib/ecore_con/ecore_con_private.h
+++ b/legacy/ecore/src/lib/ecore_con/ecore_con_private.h
@@ -174,15 +174,15 @@ struct _Ecore_Con_Server
174 double disconnect_time; 174 double disconnect_time;
175 double client_disconnect_time; 175 double client_disconnect_time;
176 const char *ip; 176 const char *ip;
177 Eina_Bool created : 1; /* EINA_TRUE if server is our listening server */ 177 Eina_Bool created : 1; /* @c EINA_TRUE if server is our listening server */
178 Eina_Bool connecting : 1; /* EINA_FALSE if just initialized or connected */ 178 Eina_Bool connecting : 1; /* @c EINA_FALSE if just initialized or connected */
179 Eina_Bool handshaking : 1; /* EINA_TRUE if server is ssl handshaking */ 179 Eina_Bool handshaking : 1; /* @c EINA_TRUE if server is ssl handshaking */
180 Eina_Bool upgrade : 1; /* STARTTLS queued */ 180 Eina_Bool upgrade : 1; /* STARTTLS queued */
181 Eina_Bool ssl_prepared : 1; 181 Eina_Bool ssl_prepared : 1;
182 Eina_Bool use_cert : 1; /* EINA_TRUE if using certificate auth */ 182 Eina_Bool use_cert : 1; /* @c EINA_TRUE if using certificate auth */
183 Ecore_Con_Ssl_State ssl_state; /* current state of ssl handshake on the server */ 183 Ecore_Con_Ssl_State ssl_state; /* current state of ssl handshake on the server */
184 Eina_Bool verify : 1; /* EINA_TRUE if certificates will be verified */ 184 Eina_Bool verify : 1; /* @c EINA_TRUE if certificates will be verified */
185 Eina_Bool verify_basic : 1; /* EINA_TRUE if certificates will be verified only against the hostname */ 185 Eina_Bool verify_basic : 1; /* @c EINA_TRUE if certificates will be verified only against the hostname */
186 Eina_Bool reject_excess_clients : 1; 186 Eina_Bool reject_excess_clients : 1;
187 Eina_Bool delete_me : 1; /* del event has been queued */ 187 Eina_Bool delete_me : 1; /* del event has been queued */
188#ifdef _WIN32 188#ifdef _WIN32
diff --git a/legacy/ecore/src/lib/ecore_con/ecore_con_ssl.c b/legacy/ecore/src/lib/ecore_con/ecore_con_ssl.c
index 28879962ff..fd4c9dd0a1 100644
--- a/legacy/ecore/src/lib/ecore_con/ecore_con_ssl.c
+++ b/legacy/ecore/src/lib/ecore_con/ecore_con_ssl.c
@@ -654,7 +654,7 @@ ecore_con_ssl_server_verify_name_get(Ecore_Con_Server *svr)
654 * If there is an error loading the certificate, an error will automatically be logged. 654 * If there is an error loading the certificate, an error will automatically be logged.
655 * @param svr The server object 655 * @param svr The server object
656 * @param cert The path to the certificate. 656 * @param cert The path to the certificate.
657 * @return EINA_FALSE if the file cannot be loaded, otherwise EINA_TRUE. 657 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
658 */ 658 */
659 659
660EAPI Eina_Bool 660EAPI Eina_Bool
@@ -686,7 +686,7 @@ ecore_con_ssl_server_cert_add(Ecore_Con_Server *svr,
686 * If there is an error loading the CAs, an error will automatically be logged. 686 * If there is an error loading the CAs, an error will automatically be logged.
687 * @param svr The server object 687 * @param svr The server object
688 * @param ca_file The path to the CA file. 688 * @param ca_file The path to the CA file.
689 * @return EINA_FALSE if the file cannot be loaded, otherwise EINA_TRUE. 689 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
690 * @note since 1.2, this function can load directores 690 * @note since 1.2, this function can load directores
691 */ 691 */
692 692
@@ -719,8 +719,7 @@ ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr,
719 * If there is an error loading the key, an error will automatically be logged. 719 * If there is an error loading the key, an error will automatically be logged.
720 * @param svr The server object 720 * @param svr The server object
721 * @param key_file The path to the key file. 721 * @param key_file The path to the key file.
722 * @return EINA_FALSE if the file cannot be loaded, 722 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
723 * otherwise EINA_TRUE.
724 */ 723 */
725 724
726EAPI Eina_Bool 725EAPI Eina_Bool
@@ -752,8 +751,7 @@ ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr,
752 * If there is an error loading the CRL, an error will automatically be logged. 751 * If there is an error loading the CRL, an error will automatically be logged.
753 * @param svr The server object 752 * @param svr The server object
754 * @param crl_file The path to the CRL file. 753 * @param crl_file The path to the CRL file.
755 * @return EINA_FALSE if the file cannot be loaded, 754 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
756 * otherwise EINA_TRUE.
757 */ 755 */
758 756
759EAPI Eina_Bool 757EAPI Eina_Bool
@@ -785,7 +783,7 @@ ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr,
785 * The connection should be treated as disconnected until the next event. 783 * The connection should be treated as disconnected until the next event.
786 * @param svr The server object 784 * @param svr The server object
787 * @param ssl_type The SSL connection type (ONLY). 785 * @param ssl_type The SSL connection type (ONLY).
788 * @return EINA_FALSE if the connection cannot be upgraded, otherwise EINA_TRUE. 786 * @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE.
789 * @note This function is NEVER to be used on a server object created with ecore_con_server_add 787 * @note This function is NEVER to be used on a server object created with ecore_con_server_add
790 * @warning Setting a wrong value for @p compl_type WILL mess up your program. 788 * @warning Setting a wrong value for @p compl_type WILL mess up your program.
791 * @since 1.1 789 * @since 1.1
@@ -824,7 +822,7 @@ ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore_Con_Type ssl_type)
824 * The connection should be treated as disconnected until the next event. 822 * The connection should be treated as disconnected until the next event.
825 * @param cl The client object 823 * @param cl The client object
826 * @param ssl_type The SSL connection type (ONLY). 824 * @param ssl_type The SSL connection type (ONLY).
827 * @return EINA_FALSE if the connection cannot be upgraded, otherwise EINA_TRUE. 825 * @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE.
828 * @warning Setting a wrong value for @p compl_type WILL mess up your program. 826 * @warning Setting a wrong value for @p compl_type WILL mess up your program.
829 * @since 1.1 827 * @since 1.1
830 */ 828 */
diff --git a/legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h b/legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h
index c12b1dc2bb..1b28be3908 100644
--- a/legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h
+++ b/legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h
@@ -222,7 +222,7 @@ EAPI void ecore_evas_engines_free(Eina_List *engines);
222 * @brief Creates a new Ecore_Evas based on engine name and common parameters. 222 * @brief Creates a new Ecore_Evas based on engine name and common parameters.
223 * 223 *
224 * @param engine_name engine name as returned by 224 * @param engine_name engine name as returned by
225 * ecore_evas_engines_get() or NULL to use environment variable 225 * ecore_evas_engines_get() or @c NULL to use environment variable
226 * ECORE_EVAS_ENGINE, that can be undefined and in this case 226 * ECORE_EVAS_ENGINE, that can be undefined and in this case
227 * this call will try to find the first working engine. 227 * this call will try to find the first working engine.
228 * @param x horizontal position of window (not supported in all engines) 228 * @param x horizontal position of window (not supported in all engines)
@@ -230,19 +230,20 @@ EAPI void ecore_evas_engines_free(Eina_List *engines);
230 * @param w width of window 230 * @param w width of window
231 * @param h height of window 231 * @param h height of window
232 * @param extra_options string with extra parameter, dependent on engines 232 * @param extra_options string with extra parameter, dependent on engines
233 * or NULL. String is usually in the form: 'key1=value1;key2=value2'. 233 * or @ NULL. String is usually in the form: 'key1=value1;key2=value2'.
234 * Pay attention that when getting that from shell commands, most 234 * Pay attention that when getting that from shell commands, most
235 * consider ';' as the command terminator, so you need to escape 235 * consider ';' as the command terminator, so you need to escape
236 * it or use quotes. 236 * it or use quotes.
237 * 237 *
238 * @return Ecore_Evas instance or NULL if creation failed. 238 * @return Ecore_Evas instance or @c NULL if creation failed.
239 */ 239 */
240EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options); 240EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options);
241/** 241/**
242 * @brief Set whether an Ecore_Evas has an alpha channel or not. 242 * @brief Set whether an Ecore_Evas has an alpha channel or not.
243 * 243 *
244 * @param ee The Ecore_Evas to shape 244 * @param ee The Ecore_Evas to shape
245 * @param alpha EINA_TRUE to enable the alpha channel, EINA_FALSE to disable it 245 * @param alpha @c EINA_TRUE to enable the alpha channel, @c EINA_FALSE to
246 * disable it
246 * 247 *
247 * This function allows you to make an Ecore_Evas translucent using an 248 * This function allows you to make an Ecore_Evas translucent using an
248 * alpha channel. See ecore_evas_shaped_set() for details. The difference 249 * alpha channel. See ecore_evas_shaped_set() for details. The difference
@@ -257,10 +258,11 @@ EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha);
257/** 258/**
258 * @brief Query whether an Ecore_Evas has an alpha channel. 259 * @brief Query whether an Ecore_Evas has an alpha channel.
259 * @param ee The Ecore_Evas to query. 260 * @param ee The Ecore_Evas to query.
260 * @return EINA_TRUE if ee has an alpha channel, EINA_FALSE if it does not. 261 * @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does
262 * not.
261 * 263 *
262 * This function returns EINA_TRUE if @p ee has an alpha channel, and EINA_FALSE 264 * This function returns @c EINA_TRUE if @p ee has an alpha channel, and
263 * if it does not. 265 * @c EINA_FALSE if it does not.
264 * 266 *
265 * @see ecore_evas_alpha_set() 267 * @see ecore_evas_alpha_set()
266 */ 268 */
@@ -269,8 +271,8 @@ EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee);
269 * @brief Set whether an Ecore_Evas has an transparent window or not. 271 * @brief Set whether an Ecore_Evas has an transparent window or not.
270 * 272 *
271 * @param ee The Ecore_Evas to shape 273 * @param ee The Ecore_Evas to shape
272 * @param transparent EINA_TRUE to enable the transparent window, EINA_FALSE to 274 * @param transparent @c EINA_TRUE to enable the transparent window,
273 * disable it 275 * @c EINA_FALSE to disable it
274 * 276 *
275 * This function sets some translucency options, for more complete support see 277 * This function sets some translucency options, for more complete support see
276 * ecore_evas_alpha_set(). 278 * ecore_evas_alpha_set().
@@ -284,7 +286,7 @@ EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparen
284 * @brief Query whether an Ecore_Evas is transparent. 286 * @brief Query whether an Ecore_Evas is transparent.
285 * 287 *
286 * @param ee The Ecore_Evas to query. 288 * @param ee The Ecore_Evas to query.
287 * @return EINA_TRUE if ee is transparent, EINA_FALSE if it isn't. 289 * @return @c EINA_TRUE if ee is transparent, @c EINA_FALSE if it isn't.
288 * 290 *
289 * @see ecore_evas_transparent_set() 291 * @see ecore_evas_transparent_set()
290 */ 292 */
@@ -300,7 +302,7 @@ EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee);
300 * 302 *
301 * This function takes four pointers to (already allocated) ints, and places 303 * This function takes four pointers to (already allocated) ints, and places
302 * the geometry of @p ee in them. If any of the parameters is not desired you 304 * the geometry of @p ee in them. If any of the parameters is not desired you
303 * may pass NULL on them. 305 * may pass @c NULL on them.
304 * 306 *
305 * @code 307 * @code
306 * int x, y, w, h; 308 * int x, y, w, h;
@@ -323,11 +325,12 @@ EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, i
323 * @param h A pointer to an int to place the h size in 325 * @param h A pointer to an int to place the h size in
324 * 326 *
325 * This function takes four pointers to (already allocated) ints, and places 327 * This function takes four pointers to (already allocated) ints, and places
326 * the geometry which @p ee was latest recently requested . If any of the parameters is not desired you 328 * the geometry which @p ee was latest recently requested . If any of the
327 * may pass NULL on them. 329 * parameters is not desired you may pass @c NULL on them.
328 * This function can represent recently requested geometry. 330 * This function can represent recently requested geometry.
329 * ecore_evas_geometry_get function returns the value is updated after engine finished request. 331 * ecore_evas_geometry_get function returns the value is updated after engine
330 * By comparison, ecore_evas_request_geometry_get returns recently requested value. 332 * finished request. By comparison, ecore_evas_request_geometry_get returns
333 * recently requested value.
331 * 334 *
332 * @code 335 * @code
333 * int x, y, w, h; 336 * int x, y, w, h;
@@ -341,10 +344,10 @@ EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, i
341 * @brief Set the focus of an Ecore_Evas' window. 344 * @brief Set the focus of an Ecore_Evas' window.
342 * 345 *
343 * @param ee The Ecore_Evas 346 * @param ee The Ecore_Evas
344 * @param on EINA_TRUE for focus, EINA_FALSE to defocus. 347 * @param on @c EINA_TRUE for focus, @c EINA_FALSE to defocus.
345 * 348 *
346 * This function focuses @p ee if @p on is EINA_TRUE, or unfocuses @p ee if @p 349 * This function focuses @p ee if @p on is @c EINA_TRUE, or unfocuses @p ee if
347 * on is EINA_FALSE. 350 * @p on is @c EINA_FALSE.
348 * 351 *
349 * @warning Support for this depends on the underlying windowing system. 352 * @warning Support for this depends on the underlying windowing system.
350 */ 353 */
@@ -353,7 +356,7 @@ EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on);
353 * @brief Query whether an Ecore_Evas' window is focused or not. 356 * @brief Query whether an Ecore_Evas' window is focused or not.
354 * 357 *
355 * @param ee The Ecore_Evas to set 358 * @param ee The Ecore_Evas to set
356 * @return EINA_TRUE if @p ee if focused, EINA_FALSE if not. 359 * @return @c EINA_TRUE if @p ee if focused, @c EINA_FALSE if not.
357 * 360 *
358 * @see ecore_evas_focus_set() 361 * @see ecore_evas_focus_set()
359 */ 362 */
@@ -362,10 +365,10 @@ EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee);
362 * @brief Iconify or uniconify an Ecore_Evas' window. 365 * @brief Iconify or uniconify an Ecore_Evas' window.
363 * 366 *
364 * @param ee The Ecore_Evas 367 * @param ee The Ecore_Evas
365 * @param on EINA_TRUE to iconify, EINA_FALSE to uniconify. 368 * @param on @c EINA_TRUE to iconify, @c EINA_FALSE to uniconify.
366 * 369 *
367 * This function iconifies @p ee if @p on is EINA_TRUE, or uniconifies @p ee if 370 * This function iconifies @p ee if @p on is @c EINA_TRUE, or uniconifies @p ee
368 * @p on is EINA_FALSE. 371 * if @p on is @c EINA_FALSE.
369 * 372 *
370 * @note Iconify and minimize are synonyms. 373 * @note Iconify and minimize are synonyms.
371 * 374 *
@@ -376,7 +379,7 @@ EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on);
376 * @brief Query whether an Ecore_Evas' window is iconified or not. 379 * @brief Query whether an Ecore_Evas' window is iconified or not.
377 * 380 *
378 * @param ee The Ecore_Evas to set 381 * @param ee The Ecore_Evas to set
379 * @return EINA_TRUE if @p ee is iconified, EINA_FALSE if not. 382 * @return @c EINA_TRUE if @p ee is iconified, @c EINA_FALSE if not.
380 * 383 *
381 * @note Iconify and minimize are synonyms. 384 * @note Iconify and minimize are synonyms.
382 * 385 *
@@ -387,10 +390,10 @@ EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee);
387 * @brief Set whether an Ecore_Evas' window is borderless or not. 390 * @brief Set whether an Ecore_Evas' window is borderless or not.
388 * 391 *
389 * @param ee The Ecore_Evas 392 * @param ee The Ecore_Evas
390 * @param on EINA_TRUE for borderless, EINA_FALSE for bordered. 393 * @param on @c EINA_TRUE for borderless, @c EINA_FALSE for bordered.
391 * 394 *
392 * This function makes @p ee borderless if @p on is EINA_TRUE, or bordered if @p 395 * This function makes @p ee borderless if @p on is @c EINA_TRUE, or bordered
393 * on is EINA_FALSE. 396 * if @p on is @c EINA_FALSE.
394 * 397 *
395 * @warning Support for this depends on the underlying windowing system. 398 * @warning Support for this depends on the underlying windowing system.
396 */ 399 */
@@ -399,7 +402,7 @@ EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on);
399 * @brief Query whether an Ecore_Evas' window is borderless or not. 402 * @brief Query whether an Ecore_Evas' window is borderless or not.
400 * 403 *
401 * @param ee The Ecore_Evas to set 404 * @param ee The Ecore_Evas to set
402 * @return EINA_TRUE if @p ee is borderless, EINA_FALSE if not. 405 * @return @c EINA_TRUE if @p ee is borderless, @c EINA_FALSE if not.
403 * 406 *
404 * @see ecore_evas_borderless_set() 407 * @see ecore_evas_borderless_set()
405 */ 408 */
@@ -408,10 +411,10 @@ EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee);
408 * @brief Set whether or not an Ecore_Evas' window is fullscreen. 411 * @brief Set whether or not an Ecore_Evas' window is fullscreen.
409 * 412 *
410 * @param ee The Ecore_Evas 413 * @param ee The Ecore_Evas
411 * @param on EINA_TRUE fullscreen, EINA_FALSE not. 414 * @param on @c EINA_TRUE fullscreen, @c EINA_FALSE not.
412 * 415 *
413 * This function causes @p ee to be fullscreen if @p on is EINA_TRUE, 416 * This function causes @p ee to be fullscreen if @p on is @c EINA_TRUE, or
414 * or not if @p on is EINA_FALSE. 417 * not if @p on is @c EINA_FALSE.
415 * 418 *
416 * @warning Support for this depends on the underlying windowing system. 419 * @warning Support for this depends on the underlying windowing system.
417 */ 420 */
@@ -420,7 +423,7 @@ EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on);
420 * @brief Query whether an Ecore_Evas' window is fullscreen or not. 423 * @brief Query whether an Ecore_Evas' window is fullscreen or not.
421 * 424 *
422 * @param ee The Ecore_Evas to set 425 * @param ee The Ecore_Evas to set
423 * @return EINA_TRUE if @p ee is fullscreen, EINA_FALSE if not. 426 * @return @c EINA_TRUE if @p ee is fullscreen, @c EINA_FALSE if not.
424 * 427 *
425 * @see ecore_evas_fullscreen_set() 428 * @see ecore_evas_fullscreen_set()
426 */ 429 */
@@ -431,7 +434,7 @@ EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee);
431 * @param ee The Ecore_Evas 434 * @param ee The Ecore_Evas
432 * @param ee_group The other group member 435 * @param ee_group The other group member
433 * 436 *
434 * If @p ee_group is NULL, @p ee is removed from the group, otherwise it is 437 * If @p ee_group is @c NULL, @p ee is removed from the group, otherwise it is
435 * added. Note that if you free the @p ee_group canvas before @p ee, then 438 * added. Note that if you free the @p ee_group canvas before @p ee, then
436 * getting the group canvas with ecore_evas_window_group_get() will return 439 * getting the group canvas with ecore_evas_window_group_get() will return
437 * an invalid handle. 440 * an invalid handle.
@@ -639,10 +642,10 @@ EAPI int ecore_evas_layer_get(const Ecore_Evas *ee);
639 * @brief Maximize (or unmaximize) an Ecore_Evas' window. 642 * @brief Maximize (or unmaximize) an Ecore_Evas' window.
640 * 643 *
641 * @param ee The Ecore_Evas 644 * @param ee The Ecore_Evas
642 * @param on EINA_TRUE to maximize, EINA_FALSE to unmaximize. 645 * @param on @c EINA_TRUE to maximize, @c EINA_FALSE to unmaximize.
643 * 646 *
644 * This function maximizes @p ee if @p on is EINA_TRUE, or unmaximizes @p ee 647 * This function maximizes @p ee if @p on is @c EINA_TRUE, or unmaximizes @p ee
645 * if @p on is EINA_FALSE. 648 * if @p on is @c EINA_FALSE.
646 * 649 *
647 * @warning Support for this depends on the underlying windowing system. 650 * @warning Support for this depends on the underlying windowing system.
648 */ 651 */
@@ -651,7 +654,7 @@ EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on);
651 * @brief Query whether an Ecore_Evas' window is maximized or not. 654 * @brief Query whether an Ecore_Evas' window is maximized or not.
652 * 655 *
653 * @param ee The Ecore_Evas to set 656 * @param ee The Ecore_Evas to set
654 * @return EINA_TRUE if @p ee is maximized, EINA_FALSE if not. 657 * @return @c EINA_TRUE if @p ee is maximized, @c EINA_FALSE if not.
655 * 658 *
656 * @see ecore_evas_maximized_set() 659 * @see ecore_evas_maximized_set()
657 */ 660 */
@@ -823,6 +826,7 @@ EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n,
823 * @brief Returns a pointer to the underlying window. 826 * @brief Returns a pointer to the underlying window.
824 * 827 *
825 * @param ee The Ecore_Evas whose window is desired. 828 * @param ee The Ecore_Evas whose window is desired.
829 * @return A pointer to the underlying window.
826 * 830 *
827 * @warning Support for this depends on the underlying windowing system. 831 * @warning Support for this depends on the underlying windowing system.
828 */ 832 */
@@ -1166,7 +1170,7 @@ EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
1166 * @brief Return the Ecore_Evas for this Evas 1170 * @brief Return the Ecore_Evas for this Evas
1167 * 1171 *
1168 * @param e The Evas to get the Ecore_Evas from 1172 * @param e The Evas to get the Ecore_Evas from
1169 * @return The Ecore_Evas that holds this Evas, or NULL if not held by one. 1173 * @return The Ecore_Evas that holds this Evas, or @c NULL if not held by one.
1170 * 1174 *
1171 * @warning Only use on Evas' created with ecore evas! 1175 * @warning Only use on Evas' created with ecore evas!
1172 */ 1176 */
@@ -1188,7 +1192,7 @@ EAPI void ecore_evas_free(Ecore_Evas *ee);
1188 * This function retrieves user specific data that has been stored within an 1192 * This function retrieves user specific data that has been stored within an
1189 * Ecore_Evas structure with ecore_evas_data_set(). 1193 * Ecore_Evas structure with ecore_evas_data_set().
1190 * 1194 *
1191 * @returns NULL on error or no data found, A pointer to the user data on 1195 * @returns @c NULL on error or no data found, A pointer to the user data on
1192 * success. 1196 * success.
1193 * 1197 *
1194 * @see ecore_evas_data_set() 1198 * @see ecore_evas_data_set()
@@ -1649,10 +1653,10 @@ EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee);
1649 * @brief Get geometry of screen associated with this Ecore_Evas. 1653 * @brief Get geometry of screen associated with this Ecore_Evas.
1650 * 1654 *
1651 * @param ee The Ecore_Evas whose window's to query container screen geometry. 1655 * @param ee The Ecore_Evas whose window's to query container screen geometry.
1652 * @param x where to return the horizontal offset value. May be NULL. 1656 * @param x where to return the horizontal offset value. May be @c NULL.
1653 * @param y where to return the vertical offset value. May be NULL. 1657 * @param y where to return the vertical offset value. May be @c NULL.
1654 * @param w where to return the width value. May be NULL. 1658 * @param w where to return the width value. May be @c NULL.
1655 * @param h where to return the height value. May be NULL. 1659 * @param h where to return the height value. May be @c NULL.
1656 * 1660 *
1657 * @since 1.1 1661 * @since 1.1
1658 */ 1662 */
@@ -1667,7 +1671,7 @@ EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee);
1667 * @param ee The Ecore_Evas to associate to @a obj 1671 * @param ee The Ecore_Evas to associate to @a obj
1668 * @param obj The object to associate to @a ee 1672 * @param obj The object to associate to @a ee
1669 * @param flags The association flags. 1673 * @param flags The association flags.
1670 * @return EINA_TRUE on success, EINA_FALSE otherwise. 1674 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1671 * 1675 *
1672 * Association means that operations on one will affect the other, for 1676 * Association means that operations on one will affect the other, for
1673 * example moving the object will move the window, resize the object will 1677 * example moving the object will move the window, resize the object will
@@ -1708,14 +1712,14 @@ EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj,
1708 * 1712 *
1709 * @param ee The Ecore_Evas to dissociate from @a obj 1713 * @param ee The Ecore_Evas to dissociate from @a obj
1710 * @param obj The object to dissociate from @a ee 1714 * @param obj The object to dissociate from @a ee
1711 * @return EINA_TRUE on success, EINA_FALSE otherwise. 1715 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1712 */ 1716 */
1713EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj); 1717EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj);
1714/** 1718/**
1715 * @brief Get the object associated with @p ee 1719 * @brief Get the object associated with @p ee
1716 * 1720 *
1717 * @param ee The Ecore_Evas to get the object from. 1721 * @param ee The Ecore_Evas to get the object from.
1718 * @return The associated object, or NULL if there is no associated object. 1722 * @return The associated object, or @c NULL if there is no associated object.
1719 */ 1723 */
1720EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee); 1724EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee);
1721 1725
@@ -1757,13 +1761,15 @@ EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee);
1757/** 1761/**
1758 * Sets the engine to be used by the backing store engine. 1762 * Sets the engine to be used by the backing store engine.
1759 * 1763 *
1760 * @return EINA_TRUE on success, EINA_FALSE if ews is already in use. 1764 * @return @c EINA_TRUE on success, @c EINA_FALSE if ews is already in use.
1761 * @since 1.1 1765 * @since 1.1
1762 */ 1766 */
1763EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options); 1767EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options);
1764 1768
1765/** 1769/**
1766 * Reconfigure the backing store used. 1770 * Reconfigure the backing store used.
1771 *
1772 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1767 * @since 1.1 1773 * @since 1.1
1768 */ 1774 */
1769EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h); 1775EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h);
@@ -1771,6 +1777,7 @@ EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h);
1771/** 1777/**
1772 * Return the internal backing store in use. 1778 * Return the internal backing store in use.
1773 * 1779 *
1780 * @return The internal backing store in use.
1774 * @note this will forced it to be created, making future calls to 1781 * @note this will forced it to be created, making future calls to
1775 * ecore_evas_ews_engine_set() void. 1782 * ecore_evas_ews_engine_set() void.
1776 * 1783 *
@@ -1782,6 +1789,7 @@ EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void);
1782/** 1789/**
1783 * Return the internal backing store in use. 1790 * Return the internal backing store in use.
1784 * 1791 *
1792 * @return The internal backing store in use.
1785 * @note this will forced it to be created, making future calls to 1793 * @note this will forced it to be created, making future calls to
1786 * ecore_evas_ews_engine_set() void. 1794 * ecore_evas_ews_engine_set() void.
1787 * 1795 *
@@ -1809,7 +1817,8 @@ EAPI void ecore_evas_ews_background_set(Evas_Object *o);
1809/** 1817/**
1810 * Return all Ecore_Evas* created by EWS. 1818 * Return all Ecore_Evas* created by EWS.
1811 * 1819 *
1812 * @note do not change the returned list or its contents. 1820 * @return An eina list of Ecore_evases.
1821 e @note Do not change the returned list or its contents.
1813 * @since 1.1 1822 * @since 1.1
1814 */ 1823 */
1815EAPI const Eina_List *ecore_evas_ews_children_get(void); 1824EAPI const Eina_List *ecore_evas_ews_children_get(void);
@@ -1886,10 +1895,10 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a p
1886 * This creates a new extn_socket canvas wrapper, with image data array 1895 * This creates a new extn_socket canvas wrapper, with image data array
1887 * @b bound to the ARGB format, 8 bits per pixel. 1896 * @b bound to the ARGB format, 8 bits per pixel.
1888 * 1897 *
1889 * If creation is successful, an Ecore_Evas handle is returned or NULL if creation 1898 * If creation is successful, an Ecore_Evas handle is returned or @c NULL if
1890 * fails. Also focus, show, hide etc. callbacks 1899 * creation fails. Also focus, show, hide etc. callbacks will also be called
1891 * will also be called if the plug object is shown, or already visible on 1900 * if the plug object is shown, or already visible on connect, or if it is
1892 * connect, or if it is hidden later, focused or unfocused. 1901 * hidden later, focused or unfocused.
1893 * 1902 *
1894 * This function has to be flowed by ecore_evas_extn_socket_listen(), 1903 * This function has to be flowed by ecore_evas_extn_socket_listen(),
1895 * for starting ecore ipc service. 1904 * for starting ecore ipc service.
@@ -1959,17 +1968,23 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a p
1959EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h); 1968EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h);
1960 1969
1961/** 1970/**
1962 * @brief Create a socket to provide the service for external ecore evas socket. 1971 * @brief Create a socket to provide the service for external ecore evas
1972 * socket.
1963 * 1973 *
1964 * @param ee The Ecore_Evas 1974 * @param ee The Ecore_Evas.
1965 * @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail. 1975 * @param svcname The name of the service to be advertised. ensure that it is
1966 * @param svcnum A number (any value, 0 beig the common default) to differentiate multiple instances of services with the same name. 1976 * unique (when combined with @p svcnum) otherwise creation may fail.
1967 * @param svcsys A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user ide that created the service. 1977 * @param svcnum A number (any value, @c 0 being the common default) to
1968 * @return EINA_TRUE if creation is successful, EINA_FALSE if it does not. 1978 * differentiate multiple instances of services with the same name.
1979 * @param svcsys A boolean that if true, specifies to create a system-wide
1980 * service all users can connect to, otherwise the service is private to the
1981 * user ide that created the service.
1982 * @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
1983 * not.
1969 * 1984 *
1970 * This creates socket specified by @p svcname, @p svcnum and @p svcsys. If creation 1985 * This creates socket specified by @p svcname, @p svcnum and @p svcsys. If
1971 * is successful, EINA_TRUE is returned or EINA_FALSE if creation 1986 * creation is successful, @c EINA_TRUE is returned or @c EINA_FALSE if
1972 * fails. 1987 * creation fails.
1973 * 1988 *
1974 * @see ecore_evas_extn_socket_new() 1989 * @see ecore_evas_extn_socket_new()
1975 * @see ecore_evas_extn_plug_new() 1990 * @see ecore_evas_extn_plug_new()
@@ -2051,14 +2066,17 @@ EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj);
2051EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target); 2066EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target);
2052 2067
2053/** 2068/**
2054 * @brief Connect a external ecore evas plug to service provided by external ecore evas socket 2069 * @brief Connect an external ecore evas plug to service provided by external
2070 * ecore evas socket.
2055 * 2071 *
2056 * @param obj The Ecore_Evas containing the canvas in which the new image object will live. 2072 * @param obj The Ecore_Evas containing the canvas in which the new image
2073 * object will live.
2057 * @param svcname The service name to connect to set up by the socket. 2074 * @param svcname The service name to connect to set up by the socket.
2058 * @param svcnum The service number to connect to (set up by socket). 2075 * @param svcnum The service number to connect to (set up by socket).
2059 * @param svcsys Booleain to set if the service is a system one or not (set up by socket). 2076 * @param svcsys Boolean to set if the service is a system one or not (set up
2060 * @return EINA_TRUE if creation is successful, EINA_FALSE if it does not. 2077 * by socket).
2061 * 2078 * @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
2079 * not.
2062 * 2080 *
2063 * @see ecore_evas_extn_plug_new() 2081 * @see ecore_evas_extn_plug_new()
2064 * 2082 *
diff --git a/legacy/ecore/src/lib/ecore_evas/ecore_evas.c b/legacy/ecore/src/lib/ecore_evas/ecore_evas.c
index aac1659398..e163f8c7e7 100644
--- a/legacy/ecore/src/lib/ecore_evas/ecore_evas.c
+++ b/legacy/ecore/src/lib/ecore_evas/ecore_evas.c
@@ -1350,15 +1350,16 @@ ecore_evas_rotation_get(const Ecore_Evas *ee)
1350 1350
1351/** 1351/**
1352 * Set whether an Ecore_Evas is shaped or not. 1352 * Set whether an Ecore_Evas is shaped or not.
1353 * @param ee The Ecore_Evas to shape 1353 *
1354 * @param shaped EINA_TRUE to shape, EINA_FALSE to not 1354 * @param ee The Ecore_Evas to shape.
1355 * @param shaped @c EINA_TRUE to shape, @c EINA_FALSE to not.
1355 * 1356 *
1356 * This function allows one to make an Ecore_Evas shaped to the contents of the 1357 * This function allows one to make an Ecore_Evas shaped to the contents of the
1357 * evas. If @p shaped is EINA_TRUE, @p ee will be transparent in parts of the evas that 1358 * evas. If @p shaped is @c EINA_TRUE, @p ee will be transparent in parts of
1358 * contain no objects. If @p shaped is EINA_FALSE, then @p ee will be rectangular, and 1359 * the evas that contain no objects. If @p shaped is @c EINA_FALSE, then @p ee
1359 * and parts with no data will show random framebuffer artifacting. For 1360 * will be rectangular, and parts with no data will show random framebuffer
1360 * non-shaped Ecore_Evases, it is recommend to cover the entire evas with a 1361 * artifacting. For non-shaped Ecore_Evases, it is recommended to cover the
1361 * background object. 1362 * entire evas with a background object.
1362 */ 1363 */
1363EAPI void 1364EAPI void
1364ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped) 1365ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped)
@@ -1375,10 +1376,11 @@ ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped)
1375 1376
1376/** 1377/**
1377 * Query whether an Ecore_Evas is shaped or not. 1378 * Query whether an Ecore_Evas is shaped or not.
1379 *
1378 * @param ee The Ecore_Evas to query. 1380 * @param ee The Ecore_Evas to query.
1379 * @return EINA_TRUE if shaped, EINA_FALSE if not. 1381 * @return @c EINA_TRUE if shaped, @c EINA_FALSE if not.
1380 * 1382 *
1381 * This function returns EINA_TRUE if @p ee is shaped, and EINA_FALSE if not. 1383 * This function returns @c EINA_TRUE if @p ee is shaped, and @c EINA_FALSE if not.
1382 */ 1384 */
1383EAPI Eina_Bool 1385EAPI Eina_Bool
1384ecore_evas_shaped_get(const Ecore_Evas *ee) 1386ecore_evas_shaped_get(const Ecore_Evas *ee)
@@ -1909,11 +1911,12 @@ ecore_evas_borderless_get(const Ecore_Evas *ee)
1909 1911
1910/** 1912/**
1911 * Tell the WM whether or not to ignore an Ecore_Evas' window 1913 * Tell the WM whether or not to ignore an Ecore_Evas' window
1912 * @param ee The Ecore_Evas
1913 * @param on EINA_TRUE to ignore, EINA_FALSE to not.
1914 * 1914 *
1915 * This function causes the window manager to ignore @p ee if @p on is EINA_TRUE, 1915 * @param ee The Ecore_Evas.
1916 * or not ignore @p ee if @p on is EINA_FALSE. 1916 * @param on @c EINA_TRUE to ignore, @c EINA_FALSE to not.
1917 *
1918 * This function causes the window manager to ignore @p ee if @p on is
1919 * @c EINA_TRUE, or not ignore @p ee if @p on is @c EINA_FALSE.
1917 */ 1920 */
1918EAPI void 1921EAPI void
1919ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on) 1922ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on)
@@ -1930,9 +1933,9 @@ ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on)
1930 1933
1931/** 1934/**
1932 * Query whether an Ecore_Evas' window is overridden or not 1935 * Query whether an Ecore_Evas' window is overridden or not
1933 * @param ee The Ecore_Evas to set
1934 * @return EINA_TRUE if @p ee is overridden, EINA_FALSE if not.
1935 * 1936 *
1937 * @param ee The Ecore_Evas to set.
1938 * @return @c EINA_TRUE if @p ee is overridden, @c EINA_FALSE if not.
1936 */ 1939 */
1937EAPI Eina_Bool 1940EAPI Eina_Bool
1938ecore_evas_override_get(const Ecore_Evas *ee) 1941ecore_evas_override_get(const Ecore_Evas *ee)
diff --git a/legacy/ecore/src/lib/ecore_fb/ecore_fb_li.c b/legacy/ecore/src/lib/ecore_fb/ecore_fb_li.c
index 6a29d6357c..5b22c90104 100644
--- a/legacy/ecore/src/lib/ecore_fb/ecore_fb_li.c
+++ b/legacy/ecore/src/lib/ecore_fb/ecore_fb_li.c
@@ -428,11 +428,12 @@ _ecore_fb_li_device_fd_callback(void *data, Ecore_Fd_Handler *fdh __UNUSED__)
428 * @brief Set the listen mode for an input device . 428 * @brief Set the listen mode for an input device .
429 * 429 *
430 * @param dev The device to set the mode of. 430 * @param dev The device to set the mode of.
431 * @param listen EINA_FALSE to disable listening mode, EINA_TRUE to enable it. 431 * @param listen @c EINA_FALSE to disable listening mode, @c EINA_TRUE to
432 * enable it.
432 * 433 *
433 * This function enables or disables listening on the input device @p 434 * This function enables or disables listening on the input device @p dev.
434 * dev. If @p listen is #EINA_FALSE, listening mode is disabled, if it 435 * If @p listen is @c EINA_FALSE, listening mode is disabled, if it is
435 * is #EINA_TRUE, it is enabled. 436 * @c EINA_TRUE, it is enabled.
436 */ 437 */
437EAPI void 438EAPI void
438ecore_fb_input_device_listen(Ecore_Fb_Input_Device *dev, Eina_Bool listen) 439ecore_fb_input_device_listen(Ecore_Fb_Input_Device *dev, Eina_Bool listen)
diff --git a/legacy/ecore/src/lib/ecore_file/ecore_file.c b/legacy/ecore/src/lib/ecore_file/ecore_file.c
index 5ec2e996a5..fd06f7dc52 100644
--- a/legacy/ecore/src/lib/ecore_file/ecore_file.c
+++ b/legacy/ecore/src/lib/ecore_file/ecore_file.c
@@ -162,10 +162,10 @@ ecore_file_size(const char *file)
162 * @brief Check if the given file exists. 162 * @brief Check if the given file exists.
163 * 163 *
164 * @param file The name of the file. 164 * @param file The name of the file.
165 * @return Return EINA_TRUE if the file exists, EINA_FALSE otherwise. 165 * @return @c EINA_TRUE if the @p file exists, @c EINA_FALSE otherwise.
166 * 166 *
167 * This function returns EINA_TRUE if @p file exists on local filesystem, 167 * This function returns @c EINA_TRUE if @p file exists on local filesystem,
168 * EINA_FALSE otherwise. 168 * @c EINA_FALSE otherwise.
169 */ 169 */
170EAPI Eina_Bool 170EAPI Eina_Bool
171ecore_file_exists(const char *file) 171ecore_file_exists(const char *file)
@@ -182,11 +182,11 @@ ecore_file_exists(const char *file)
182 * @brief Check if the given file is a directory. 182 * @brief Check if the given file is a directory.
183 * 183 *
184 * @param file The name of the file. 184 * @param file The name of the file.
185 * @return Return EINA_TRUE if the file exists and is a directory, 185 * @return @c EINA_TRUE if the file exists and is a directory, @c EINA_FALSE
186 * EINA_FALSE otherwise. 186 * otherwise.
187 * 187 *
188 * This function returns EINA_TRUE if @p file exists exists and is a 188 * This function returns @c EINA_TRUE if @p file exists exists and is a
189 * directory on local filesystem, EINA_FALSE otherwise. 189 * directory on local filesystem, @c EINA_FALSE otherwise.
190 */ 190 */
191EAPI Eina_Bool 191EAPI Eina_Bool
192ecore_file_is_dir(const char *file) 192ecore_file_is_dir(const char *file)
@@ -204,11 +204,11 @@ static mode_t default_mode = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S
204 * @brief Create a new directory. 204 * @brief Create a new directory.
205 * 205 *
206 * @param dir The name of the directory to create 206 * @param dir The name of the directory to create
207 * @return EINA_TRUE on successful creation, EINA_FALSE otherwise. 207 * @return @c EINA_TRUE on successful creation, @c EINA_FALSE otherwise.
208 * 208 *
209 * This function creates the directory @p dir with the mode S_IRUSR | 209 * This function creates the directory @p dir with the mode S_IRUSR |
210 * S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH. On 210 * S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH. On
211 * success, it returns EINA_TRUE, EINA_FALSE otherwise. 211 * success, it returns @c EINA_TRUE, @c EINA_FALSE otherwise.
212 */ 212 */
213EAPI Eina_Bool 213EAPI Eina_Bool
214ecore_file_mkdir(const char *dir) 214ecore_file_mkdir(const char *dir)
@@ -342,10 +342,10 @@ ecore_file_mksubdirs(const char *base, const char **subdirs)
342 * @brief Delete the given directory. 342 * @brief Delete the given directory.
343 * 343 *
344 * @param dir The name of the directory to delete. 344 * @param dir The name of the directory to delete.
345 * @return EINA_TRUE on success, EINA_FALSE otherwise. 345 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
346 * 346 *
347 * This function deletes @p dir. It returns EINA_TRUE on success, 347 * This function deletes @p dir. It returns @c EINA_TRUE on success,
348 * EINA_FALSE otherwise. 348 * @c EINA_FALSE otherwise.
349 */ 349 */
350EAPI Eina_Bool 350EAPI Eina_Bool
351ecore_file_rmdir(const char *dir) 351ecore_file_rmdir(const char *dir)
@@ -358,10 +358,10 @@ ecore_file_rmdir(const char *dir)
358 * @brief Delete the given file. 358 * @brief Delete the given file.
359 * 359 *
360 * @param file The name of the file to delete. 360 * @param file The name of the file to delete.
361 * @return EINA_TRUE on success, EINA_FALSE otherwise. 361 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
362 * 362 *
363 * This function deletes @p file. It returns EINA_TRUE on success, 363 * This function deletes @p file. It returns @c EINA_TRUE on success,
364 * EINA_FALSE otherwise. 364 * @c EINA_FALSE otherwise.
365 */ 365 */
366EAPI Eina_Bool 366EAPI Eina_Bool
367ecore_file_unlink(const char *file) 367ecore_file_unlink(const char *file)
@@ -374,10 +374,10 @@ ecore_file_unlink(const char *file)
374 * @brief Remove the given file or directory. 374 * @brief Remove the given file or directory.
375 * 375 *
376 * @param file The name of the file or directory to delete. 376 * @param file The name of the file or directory to delete.
377 * @return EINA_TRUE on success, EINA_FALSE otherwise. 377 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
378 * 378 *
379 * This function removes @p file. It returns EINA_TRUE on success, 379 * This function removes @p file. It returns @c EINA_TRUE on success,
380 * EINA_FALSE otherwise. 380 * @c EINA_FALSE otherwise.
381 */ 381 */
382EAPI Eina_Bool 382EAPI Eina_Bool
383ecore_file_remove(const char *file) 383ecore_file_remove(const char *file)
@@ -390,11 +390,11 @@ ecore_file_remove(const char *file)
390 * @brief Delete the given directory and all its contents. 390 * @brief Delete the given directory and all its contents.
391 * 391 *
392 * @param dir The name of the directory to delete. 392 * @param dir The name of the directory to delete.
393 * @return EINA_TRUE on success, EINA_FALSE otherwise. 393 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
394 * 394 *
395 * This function delete @p dir and all its contents. If @p dir is a 395 * This function delete @p dir and all its contents. If @p dir is a
396 * link only the link is removed. It returns EINA_TRUE on success, 396 * link only the link is removed. It returns @c EINA_TRUE on success,
397 * EINA_FALSE otherwise. 397 * @c EINA_FALSE otherwise.
398 */ 398 */
399EAPI Eina_Bool 399EAPI Eina_Bool
400ecore_file_recursive_rm(const char *dir) 400ecore_file_recursive_rm(const char *dir)
@@ -462,12 +462,12 @@ _ecore_file_mkpath_if_not_exists(const char *path)
462 * @brief Create a complete path. 462 * @brief Create a complete path.
463 * 463 *
464 * @param path The path to create 464 * @param path The path to create
465 * @return EINA_TRUE on success, EINA_FALSE otherwise. 465 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
466 * 466 *
467 * This function creates @p path and all the subdirectories it 467 * This function creates @p path and all the subdirectories it
468 * contains. The separator is '/' or '\'. If @p path exists, this 468 * contains. The separator is '/' or '\'. If @p path exists, this
469 * function returns EINA_TRUE immediately. It returns EINA_TRUE on 469 * function returns @c EINA_TRUE immediately. It returns @c EINA_TRUE on
470 * success, EINA_FALSE otherwise. 470 * success, @c EINA_FALSE otherwise.
471 */ 471 */
472EAPI Eina_Bool 472EAPI Eina_Bool
473ecore_file_mkpath(const char *path) 473ecore_file_mkpath(const char *path)
@@ -523,12 +523,12 @@ ecore_file_mkpaths(const char **paths)
523 * 523 *
524 * @param src The name of the source file. 524 * @param src The name of the source file.
525 * @param dst The name of the destination file. 525 * @param dst The name of the destination file.
526 * @return EINA_TRUE on success, EINA_FALSE otherwise. 526 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
527 * 527 *
528 * This function copies @p src to @p dst. If the absolute path name of 528 * This function copies @p src to @p dst. If the absolute path name of
529 * @p src and @p dst can not be computed, or if they are equal, or if 529 * @p src and @p dst can not be computed, or if they are equal, or if
530 * the copy fails, the function returns EINA_FALSE, otherwise it 530 * the copy fails, the function returns @c EINA_FALSE, otherwise it
531 * returns EINA_TRUE. 531 * returns @c EINA_TRUE.
532 */ 532 */
533EAPI Eina_Bool 533EAPI Eina_Bool
534ecore_file_cp(const char *src, const char *dst) 534ecore_file_cp(const char *src, const char *dst)
@@ -564,10 +564,10 @@ ecore_file_cp(const char *src, const char *dst)
564 * 564 *
565 * @param src The name of the source file. 565 * @param src The name of the source file.
566 * @param dst The name of the destination file. 566 * @param dst The name of the destination file.
567 * @return EINA_TRUE on success, EINA_FALSE otherwise. 567 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
568 * 568 *
569 * This function moves @p src to @p dst. It returns EINA_TRUE on 569 * This function moves @p src to @p dst. It returns @c EINA_TRUE on
570 * success, EINA_FALSE otherwise. 570 * success, @c EINA_FALSE otherwise.
571 */ 571 */
572EAPI Eina_Bool 572EAPI Eina_Bool
573ecore_file_mv(const char *src, const char *dst) 573ecore_file_mv(const char *src, const char *dst)
@@ -638,11 +638,11 @@ FAIL:
638 * 638 *
639 * @param src The name of the file to link. 639 * @param src The name of the file to link.
640 * @param dest The name of link. 640 * @param dest The name of link.
641 * @return EINA_TRUE on success, EINA_FALSE otherwise. 641 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
642 * 642 *
643 * This function create the symbolic link @p dest of @p src. This 643 * This function create the symbolic link @p dest of @p src. This
644 * function does not work on Windows. It returns EINA_TRUE on success, 644 * function does not work on Windows. It returns @c EINA_TRUE on success,
645 * EINA_FALSE otherwise. 645 * @c EINA_FALSE otherwise.
646 */ 646 */
647EAPI Eina_Bool 647EAPI Eina_Bool
648ecore_file_symlink(const char *src, const char *dest) 648ecore_file_symlink(const char *src, const char *dest)
@@ -727,9 +727,9 @@ ecore_file_dir_get(const char *file)
727 * @brief Check if the given file can be read. 727 * @brief Check if the given file can be read.
728 * 728 *
729 * @param file The name of the file. 729 * @param file The name of the file.
730 * @return EINA_TRUE if the file is readable, EINA_FALSE otherwise. 730 * @return @c EINA_TRUE if the @p file is readable, @c EINA_FALSE otherwise.
731 * 731 *
732 * This function returns EINA_TRUE if @p file can be read, EINA_FALSE 732 * This function returns @c EINA_TRUE if @p file can be read, @c EINA_FALSE
733 * otherwise. 733 * otherwise.
734 */ 734 */
735EAPI Eina_Bool 735EAPI Eina_Bool
@@ -744,9 +744,9 @@ ecore_file_can_read(const char *file)
744 * @brief Check if the given file can be written. 744 * @brief Check if the given file can be written.
745 * 745 *
746 * @param file The name of the file. 746 * @param file The name of the file.
747 * @return EINA_TRUE if the file is writable, EINA_FALSE otherwise. 747 * @return @c EINA_TRUE if the @p file is writable, @c EINA_FALSE otherwise.
748 * 748 *
749 * This function returns EINA_TRUE if @p file can be written, EINA_FALSE 749 * This function returns @c EINA_TRUE if @p file can be written, @c EINA_FALSE
750 * otherwise. 750 * otherwise.
751 */ 751 */
752EAPI Eina_Bool 752EAPI Eina_Bool
@@ -761,9 +761,10 @@ ecore_file_can_write(const char *file)
761 * @brief Check if the given file can be executed. 761 * @brief Check if the given file can be executed.
762 * 762 *
763 * @param file The name of the file. 763 * @param file The name of the file.
764 * @return EINA_TRUE if the file can be executed, EINA_FALSE otherwise. 764 * @return @c EINA_TRUE if the @p file can be executed, @c EINA_FALSE
765 * otherwise.
765 * 766 *
766 * This function returns EINA_TRUE if @p file can be executed, EINA_FALSE 767 * This function returns @c EINA_TRUE if @p file can be executed, @c EINA_FALSE
767 * otherwise. 768 * otherwise.
768 */ 769 */
769EAPI Eina_Bool 770EAPI Eina_Bool
@@ -1042,7 +1043,7 @@ ecore_file_escape_name(const char *filename)
1042 * 1043 *
1043 * @param path The name of the file. 1044 * @param path The name of the file.
1044 * @return A newly allocated string with the extension stripped out or 1045 * @return A newly allocated string with the extension stripped out or
1045 * NULL on errors. 1046 * @c NULL on errors.
1046 * 1047 *
1047 * This function removes the extension from @p path and returns the 1048 * This function removes the extension from @p path and returns the
1048 * result as a newly allocated string. If @p path is @c NULL, or on 1049 * result as a newly allocated string. If @p path is @c NULL, or on
@@ -1077,12 +1078,12 @@ ecore_file_strip_ext(const char *path)
1077 * @brief Check if the given directory is empty. 1078 * @brief Check if the given directory is empty.
1078 * 1079 *
1079 * @param dir The name of the directory to check. 1080 * @param dir The name of the directory to check.
1080 * @return 1 if directory is empty, 0 if it has at least one file or 1081 * @return @c 1 if directory is empty, @c 0 if it has at least one file or
1081 * -1 in case of errors. 1082 * @c -1 in case of errors.
1082 * 1083 *
1083 * This functions checks if @p dir is empty. The '.' and '..' files 1084 * This functions checks if @p dir is empty. The '.' and '..' files
1084 * will be ignored. If @p dir is empty, 1 is returned, if it contains 1085 * will be ignored. If @p dir is empty, 1 is returned, if it contains
1085 * at least 1 file, 0 is returned. On failure, -1 is returned. 1086 * at least one file, @c 0 is returned. On failure, @c -1 is returned.
1086 */ 1087 */
1087EAPI int 1088EAPI int
1088ecore_file_dir_is_empty(const char *dir) 1089ecore_file_dir_is_empty(const char *dir)
diff --git a/legacy/ecore/src/lib/ecore_file/ecore_file_download.c b/legacy/ecore/src/lib/ecore_file/ecore_file_download.c
index 971493ed87..ea8550d6a3 100644
--- a/legacy/ecore/src/lib/ecore_file/ecore_file_download.c
+++ b/legacy/ecore/src/lib/ecore_file/ecore_file_download.c
@@ -197,13 +197,13 @@ _ecore_file_download(const char *url,
197 * @param progress_cb A callback called during the download operation. 197 * @param progress_cb A callback called during the download operation.
198 * @param data User data passed to both callbacks. 198 * @param data User data passed to both callbacks.
199 * @param job_ret Job used to abort the download. 199 * @param job_ret Job used to abort the download.
200 * @return EINA_TRUE if the download start or EINA_FALSE on failure 200 * @return @c EINA_TRUE if the download start or @c EINA_FALSE on failure.
201 * 201 *
202 * This function starts the download of the URL @p url and saves it to 202 * This function starts the download of the URL @p url and saves it to
203 * @p dst. @p url must provide the protocol, including 'http://', 203 * @p dst. @p url must provide the protocol, including 'http://',
204 * 'ftp://' or 'file://'. Ecore_File must be compiled with CURL to 204 * 'ftp://' or 'file://'. Ecore_File must be compiled with CURL to
205 * download using http and ftp protocols. If @p dst is ill-formed, or 205 * download using http and ftp protocols. If @p dst is ill-formed, or
206 * if it already exists, the function returns EINA_FALSE. When the 206 * if it already exists, the function returns @c EINA_FALSE. When the
207 * download is complete, the callback @p completion_cb is called and 207 * download is complete, the callback @p completion_cb is called and
208 * @p data is passed to it. The @p status parameter of @p completion_cb 208 * @p data is passed to it. The @p status parameter of @p completion_cb
209 * will be filled with the status of the download (200, 404,...). The 209 * will be filled with the status of the download (200, 404,...). The
@@ -215,7 +215,7 @@ _ecore_file_download(const char *url,
215 * that case @p job_ret can be filled. It can be used with 215 * that case @p job_ret can be filled. It can be used with
216 * ecore_file_download_abort() or ecore_file_download_abort_all() to 216 * ecore_file_download_abort() or ecore_file_download_abort_all() to
217 * respectively abort one or all download operations. This function returns 217 * respectively abort one or all download operations. This function returns
218 * EINA_TRUE if the download starts, EINA_FALSE otherwise. 218 * @c EINA_TRUE if the download starts, @c EINA_FALSE otherwise.
219 */ 219 */
220EAPI Eina_Bool 220EAPI Eina_Bool
221ecore_file_download(const char *url, 221ecore_file_download(const char *url,
@@ -238,7 +238,7 @@ ecore_file_download(const char *url,
238 * @param data User data passed to both callbacks. 238 * @param data User data passed to both callbacks.
239 * @param job_ret Job used to abort the download. 239 * @param job_ret Job used to abort the download.
240 * @param headers pointer of header lists. 240 * @param headers pointer of header lists.
241 * @return EINA_TRUE if the download start or EINA_FALSE on failure 241 * @return @c EINA_TRUE if the download start or @c EINA_FALSE on failure.
242 */ 242 */
243EAPI Eina_Bool 243EAPI Eina_Bool
244ecore_file_download_full(const char *url, 244ecore_file_download_full(const char *url,
@@ -256,10 +256,10 @@ ecore_file_download_full(const char *url,
256 * @brief Check if the given protocol is available. 256 * @brief Check if the given protocol is available.
257 * 257 *
258 * @param protocol The protocol to check. 258 * @param protocol The protocol to check.
259 * @return EINA_TRUE if protocol is handled, EINA_FALSE otherwise. 259 * @return @c EINA_TRUE if protocol is handled, @c EINA_FALSE otherwise.
260 * 260 *
261 * This function returns EINA_TRUE if @p protocol is supported, 261 * This function returns @c EINA_TRUE if @p protocol is supported,
262 * EINA_FALSE otherwise. @p protocol can be 'http://', 'ftp://' or 262 * @c EINA_FALSE otherwise. @p protocol can be 'http://', 'ftp://' or
263 * 'file://'. Ecore_FILE must be compiled with CURL to handle http and 263 * 'file://'. Ecore_FILE must be compiled with CURL to handle http and
264 * ftp protocols. 264 * ftp protocols.
265 */ 265 */
diff --git a/legacy/ecore/src/lib/ecore_file/ecore_file_path.c b/legacy/ecore/src/lib/ecore_file/ecore_file_path.c
index f5294b7d9a..3c06e9b16c 100644
--- a/legacy/ecore/src/lib/ecore_file/ecore_file_path.c
+++ b/legacy/ecore/src/lib/ecore_file/ecore_file_path.c
@@ -87,12 +87,12 @@ _ecore_file_path_from_env(const char *env)
87 * @brief Check if the given directory is in PATH. 87 * @brief Check if the given directory is in PATH.
88 * 88 *
89 * @param in_dir The name of the directory to search in PATH. 89 * @param in_dir The name of the directory to search in PATH.
90 * @return EINA_TRUE if the directory exist in PATH, EINA_FALSE otherwise. 90 * @return @c EINA_TRUE if the directory exist in PATH, @c EINA_FALSE otherwise.
91 * 91 *
92 * This function checks if @p in_dir is in the environment variable 92 * This function checks if @p in_dir is in the environment variable
93 * PATH. If @p in_dir is @c NULL, or if PATH is empty, or @p in_dir is 93 * PATH. If @p in_dir is @c NULL, or if PATH is empty, or @p in_dir is
94 * not in PATH, the function returns EINA_FALSE, otherwise it returns 94 * not in PATH, the function returns @c EINA_FALSE, otherwise it returns
95 * EINA_TRUE. 95 * @c EINA_TRUE.
96 */ 96 */
97EAPI Eina_Bool 97EAPI Eina_Bool
98ecore_file_path_dir_exists(const char *in_dir) 98ecore_file_path_dir_exists(const char *in_dir)
@@ -117,13 +117,12 @@ ecore_file_path_dir_exists(const char *in_dir)
117 * @brief Check if the given application is installed. 117 * @brief Check if the given application is installed.
118 * 118 *
119 * @param exe The name of the application 119 * @param exe The name of the application
120 * @return EINA_TRUE if the exe is in PATH and is executable, 120 * @return @c EINA_TRUE if the @p exe is in PATH and is executable,
121 * EINA_FALSE otherwise. 121 * @c EINA_FALSE otherwise.
122 *
123 * 122 *
124 * This function checks if @p exe exists in PATH and is executable. If 123 * This function checks if @p exe exists in PATH and is executable. If
125 * @p exe is @c NULL or is not executable, the function returns 124 * @p exe is @c NULL or is not executable, the function returns
126 * EINA_FALSE, otherwise it returns EINA_TRUE. 125 * @c EINA_FALSE, otherwise it returns @c EINA_TRUE.
127 */ 126 */
128EAPI Eina_Bool 127EAPI Eina_Bool
129ecore_file_app_installed(const char *exe) 128ecore_file_app_installed(const char *exe)
diff --git a/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c b/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
index 9ce0a3c785..44c52c072f 100644
--- a/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
+++ b/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
@@ -294,7 +294,7 @@ ecore_imf_context_del(Ecore_IMF_Context *ctx)
294 * also be used for purposes internal to the Input Method Context. 294 * also be used for purposes internal to the Input Method Context.
295 * 295 *
296 * @param ctx An #Ecore_IMF_Context. 296 * @param ctx An #Ecore_IMF_Context.
297 * @param window The client window. This may be NULL to indicate 297 * @param window The client window. This may be @c NULL to indicate
298 * that the previous client window no longer exists. 298 * that the previous client window no longer exists.
299 * @ingroup Ecore_IMF_Context_Group 299 * @ingroup Ecore_IMF_Context_Group
300 */ 300 */
@@ -342,7 +342,7 @@ ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx)
342 * also be used for purposes internal to the Input Method Context. 342 * also be used for purposes internal to the Input Method Context.
343 * 343 *
344 * @param ctx An #Ecore_IMF_Context. 344 * @param ctx An #Ecore_IMF_Context.
345 * @param canvas The client canvas. This may be NULL to indicate 345 * @param canvas The client canvas. This may be @c NULL to indicate
346 * that the previous client canvas no longer exists. 346 * that the previous client canvas no longer exists.
347 * @ingroup Ecore_IMF_Context_Group 347 * @ingroup Ecore_IMF_Context_Group
348 */ 348 */
@@ -660,8 +660,8 @@ ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int
660 660
661/** 661/**
662 * Set whether the IM context should use the preedit string 662 * Set whether the IM context should use the preedit string
663 * to display feedback. If @c use_preedit is EINA_FALSE (default 663 * to display feedback. If @c use_preedit is @c EINA_FALSE (default
664 * is EINA_TRUE), then the IM context may use some other method to display 664 * is @c EINA_TRUE), then the IM context may use some other method to display
665 * feedback, such as displaying it in a child of the root window. 665 * feedback, such as displaying it in a child of the root window.
666 * 666 *
667 * @param ctx An #Ecore_IMF_Context. 667 * @param ctx An #Ecore_IMF_Context.
@@ -682,7 +682,8 @@ ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit)
682 682
683/** 683/**
684 * Set whether the IM context should allow to use the text prediction. 684 * Set whether the IM context should allow to use the text prediction.
685 * If @c prediction is EINA_FALSE (default is EINA_TRUE), then the IM context will not display the text prediction window. 685 * If @p prediction is @c EINA_FALSE (default is @c EINA_TRUE), then the IM
686 * context will not display the text prediction window.
686 * 687 *
687 * @param ctx An #Ecore_IMF_Context. 688 * @param ctx An #Ecore_IMF_Context.
688 * @param prediction Whether the IM context should allow to use the text prediction. 689 * @param prediction Whether the IM context should allow to use the text prediction.
@@ -709,7 +710,8 @@ ecore_imf_context_prediction_allow_set(Ecore_IMF_Context *ctx, Eina_Bool predict
709 * Get whether the IM context should allow to use the text prediction. 710 * Get whether the IM context should allow to use the text prediction.
710 * 711 *
711 * @param ctx An #Ecore_IMF_Context. 712 * @param ctx An #Ecore_IMF_Context.
712 * @return EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE. 713 * @return @c EINA_TRUE if it allows to use the text prediction, otherwise
714 * @c EINA_FALSE.
713 * @ingroup Ecore_IMF_Context_Group 715 * @ingroup Ecore_IMF_Context_Group
714 * @since 1.1.0 716 * @since 1.1.0
715 */ 717 */
@@ -842,17 +844,17 @@ ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx)
842 844
843/** 845/**
844 * Allow an Ecore Input Context to internally handle an event. 846 * Allow an Ecore Input Context to internally handle an event.
845 * If this function returns EINA_TRUE, then no further processing 847 * If this function returns @c EINA_TRUE, then no further processing
846 * should be done for this event. 848 * should be done for this event.
847 * 849 *
848 * Input methods must be able to accept all types of events (simply 850 * Input methods must be able to accept all types of events (simply
849 * returning EINA_FALSE if the event was not handled), but there is no 851 * returning @c EINA_FALSE if the event was not handled), but there is no
850 * obligation of any events to be submitted to this function. 852 * obligation of any events to be submitted to this function.
851 * 853 *
852 * @param ctx An #Ecore_IMF_Context. 854 * @param ctx An #Ecore_IMF_Context.
853 * @param type The type of event defined by #Ecore_IMF_Event_Type. 855 * @param type The type of event defined by #Ecore_IMF_Event_Type.
854 * @param event The event itself. 856 * @param event The event itself.
855 * @return EINA_TRUE if the event was handled; otherwise EINA_FALSE. 857 * @return @c EINA_TRUE if the event was handled; otherwise @c EINA_FALSE.
856 * @ingroup Ecore_IMF_Context_Group 858 * @ingroup Ecore_IMF_Context_Group
857 * 859 *
858 * Example 860 * Example
@@ -983,11 +985,12 @@ EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx)
983 * @param ctx An #Ecore_IMF_Context. 985 * @param ctx An #Ecore_IMF_Context.
984 * @param text Location to store a UTF-8 encoded string of text 986 * @param text Location to store a UTF-8 encoded string of text
985 * holding context around the insertion point. 987 * holding context around the insertion point.
986 * If the function returns EINA_TRUE, then you must free 988 * If the function returns @c EINA_TRUE, then you must free
987 * the result stored in this location with free(). 989 * the result stored in this location with free().
988 * @param cursor_pos Location to store the position in characters of 990 * @param cursor_pos Location to store the position in characters of
989 * the insertion cursor within @p text. 991 * the insertion cursor within @p text.
990 * @return EINA_TRUE if surrounding text was provided; otherwise EINA_FALSE. 992 * @return @c EINA_TRUE if surrounding text was provided; otherwise
993 * @c EINA_FALSE.
991 * @ingroup Ecore_IMF_Context_Module_Group 994 * @ingroup Ecore_IMF_Context_Module_Group
992 */ 995 */
993EAPI Eina_Bool 996EAPI Eina_Bool
@@ -1668,7 +1671,7 @@ ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Ei
1668 * Get whether the return key on the input panel should be disabled or not. 1671 * Get whether the return key on the input panel should be disabled or not.
1669 * 1672 *
1670 * @param ctx An #Ecore_IMF_Context. 1673 * @param ctx An #Ecore_IMF_Context.
1671 * @return EINA_TRUE if it should be disabled 1674 * @return @c EINA_TRUE if it should be disabled.
1672 * @ingroup Ecore_IMF_Context_Group 1675 * @ingroup Ecore_IMF_Context_Group
1673 * @since 1.2.0 1676 * @since 1.2.0
1674 */ 1677 */
@@ -1689,7 +1692,7 @@ ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx)
1689 * Set the caps lock mode on the input panel. 1692 * Set the caps lock mode on the input panel.
1690 * 1693 *
1691 * @param ctx An #Ecore_IMF_Context. 1694 * @param ctx An #Ecore_IMF_Context.
1692 * @param mode Turn on caps lock on the input panel if EINA_TRUE 1695 * @param mode Turn on caps lock on the input panel if @c EINA_TRUE.
1693 * @ingroup Ecore_IMF_Context_Group 1696 * @ingroup Ecore_IMF_Context_Group
1694 * @since 1.2.0 1697 * @since 1.2.0
1695 */ 1698 */
@@ -1713,7 +1716,7 @@ ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bo
1713 * Get the caps lock mode on the input panel. 1716 * Get the caps lock mode on the input panel.
1714 * 1717 *
1715 * @param ctx An #Ecore_IMF_Context. 1718 * @param ctx An #Ecore_IMF_Context.
1716 * @return EINA_TRUE if the caps lock is turned on. 1719 * @return @c EINA_TRUE if the caps lock is turned on.
1717 * @ingroup Ecore_IMF_Context_Group 1720 * @ingroup Ecore_IMF_Context_Group
1718 * @since 1.2.0 1721 * @since 1.2.0
1719 */ 1722 */
diff --git a/legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c b/legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c
index 775cc89dfc..3518be2224 100644
--- a/legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c
+++ b/legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c
@@ -504,7 +504,7 @@ ecore_ipc_server_data_get(Ecore_Ipc_Server *svr)
504/** 504/**
505 * Retrieves whether the given IPC server is currently connected. 505 * Retrieves whether the given IPC server is currently connected.
506 * @param svr The given IPC server. 506 * @param svr The given IPC server.
507 * @return #EINA_TRUE if the server is connected. #EINA_FALSE otherwise. 507 * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise.
508 * @ingroup Ecore_IPC_Server_Group 508 * @ingroup Ecore_IPC_Server_Group
509 */ 509 */
510EAPI Eina_Bool 510EAPI Eina_Bool
@@ -971,7 +971,8 @@ ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl)
971 * @return A pointer to an internal string that contains the IP address of 971 * @return A pointer to an internal string that contains the IP address of
972 * the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation. 972 * the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation.
973 * This string should not be modified or trusted to stay valid after 973 * This string should not be modified or trusted to stay valid after
974 * deletion for the @p cl object. If no IP is known NULL is returned. 974 * deletion for the @p cl object. If no IP is known @c NULL is
975 * returned.
975 * @ingroup Ecore_Ipc_Client_Group 976 * @ingroup Ecore_Ipc_Client_Group
976 */ 977 */
977EAPI const char * 978EAPI const char *
diff --git a/legacy/ecore/src/lib/ecore_win32/ecore_win32_dnd.c b/legacy/ecore/src/lib/ecore_win32/ecore_win32_dnd.c
index a629c8b955..6c5253ae20 100755
--- a/legacy/ecore/src/lib/ecore_win32/ecore_win32_dnd.c
+++ b/legacy/ecore/src/lib/ecore_win32/ecore_win32_dnd.c
@@ -103,12 +103,12 @@ ecore_win32_dnd_shutdown()
103 * 103 *
104 * @param data The name pf the Drag operation. 104 * @param data The name pf the Drag operation.
105 * @param size The size of the name. 105 * @param size The size of the name.
106 * @return EINA_TRUE on success, EINA_FALSE otherwise. 106 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
107 * 107 *
108 * This function start a Drag operation with the name @p data. If 108 * This function start a Drag operation with the name @p data. If
109 * @p data is @c NULL, EINA_FALSE is returned. if @p size is less than 109 * @p data is @c NULL, @c EINA_FALSE is returned. if @p size is less than
110 * 0, it is set to the length (as strlen()) of @p data. On success the 110 * @c 0, it is set to the length (as strlen()) of @p data. On success the
111 * function returns EINA_TRUE, otherwise it returns EINA_FALSE. 111 * function returns @c EINA_TRUE, otherwise it returns @c EINA_FALSE.
112 */ 112 */
113EAPI Eina_Bool 113EAPI Eina_Bool
114ecore_win32_dnd_begin(const char *data, 114ecore_win32_dnd_begin(const char *data,
@@ -174,12 +174,12 @@ ecore_win32_dnd_begin(const char *data,
174 * @param window The destination of the Drop operation. 174 * @param window The destination of the Drop operation.
175 * @param callback The callback called when the Drop operation 175 * @param callback The callback called when the Drop operation
176 * finishes. 176 * finishes.
177 * @return EINA_TRUE on success, EINA_FALSE otherwise. 177 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
178 * 178 *
179 * This function register a Drop operation on @p window. Once the Drop 179 * This function register a Drop operation on @p window. Once the Drop
180 * operation finishes, @p callback is called. If @p window is @c NULL, 180 * operation finishes, @p callback is called. If @p window is @c NULL,
181 * the function returns EINA_FALSE. On success, it returns EINA_TRUE, 181 * the function returns @c EINA_FALSE. On success, it returns @c EINA_TRUE,
182 * otherwise it returns EINA_FALSE. 182 * otherwise it returns @c EINA_FALSE.
183 */ 183 */
184EAPI Eina_Bool 184EAPI Eina_Bool
185ecore_win32_dnd_register_drop_target(Ecore_Win32_Window *window, 185ecore_win32_dnd_register_drop_target(Ecore_Win32_Window *window,
diff --git a/legacy/ecore/src/lib/ecore_win32/ecore_win32_window.c b/legacy/ecore/src/lib/ecore_win32/ecore_win32_window.c
index 058aef0e60..8cb3caa6da 100644
--- a/legacy/ecore/src/lib/ecore_win32/ecore_win32_window.c
+++ b/legacy/ecore/src/lib/ecore_win32/ecore_win32_window.c
@@ -926,13 +926,13 @@ ecore_win32_window_focus_get(void)
926 * @brief Iconify or restore the given window. 926 * @brief Iconify or restore the given window.
927 * 927 *
928 * @param window The window. 928 * @param window The window.
929 * @param on EINA_TRUE to iconify the window, EINA_FALSE to restore it. 929 * @param on @c EINA_TRUE to iconify the window, @c EINA_FALSE to restore it.
930 * 930 *
931 * This function iconify or restore @p window. If @p on 931 * This function iconify or restore @p window. If @p on is set to @c EINA_TRUE,
932 * is set to EINA_TRUE, the window will be iconified, if it is set to 932 * the window will be iconified, if it is set to @c EINA_FALSE, it will be
933 * EINA_FALSE, it will be restored. If @p window is @c NULL or if the 933 * restored. If @p window is @c NULL or if the state does not change (like
934 * state does not change (like iconifying the window while it is 934 * iconifying the window while it is already iconified), this function does
935 * already iconified), this function does nothing. 935 * nothing.
936 */ 936 */
937EAPI void 937EAPI void
938ecore_win32_window_iconified_set(Ecore_Win32_Window *window, 938ecore_win32_window_iconified_set(Ecore_Win32_Window *window,
@@ -954,13 +954,13 @@ ecore_win32_window_iconified_set(Ecore_Win32_Window *window,
954 * @brief Remove or restore the border of the given window. 954 * @brief Remove or restore the border of the given window.
955 * 955 *
956 * @param window The window. 956 * @param window The window.
957 * @param on EINA_TRUE to remove the border, EINA_FALSE to restore it. 957 * @param on @c EINA_TRUE to remove the border, @c EINA_FALSE to restore it.
958 * 958 *
959 * This function remove or restore the border of @p window. If @p on 959 * This function remove or restore the border of @p window. If @p on is set to
960 * is set to EINA_TRUE, the window will have no border, if it is set to 960 * @c EINA_TRUE, the window will have no border, if it is set to @c EINA_FALSE,
961 * EINA_FALSE, it will have a border. If @p window is @c NULL or if the 961 * it will have a border. If @p window is @c NULL or if the state does not
962 * state does not change (like setting to borderless while the window 962 * change (like setting to borderless while the window has no border), this
963 * has no border), this function does nothing. 963 * function does nothing.
964 */ 964 */
965EAPI void 965EAPI void
966ecore_win32_window_borderless_set(Ecore_Win32_Window *window, 966ecore_win32_window_borderless_set(Ecore_Win32_Window *window,
@@ -1030,13 +1030,13 @@ ecore_win32_window_borderless_set(Ecore_Win32_Window *window,
1030 * @brief Set the given window to fullscreen. 1030 * @brief Set the given window to fullscreen.
1031 * 1031 *
1032 * @param window The window. 1032 * @param window The window.
1033 * @param on EINA_TRUE for fullscreen mode, EINA_FALSE for windowed mode. 1033 * @param on @c EINA_TRUE for fullscreen mode, @c EINA_FALSE for windowed mode.
1034 * 1034 *
1035 * This function set @p window to fullscreen or windowed mode. If @p on 1035 * This function set @p window to fullscreen or windowed mode. If @p on is set
1036 * is set to EINA_TRUE, the window will be fullscreen, if it is set to 1036 * to @c EINA_TRUE, the window will be fullscreen, if it is set to
1037 * EINA_FALSE, it will be windowed. If @p window is @c NULL or if the 1037 * @c EINA_FALSE, it will be windowed. If @p window is @c NULL or if the state
1038 * state does not change (like setting to fullscreen while the window 1038 * does not change (like setting to fullscreen while the window is already
1039 * is already fullscreen), this function does nothing. 1039 * fullscreen), this function does nothing.
1040 */ 1040 */
1041EAPI void 1041EAPI void
1042ecore_win32_window_fullscreen_set(Ecore_Win32_Window *window, 1042ecore_win32_window_fullscreen_set(Ecore_Win32_Window *window,
diff --git a/legacy/ecore/src/lib/ecore_wince/ecore_wince_window.c b/legacy/ecore/src/lib/ecore_wince/ecore_wince_window.c
index 72353ce923..49a6312da3 100644
--- a/legacy/ecore/src/lib/ecore_wince/ecore_wince_window.c
+++ b/legacy/ecore/src/lib/ecore_wince/ecore_wince_window.c
@@ -696,13 +696,13 @@ ecore_wince_window_size_get(Ecore_WinCE_Window *window,
696 * @brief Set the given window to fullscreen. 696 * @brief Set the given window to fullscreen.
697 * 697 *
698 * @param window The window. 698 * @param window The window.
699 * @param on EINA_TRUE for fullscreen mode, EINA_FALSE for windowed mode. 699 * @param on @c EINA_TRUE for fullscreen mode, @c EINA_FALSE for windowed mode.
700 * 700 *
701 * This function set @p window to fullscreen or windowed mode. If @p on 701 * This function set @p window to fullscreen or windowed mode. If @p on is set
702 * is set to EINA_TRUE, the window will be fullscreen, if it is set to 702 * to @c EINA_TRUE, the window will be fullscreen, if it is set to
703 * EINA_FALSE, it will be windowed. If @p window is @c NULL or if the 703 * @c EINA_FALSE, it will be windowed. If @p window is @c NULL or if the state
704 * state does not change (like setting to fullscreen while the window 704 * does not change (like setting to fullscreen while the window is already
705 * is already fullscreen), this function does nothing. 705 * fullscreen), this function does nothing.
706 */ 706 */
707EAPI void 707EAPI void
708ecore_wince_window_fullscreen_set(Ecore_WinCE_Window *window, 708ecore_wince_window_fullscreen_set(Ecore_WinCE_Window *window,
diff --git a/legacy/ecore/src/lib/ecore_x/Ecore_X.h b/legacy/ecore/src/lib/ecore_x/Ecore_X.h
index 463c9b69a0..b3a917ac3b 100644
--- a/legacy/ecore/src/lib/ecore_x/Ecore_X.h
+++ b/legacy/ecore/src/lib/ecore_x/Ecore_X.h
@@ -2962,9 +2962,9 @@ ecore_x_randr_output_crtc_set(Ecore_X_Window root,
2962/* 2962/*
2963 * @brief Validates the header from raw EDID data. 2963 * @brief Validates the header from raw EDID data.
2964 * 2964 *
2965 * @param edid the edid structure 2965 * @param edid The edid structure.
2966 * @param edid_length length of the edid structure 2966 * @param edid_length Length of the edid structure.
2967 * @return EINA_TRUE, if the header is valid. Else EINA_FALSE. 2967 * @return @c EINA_TRUE, if the header is valid, @c EINA_FALSE otherwise.
2968 */ 2968 */
2969EAPI Eina_Bool 2969EAPI Eina_Bool
2970ecore_x_randr_edid_has_valid_header(unsigned char *edid, 2970ecore_x_randr_edid_has_valid_header(unsigned char *edid,
@@ -2973,9 +2973,9 @@ ecore_x_randr_edid_has_valid_header(unsigned char *edid,
2973/* 2973/*
2974 * @brief Checks whether a display's EDID has a valid checksum. 2974 * @brief Checks whether a display's EDID has a valid checksum.
2975 * 2975 *
2976 * @param edid the edid structure 2976 * @param edid The edid structure.
2977 * @param edid_length length of the edid structure 2977 * @param edid_length Length of the edid structure.
2978 * @return EINA_TRUE, if the checksum is valid. Else EINA_FALSE. 2978 * @return @c EINA_TRUE, if the checksum is valid, @c EINA_FALSE otherwise.
2979 */ 2979 */
2980EAPI Eina_Bool 2980EAPI Eina_Bool
2981ecore_x_randr_edid_info_has_valid_checksum(unsigned char *edid, 2981ecore_x_randr_edid_info_has_valid_checksum(unsigned char *edid,
@@ -3080,9 +3080,10 @@ ecore_x_randr_edid_manufacturer_model_get(unsigned char *edid,
3080/* 3080/*
3081 * @brief Looks up the DPMS support from raw EDID data. 3081 * @brief Looks up the DPMS support from raw EDID data.
3082 * 3082 *
3083 * @param edid the edid structure 3083 * @param edid The edid structure.
3084 * @param edid_length length of the edid structure 3084 * @param edid_length Length of the edid structure.
3085 * @return EINA_TRUE, if DPMS is supported in some way. Else EINA_FALSE. 3085 * @return @c EINA_TRUE, if DPMS is supported in some way, @c EINA_FALSE
3086 * otherwise.
3086 */ 3087 */
3087EAPI Eina_Bool 3088EAPI Eina_Bool
3088ecore_x_randr_edid_dpms_available_get(unsigned char *edid, 3089ecore_x_randr_edid_dpms_available_get(unsigned char *edid,
@@ -3091,9 +3092,9 @@ ecore_x_randr_edid_dpms_available_get(unsigned char *edid,
3091/* 3092/*
3092 * @brief Looks up the DPMS Standby support from raw EDID data. 3093 * @brief Looks up the DPMS Standby support from raw EDID data.
3093 * 3094 *
3094 * @param edid the edid structure 3095 * @param edid The edid structure.
3095 * @param edid_length length of the edid structure 3096 * @param edid_length Length of the edid structure.
3096 * @return EINA_TRUE, if DPMS Standby is supported. Else EINA_FALSE. 3097 * @return @c EINA_TRUE, if DPMS Standby is supported, @c EINA_FALSE otherwise.
3097 */ 3098 */
3098EAPI Eina_Bool 3099EAPI Eina_Bool
3099ecore_x_randr_edid_dpms_standby_available_get(unsigned char *edid, 3100ecore_x_randr_edid_dpms_standby_available_get(unsigned char *edid,
@@ -3102,9 +3103,9 @@ ecore_x_randr_edid_dpms_standby_available_get(unsigned char *edid,
3102/* 3103/*
3103 * @brief Looks up the DPMS Suspend support from raw EDID data. 3104 * @brief Looks up the DPMS Suspend support from raw EDID data.
3104 * 3105 *
3105 * @param edid the edid structure 3106 * @param edid The edid structure.
3106 * @param edid_length length of the edid structure 3107 * @param edid_length Length of the edid structure.
3107 * @return EINA_TRUE, if DPMS Suspend is supported. Else EINA_FALSE. 3108 * @return @c EINA_TRUE, if DPMS Suspend is supported, @c EINA_FALSE otherwise.
3108 */ 3109 */
3109EAPI Eina_Bool 3110EAPI Eina_Bool
3110ecore_x_randr_edid_dpms_suspend_available_get(unsigned char *edid, 3111ecore_x_randr_edid_dpms_suspend_available_get(unsigned char *edid,
@@ -3113,9 +3114,9 @@ ecore_x_randr_edid_dpms_suspend_available_get(unsigned char *edid,
3113/* 3114/*
3114 * @brief Looks up the DPMS Off support from raw EDID data. 3115 * @brief Looks up the DPMS Off support from raw EDID data.
3115 * 3116 *
3116 * @param edid the edid structure 3117 * @param edid The edid structure.
3117 * @param edid_length length of the edid structure 3118 * @param edid_length Length of the edid structure.
3118 * @return EINA_TRUE, if DPMS Off is supported. Else EINA_FALSE. 3119 * @return @c EINA_TRUE, if DPMS Off is supported, @c EINA_FALSE otherwise.
3119 */ 3120 */
3120EAPI Eina_Bool 3121EAPI Eina_Bool
3121ecore_x_randr_edid_dpms_off_available_get(unsigned char *edid, 3122ecore_x_randr_edid_dpms_off_available_get(unsigned char *edid,
@@ -3157,9 +3158,10 @@ ecore_x_randr_edid_display_colorscheme_get(unsigned char *edid,
3157/* 3158/*
3158 * @brief Get the display type from raw EDID data. 3159 * @brief Get the display type from raw EDID data.
3159 * 3160 *
3160 * @param edid the edid structure 3161 * @param edid The edid structure.
3161 * @param edid_length length of the edid structure 3162 * @param edid_length Length of the edid structure.
3162 * @return EINA_TRUE, if the display is a digital one. Else EINA_FALSE. 3163 * @return @c EINA_TRUE, if the display is a digital one, @c EINA_FALSE
3164 * otherwise.
3163 */ 3165 */
3164EAPI Eina_Bool 3166EAPI Eina_Bool
3165ecore_x_randr_edid_display_type_digital_get(unsigned char *edid, 3167ecore_x_randr_edid_display_type_digital_get(unsigned char *edid,
@@ -3355,8 +3357,8 @@ ecore_x_region_picture_clip_set(Ecore_X_Region region,
3355 * xfixes selection notification request. 3357 * xfixes selection notification request.
3356 * 3358 *
3357 * This lets you choose which selections you want to get notifications for. 3359 * This lets you choose which selections you want to get notifications for.
3358 * @param selection the selection atom. 3360 * @param selection The selection atom.
3359 * @return EINA_TRUE on success, EINA_FALSE otherwise. 3361 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
3360 * @since 1.1.0 3362 * @since 1.1.0
3361 */ 3363 */
3362EAPI Eina_Bool 3364EAPI Eina_Bool
diff --git a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c
index ca7e798f8d..90e0f3f75b 100644
--- a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c
+++ b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c
@@ -414,7 +414,7 @@ ecore_x_ungrab(void)
414 * @param d3 The client message data item 4 414 * @param d3 The client message data item 4
415 * @param d4 The client message data item 5 415 * @param d4 The client message data item 5
416 * 416 *
417 * @return EINA_TRUE on success EINA_FALSE otherwise. 417 * @return @c EINA_TRUE on success @c EINA_FALSE otherwise.
418 */ 418 */
419EAPI Eina_Bool 419EAPI Eina_Bool
420ecore_x_client_message32_send(Ecore_X_Window win, Ecore_X_Atom type, 420ecore_x_client_message32_send(Ecore_X_Window win, Ecore_X_Atom type,
@@ -462,9 +462,9 @@ ecore_x_client_message32_send(Ecore_X_Window win, Ecore_X_Atom type,
462 * @param win The window the message is sent to. 462 * @param win The window the message is sent to.
463 * @param type The client message type. 463 * @param type The client message type.
464 * @param data Data to be sent. 464 * @param data Data to be sent.
465 * @param len Number of data bytes, max 20. 465 * @param len Number of data bytes, max @c 20.
466 * 466 *
467 * @return EINA_TRUE on success EINA_FALSE otherwise. 467 * @return @c EINA_TRUE on success @c EINA_FALSE otherwise.
468 */ 468 */
469EAPI Eina_Bool 469EAPI Eina_Bool
470ecore_x_client_message8_send(Ecore_X_Window win, Ecore_X_Atom type, 470ecore_x_client_message8_send(Ecore_X_Window win, Ecore_X_Atom type,
@@ -899,7 +899,7 @@ ecore_x_pointer_warp(Ecore_X_Window win, int x, int y)
899 * base + [(base * percent) / 100] 899 * base + [(base * percent) / 100]
900 * where @c base is the bell's base volume as set by XChangeKeyboardControl(3). 900 * where @c base is the bell's base volume as set by XChangeKeyboardControl(3).
901 * 901 *
902 * @returns EINA_TRUE on success, EINA_FALSE otherwise. 902 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
903 */ 903 */
904EAPI Eina_Bool 904EAPI Eina_Bool
905ecore_x_bell(int percent) 905ecore_x_bell(int percent)
diff --git a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_composite.c b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_composite.c
index f247b34777..0d3b44e4aa 100644
--- a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_composite.c
+++ b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_composite.c
@@ -69,7 +69,8 @@ _ecore_xcb_composite_finalize(void)
69/** 69/**
70 * Return whether the Composite Extension is available 70 * Return whether the Composite Extension is available
71 * 71 *
72 * @return EINA_TRUE is the Composite Extension is available, EINA_FALSE if not 72 * @return @c EINA_TRUE is the Composite Extension is available, @c EINA_FALSE
73 * if not.
73 * 74 *
74 * @ingroup Ecore_X_Composite_Group 75 * @ingroup Ecore_X_Composite_Group
75 */ 76 */
diff --git a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c
index 9e6f6c7089..39ef589dd1 100644
--- a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c
+++ b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c
@@ -59,8 +59,8 @@ _ecore_xcb_dpms_finalize(void)
59 * @return @c EINA_TRUE if the DPMS extension is available, 59 * @return @c EINA_TRUE if the DPMS extension is available,
60 * @c EINA_FALSE otherwise. 60 * @c EINA_FALSE otherwise.
61 * 61 *
62 * Return EINA_TRUE if the X server supports the DPMS Extension version 1.0, 62 * Return @c EINA_TRUE if the X server supports the DPMS Extension version 1.0,
63 * EINA_FALSE otherwise. 63 * @c EINA_FALSE otherwise.
64 * 64 *
65 * @ingroup Ecore_X_DPMS_Group 65 * @ingroup Ecore_X_DPMS_Group
66 */ 66 */
@@ -194,10 +194,11 @@ ecore_x_dpms_timeouts_get(unsigned int *standby,
194 194
195/** 195/**
196 * Sets the timeouts. The values are in unit of seconds. 196 * Sets the timeouts. The values are in unit of seconds.
197 *
197 * @param standby Amount of time of inactivity before standby mode will be invoked. 198 * @param standby Amount of time of inactivity before standby mode will be invoked.
198 * @param suspend Amount of time of inactivity before the screen is placed into suspend mode. 199 * @param suspend Amount of time of inactivity before the screen is placed into suspend mode.
199 * @param off Amount of time of inactivity before the monitor is shut off. 200 * @param off Amount of time of inactivity before the monitor is shut off.
200 * @return EINA_TRUE on success, EINA_FALSE on failure. 201 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
201 * @ingroup Ecore_X_DPMS_Group 202 * @ingroup Ecore_X_DPMS_Group
202 */ 203 */
203EAPI Eina_Bool 204EAPI Eina_Bool
diff --git a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c
index 142259aa63..536bc4d4be 100644
--- a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c
+++ b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c
@@ -227,8 +227,9 @@ _ecore_xcb_randr_root_to_screen(Ecore_X_Window root)
227/* public functions */ 227/* public functions */
228 228
229/* 229/*
230 * @brief query whether randr is available or not 230 * @brief Query whether RandR is available or not.
231 * @return EINA_TRUE, if extension is available, else EINA_FALSE 231 *
232 * @return @c EINA_TRUE if extension is available, @c EINA_FALSE otherwise.
232 */ 233 */
233EAPI Eina_Bool 234EAPI Eina_Bool
234ecore_x_randr_query(void) 235ecore_x_randr_query(void)
@@ -305,10 +306,13 @@ ecore_x_randr_screen_primary_output_orientation_get(Ecore_X_Window root)
305} 306}
306 307
307/* 308/*
308 * @brief sets a given screen's primary output's orientation 309 * @brief Sets a given screen's primary output's orientation.
309 * @param root window which's screen's primary output will be queried 310 *
310 * @param orientation orientation which should be set for the root window's screen primary output 311 * @param root Window which's screen's primary output will be queried.
311 * @return EINA_TRUE if the primary output's orientation could be successfully altered 312 * @param orientation Orientation which should be set for the root window's
313 * screen primary output.
314 * @return @c EINA_TRUE if the primary output's orientation could be
315 * successfully altered.
312 */ 316 */
313EAPI Eina_Bool 317EAPI Eina_Bool
314ecore_x_randr_screen_primary_output_orientation_set(Ecore_X_Window root, 318ecore_x_randr_screen_primary_output_orientation_set(Ecore_X_Window root,
@@ -468,10 +472,14 @@ ecore_x_randr_screen_primary_output_current_size_get(Ecore_X_Window root,
468} 472}
469 473
470/* 474/*
471 * @brief sets a given screen's primary output size, but disables all other outputs at the same time 475 * @brief Sets a given screen's primary output size, but disables all other
472 * @param root window which's primary output will be queried 476 * outputs at the same time.
473 * @param size_index within the list of sizes reported as supported by the root window's screen primary output 477 *
474 * @return EINA_TRUE on success, EINA_FALSE on failure due to e.g. invalid times 478 * @param root Window which's primary output will be queried.
479 * @param size_index Within the list of sizes reported as supported by the root
480 * window's screen primary output.
481 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure due to e.g.
482 * invalid times.
475 */ 483 */
476EAPI Eina_Bool 484EAPI Eina_Bool
477ecore_x_randr_screen_primary_output_size_set(Ecore_X_Window root, 485ecore_x_randr_screen_primary_output_size_set(Ecore_X_Window root,
@@ -620,11 +628,12 @@ ecore_x_randr_screen_primary_output_refresh_rates_get(Ecore_X_Window root,
620} 628}
621 629
622/* 630/*
623 * @brief sets the current primary output's refresh rate 631 * @brief Sets the current primary output's refresh rate.
624 * @param root window which's primary output will be queried 632 *
625 * @param size_index referencing the size to be set 633 * @param root Window which's primary output will be queried.
626 * @param rate the refresh rate to be set 634 * @param size_index Referencing the size to be set.
627 * @return EINA_TRUE on success else EINA_FALSE 635 * @param rate The refresh rate to be set.
636 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
628 */ 637 */
629EAPI Eina_Bool 638EAPI Eina_Bool
630ecore_x_randr_screen_primary_output_refresh_rate_set(Ecore_X_Window root, 639ecore_x_randr_screen_primary_output_refresh_rate_set(Ecore_X_Window root,
@@ -675,9 +684,10 @@ ecore_x_randr_screen_primary_output_refresh_rate_set(Ecore_X_Window
675} 684}
676 685
677/* 686/*
678 * @brief free detailed mode information. The pointer handed in will be set to 687 * @brief Free detailed mode information. The pointer handed in will be set to
679 * NULL after freeing the memory. 688 * @c NULL after freeing the memory.
680 * @param mode_info the mode information that should be freed 689 *
690 * @param mode_info The mode information that should be freed.
681 */ 691 */
682EAPI void 692EAPI void
683ecore_x_randr_mode_info_free(Ecore_X_Randr_Mode_Info *mode_info) 693ecore_x_randr_mode_info_free(Ecore_X_Randr_Mode_Info *mode_info)
@@ -936,12 +946,13 @@ ecore_x_randr_mode_size_get(Ecore_X_Window root,
936} 946}
937 947
938/** 948/**
939 * @brief gets the EDID information of an attached output if available. 949 * @brief Gets the EDID information of an attached output if available.
940 * Note that this information is not to be compared using ordinary string 950 * Note that this information is not to be compared using ordinary string
941 * comparison functions, since it includes 0-bytes. 951 * comparison functions, since it includes 0-bytes.
942 * @param root window this information should be queried from 952 *
943 * @param output the XID of the output 953 * @param root Window this information should be queried from.
944 * @param length length of the byte-array. If @c NULL, request will fail. 954 * @param output The XID of the output.
955 * @param length Length of the byte-array. If @c NULL, request will fail.
945 * @return EDID information of the output. 956 * @return EDID information of the output.
946 */ 957 */
947EAPI unsigned char * 958EAPI unsigned char *
@@ -990,10 +1001,11 @@ ecore_x_randr_output_edid_get(Ecore_X_Window root,
990} 1001}
991 1002
992/** 1003/**
993 * @brief gets the outputs which might be used simultaneously on the same CRTC. 1004 * @brief Gets the outputs which might be used simultaneously on the same CRTC.
994 * @param root window that this information should be queried for. 1005 *
995 * @param output the output which's clones we concern 1006 * @param root Window that this information should be queried for.
996 * @param num number of possible clones 1007 * @param output The output which's clones we concern.
1008 * @param num Number of possible clones.
997 * @return The existing outputs, @c NULL otherwise. 1009 * @return The existing outputs, @c NULL otherwise.
998 */ 1010 */
999EAPI Ecore_X_Randr_Output * 1011EAPI Ecore_X_Randr_Output *
@@ -1180,24 +1192,26 @@ ecore_x_randr_output_size_mm_get(Ecore_X_Window root, Ecore_X_Randr_Output outpu
1180} 1192}
1181 1193
1182/** 1194/**
1183 * @brief sets the demanded parameters for a given CRTC. Note that the CRTC is 1195 * @brief Sets the demanded parameters for a given CRTC. Note that the CRTC is
1184 * auto enabled in it's preferred mode, when it was disabled before. 1196 * auto enabled in it's preferred mode, when it was disabled before.
1185 * @param root the root window which's default display will be queried 1197 *
1186 * @param crtc the CRTC which's configuration should be altered 1198 * @param root The root window which's default display will be queried.
1187 * @param outputs an array of outputs, that should display this CRTC's content. 1199 * @param crtc The CRTC which's configuration should be altered.
1188 * @param noutputs number of outputs in the array of outputs. 1200 * @param outputs An array of outputs, that should display this CRTC's content.
1189 * If set to Ecore_X_Randr_Unset, current outputs and number of outputs will be used. 1201 * @param noutputs Number of outputs in the array of outputs. If set to
1190 * If set to Ecore_X_Randr_None, CRTC will be disabled 1202 * Ecore_X_Randr_Unset, current outputs and number of outputs will be used. If
1191 * @param x new x coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current x 1203 * set to Ecore_X_Randr_None, CRTC will be disabled.
1192 * corrdinate will be assumed. 1204 * @param x New x coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current x
1193 * @param y new y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y 1205 * coordinate will be assumed.
1194 * corrdinate will be assumed. 1206 * @param y New y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y
1195 * @param mode the new mode to be set. If Ecore_X_Randr_None is passed, the 1207 * coordinate will be assumed.
1196 * CRTC will be disabled. If Ecore_X_Randr_Unset is passed, the current mode is assumed. 1208 * @param mode The new mode to be set. If Ecore_X_Randr_None is passed, the
1197 * @param orientation the new orientation to be set. If Ecore_X_Randr_Unset is used, 1209 * CRTC will be disabled. If Ecore_X_Randr_Unset is passed, the current mode is
1198 * the current mode is assumed. 1210 * assumed.
1199 * @return EINA_TRUE if the configuration alteration was successful, else 1211 * @param orientation The new orientation to be set. If Ecore_X_Randr_Unset is
1200 * EINA_FALSE 1212 * used, the current mode is assumed.
1213 * @return @c EINA_TRUE if the configuration alteration was successful,
1214 * @c EINA_FALSE otherwise.
1201 */ 1215 */
1202EAPI Eina_Bool 1216EAPI Eina_Bool
1203ecore_x_randr_crtc_settings_set(Ecore_X_Window root, 1217ecore_x_randr_crtc_settings_set(Ecore_X_Window root,
@@ -1276,16 +1290,18 @@ ecore_x_randr_crtc_settings_set(Ecore_X_Window root,
1276} 1290}
1277 1291
1278/** 1292/**
1279 * @brief sets a mode for a CRTC and the outputs attached to it 1293 * @brief Sets a mode for a CRTC and the outputs attached to it.
1280 * @param root the window's screen to be queried 1294 *
1281 * @param crtc the CRTC which shall be set 1295 * @param root The window's screen to be queried
1282 * @param outputs array of outputs which have to be compatible with the mode. If 1296 * @param crtc The CRTC which shall be set
1283 * NULL CRTC will be disabled. 1297 * @param outputs Array of outputs which have to be compatible with the mode. If
1284 * @param noutputs number of outputs in array to be used. Use 1298 * @c NULL CRTC will be disabled.
1285 * Ecore_X_Randr_Unset (or -1) to use currently used outputs. 1299 * @param num Number of outputs in array to be used. Use
1286 * @param mode XID of the mode to be set. If set to 0 the CRTC will be disabled. 1300 * Ecore_X_Randr_Unset (or @c -1) to use currently used outputs.
1287 * If set to -1 the call will fail. 1301 * @param mode XID of the mode to be set. If set to @c 0 the CRTC will be
1288 * @return EINA_TRUE if mode setting was successful. Else EINA_FALSE 1302 * disabled. If set to @c -1 the call will fail.
1303 * @return @c EINA_TRUE if mode setting was successful, @c EINA_FALSE
1304 * otherwise.
1289 */ 1305 */
1290EAPI Eina_Bool 1306EAPI Eina_Bool
1291ecore_x_randr_crtc_mode_set(Ecore_X_Window root, 1307ecore_x_randr_crtc_mode_set(Ecore_X_Window root,
@@ -1562,10 +1578,11 @@ ecore_x_randr_crtcs_get(Ecore_X_Window root,
1562 1578
1563/* 1579/*
1564 * @deprecated bad naming. Use ecore_x_randr_window_crtcs_get instead. 1580 * @deprecated bad naming. Use ecore_x_randr_window_crtcs_get instead.
1565 * @brief get the CRTCs, which display a certain window 1581 * @brief Get the CRTCs, which display a certain window.
1566 * @param window window the displaying CRTCs shall be found for 1582 *
1567 * @param num the number of CRTCs displaying the window 1583 * @param window Window the displaying CRTCs shall be found for.
1568 * @return array of CRTCs that display a certain window. NULL if no CRTCs 1584 * @param num The number of CRTCs displaying the window.
1585 * @return Array of CRTCs that display a certain window. @c NULL if no CRTCs
1569 * was found that displays the specified window. 1586 * was found that displays the specified window.
1570 */ 1587 */
1571EAPI Ecore_X_Randr_Crtc * 1588EAPI Ecore_X_Randr_Crtc *
@@ -1576,10 +1593,11 @@ ecore_x_randr_current_crtc_get(Ecore_X_Window window,
1576} 1593}
1577 1594
1578/* 1595/*
1579 * @brief get the CRTCs, which display a certain window 1596 * @brief Get the CRTCs, which display a certain window.
1580 * @param window window the displaying crtcs shall be found for 1597 *
1581 * @param num the number of crtcs displaying the window 1598 * @param window Window the displaying crtcs shall be found for.
1582 * @return array of crtcs that display a certain window. NULL if no crtcs 1599 * @param num The number of crtcs displaying the window.
1600 * @return Array of crtcs that display a certain window. @c NULL if no crtcs
1583 * was found that displays the specified window. 1601 * was found that displays the specified window.
1584 * @since 1.2.0 1602 * @since 1.2.0
1585 */ 1603 */
@@ -1730,14 +1748,16 @@ ecore_x_randr_crtc_geometry_get(Ecore_X_Window root,
1730} 1748}
1731 1749
1732/** 1750/**
1733 * @brief sets a CRTC relative to another one. 1751 * @brief Sets a CRTC relative to another one.
1734 * @param crtc1 the CRTC to be positioned. 1752 *
1735 * @param crtc2 the CRTC the position should be relative to 1753 * @param crtc1 The CRTC to be positioned.
1736 * @param policy the relation between the crtcs 1754 * @param crtc2 The CRTC the position should be relative to.
1737 * @param alignment in case CRTCs size differ, aligns CRTC1 accordingly at CRTC2's 1755 * @param policy The relation between the crtcs.
1738 * borders 1756 * @param alignment In case CRTCs size differ, aligns CRTC1 accordingly at
1739 * @return EINA_TRUE if crtc could be successfully positioned. EINA_FALSE if 1757 * CRTC2's borders.
1740 * repositioning failed or if position of new crtc would be out of given screen's min/max bounds. 1758 * @return @c EINA_TRUE if crtc could be successfully positioned, @c EINA_FALSE
1759 * if repositioning failed or if position of new crtc would be out of given
1760 * screen's min/max bounds.
1741 */ 1761 */
1742EAPI Eina_Bool 1762EAPI Eina_Bool
1743ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root, 1763ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root,
@@ -1888,12 +1908,16 @@ ecore_x_randr_crtc_pos_get(Ecore_X_Window root,
1888} 1908}
1889 1909
1890/* 1910/*
1891 * @brief sets the position of given CRTC within root window's screen 1911 * @brief Sets the position of given CRTC within root window's screen.
1892 * @param root the window's screen to be queried 1912 *
1893 * @param crtc the CRTC which's position within the mentioned screen is to be altered 1913 * @param root The window's screen to be queried.
1894 * @param x position on the x-axis (0 == left) of the screen. if x < 0 current value will be kept. 1914 * @param crtc The CRTC which's position within the mentioned screen is to be
1895 * @param y position on the y-ayis (0 == top) of the screen. if y < 0, current value will be kept. 1915 * altered.
1896 * @return EINA_TRUE if position could be successfully be altered. 1916 * @param x Position on the x-axis (0 == left) of the screen. if x < 0 current
1917 * value will be kept.
1918 * @param y Position on the y-ayis (0 == top) of the screen. if y < 0, current
1919 * value will be kept.
1920 * @return @c EINA_TRUE if position could be successfully be altered.
1897 */ 1921 */
1898EAPI Eina_Bool 1922EAPI Eina_Bool
1899ecore_x_randr_crtc_pos_set(Ecore_X_Window root, 1923ecore_x_randr_crtc_pos_set(Ecore_X_Window root,
@@ -2031,13 +2055,16 @@ ecore_x_randr_crtc_refresh_rate_get(Ecore_X_Window root,
2031} 2055}
2032 2056
2033/* 2057/*
2034 * @brief move given CRTCs belonging to the given root window's screen dx/dy pixels relative to their current position. The screen size will be automatically adjusted if necessary and possible. 2058 * @brief Move given CRTCs belonging to the given root window's screen dx/dy
2035 * @param root window which's screen's resources are used 2059 * pixels relative to their current position. The screen size will be
2036 * @param crtcs list of CRTCs to be moved 2060 * automatically adjusted if necessary and possible.
2037 * @param ncrtc number of CRTCs in array 2061 *
2038 * @param dx amount of pixels the CRTCs should be moved in x direction 2062 * @param root Window which's screen's resources are used.
2039 * @param dy amount of pixels the CRTCs should be moved in y direction 2063 * @param crtcs List of CRTCs to be moved.
2040 * @return EINA_TRUE if all crtcs could be moved successfully. 2064 * @param ncrtc Number of CRTCs in array.
2065 * @param dx Amount of pixels the CRTCs should be moved in x direction.
2066 * @param dy Amount of pixels the CRTCs should be moved in y direction.
2067 * @return @c EINA_TRUE if all crtcs could be moved successfully.
2041 */ 2068 */
2042EAPI Eina_Bool 2069EAPI Eina_Bool
2043ecore_x_randr_move_crtcs(Ecore_X_Window root, 2070ecore_x_randr_move_crtcs(Ecore_X_Window root,
@@ -2319,13 +2346,18 @@ ecore_x_randr_screen_current_size_get(Ecore_X_Window root,
2319} 2346}
2320 2347
2321/* 2348/*
2322 * @param root window which's screen's size should be set. If invalid (e.g. NULL) no action is taken. 2349 * @param root Window which's screen's size should be set. If invalid (e.g.
2323 * @param w width in px the screen should be set to. If out of valid boundaries, current value is assumed. 2350 * @c NULL) no action is taken.
2324 * @param h height in px the screen should be set to. If out of valid boundaries, current value is assumed. 2351 * @param w Width in px the screen should be set to. If out of valid
2325 * @param w_mm width in mm the screen should be set to. If 0, current aspect is assumed. 2352 * boundaries, current value is assumed.
2326 * @param h_mm height in mm the screen should be set to. If 0, current aspect is assumed. 2353 * @param h Height in px the screen should be set to. If out of valid
2327 * @return EINA_TRUE if request was successfully sent or screen is already in 2354 * boundaries, current value is assumed.
2328 * requested size, EINA_FALSE if parameters are invalid 2355 * @param w_mm Width in mm the screen should be set to. If @c 0, current
2356 * aspect is assumed.
2357 * @param h_mm Height in mm the screen should be set to. If @c 0, current
2358 * aspect is assumed.
2359 * @return @c EINA_TRUE if request was successfully sent or screen is already
2360 * in requested size, @c EINA_FALSE if parameters are invalid.
2329 */ 2361 */
2330EAPI Eina_Bool 2362EAPI Eina_Bool
2331ecore_x_randr_screen_current_size_set(Ecore_X_Window root, 2363ecore_x_randr_screen_current_size_set(Ecore_X_Window root,
@@ -2376,11 +2408,12 @@ ecore_x_randr_screen_current_size_set(Ecore_X_Window root,
2376 2408
2377/* 2409/*
2378 * @deprecated bad naming. Use ecore_x_randr_window_outputs_get instead. 2410 * @deprecated bad naming. Use ecore_x_randr_window_outputs_get instead.
2379 * @brief get the outputs, which display a certain window 2411 * @brief Get the outputs, which display a certain window.
2380 * @param window window the displaying outputs shall be found for 2412 *
2381 * @param num the number of outputs displaying the window 2413 * @param window Window the displaying outputs shall be found for.
2382 * @return array of outputs that display a certain window. NULL if no outputs 2414 * @param num The number of outputs displaying the window.
2383 * was found that displays the specified window. 2415 * @return Array of outputs that display a certain window. @c NULL if no
2416 * outputs was found that displays the specified window.
2384 */ 2417 */
2385 2418
2386Ecore_X_Randr_Output * 2419Ecore_X_Randr_Output *
@@ -2391,11 +2424,12 @@ ecore_x_randr_current_output_get(Ecore_X_Window window,
2391} 2424}
2392 2425
2393/* 2426/*
2394 * @brief get the outputs, which display a certain window 2427 * @brief Get the outputs, which display a certain window.
2395 * @param window window the displaying outputs shall be found for 2428 *
2396 * @param num the number of outputs displaying the window 2429 * @param window Window the displaying outputs shall be found for.
2397 * @return array of outputs that display a certain window. NULL if no outputs 2430 * @param num The number of outputs displaying the window.
2398 * was found that displays the specified window. 2431 * @return Array of outputs that display a certain window. @c NULL if no
2432 * outputs was found that displays the specified window.
2399 */ 2433 */
2400EAPI Ecore_X_Randr_Output * 2434EAPI Ecore_X_Randr_Output *
2401ecore_x_randr_window_outputs_get(Ecore_X_Window window, 2435ecore_x_randr_window_outputs_get(Ecore_X_Window window,
@@ -2550,11 +2584,12 @@ ecore_x_randr_output_backlight_level_get(Ecore_X_Window root,
2550} 2584}
2551 2585
2552/* 2586/*
2553 * @brief set the backlight level of a given output 2587 * @brief Set the backlight level of a given output.
2554 * @param root window which's screen should be queried 2588 *
2555 * @param output that should be set 2589 * @param root Window which's screen should be queried.
2556 * @param level for which the backlight should be set 2590 * @param output That should be set.
2557 * @return EINA_TRUE in case of success 2591 * @param level For which the backlight should be set.
2592 * @return @c EINA_TRUE in case of success.
2558 */ 2593 */
2559EAPI Eina_Bool 2594EAPI Eina_Bool
2560ecore_x_randr_output_backlight_level_set(Ecore_X_Window root, 2595ecore_x_randr_output_backlight_level_set(Ecore_X_Window root,
@@ -2637,8 +2672,9 @@ ecore_x_randr_output_backlight_level_set(Ecore_X_Window root,
2637} 2672}
2638 2673
2639/* 2674/*
2640 * @brief check if a backlight is available 2675 * @brief Check if a backlight is available.
2641 * @return whether a blacklight is available 2676 *
2677 * @return Whether a backlight is available.
2642 */ 2678 */
2643EAPI Eina_Bool 2679EAPI Eina_Bool
2644ecore_x_randr_output_backlight_available(void) 2680ecore_x_randr_output_backlight_available(void)
@@ -2802,10 +2838,12 @@ _ecore_xcb_randr_output_validate(Ecore_X_Window root,
2802} 2838}
2803 2839
2804/** 2840/**
2805 * @brief validates a CRTC for a given root window's screen. 2841 * @brief Validates a CRTC for a given root window's screen.
2806 * @param root the window which's default display will be queried 2842 *
2807 * @param crtc the CRTC to be validated. 2843 * @param root The window which's default display will be queried.
2808 * @return in case it is found EINA_TRUE will be returned. Else EINA_FALSE is returned. 2844 * @param crtc The CRTC to be validated.
2845 * @return In case it is found @c EINA_TRUE will be returned, else
2846 * @c EINA_FALSE is returned.
2809 */ 2847 */
2810static Eina_Bool 2848static Eina_Bool
2811_ecore_xcb_randr_crtc_validate(Ecore_X_Window root, 2849_ecore_xcb_randr_crtc_validate(Ecore_X_Window root,
diff --git a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c
index a742b7a85f..6e180f4bae 100644
--- a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c
+++ b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c
@@ -977,7 +977,7 @@ ecore_x_dpi_get(void)
977 * base + [(base * percent) / 100] 977 * base + [(base * percent) / 100]
978 * where @c base is the bell's base volume as set by XChangeKeyboardControl(3). 978 * where @c base is the bell's base volume as set by XChangeKeyboardControl(3).
979 * 979 *
980 * @returns EINA_TRUE on success, EINA_FALSE otherwise. 980 * @returns @c EINA_TRUE on success, @c EINA_FALSE otherwise.
981 */ 981 */
982EAPI Eina_Bool 982EAPI Eina_Bool
983ecore_x_bell(int percent) 983ecore_x_bell(int percent)
@@ -1808,7 +1808,7 @@ ecore_x_window_key_ungrab(Ecore_X_Window win,
1808 * @param d3 The client message data item 4 1808 * @param d3 The client message data item 4
1809 * @param d4 The client message data item 5 1809 * @param d4 The client message data item 5
1810 * 1810 *
1811 * @return EINA_TRUE on success EINA_FALSE otherwise. 1811 * @return @c EINA_TRUE on success @c EINA_FALSE otherwise.
1812 */ 1812 */
1813EAPI Eina_Bool 1813EAPI Eina_Bool
1814ecore_x_client_message32_send(Ecore_X_Window win, 1814ecore_x_client_message32_send(Ecore_X_Window win,
@@ -1842,9 +1842,9 @@ ecore_x_client_message32_send(Ecore_X_Window win,
1842 * @param win The window the message is sent to. 1842 * @param win The window the message is sent to.
1843 * @param type The client message type. 1843 * @param type The client message type.
1844 * @param data Data to be sent. 1844 * @param data Data to be sent.
1845 * @param len Number of data bytes, max 20. 1845 * @param len Number of data bytes, max @c 20.
1846 * 1846 *
1847 * @return EINA_TRUE on success EINA_FALSE otherwise. 1847 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1848 */ 1848 */
1849EAPI Eina_Bool 1849EAPI Eina_Bool
1850ecore_x_client_message8_send(Ecore_X_Window win, 1850ecore_x_client_message8_send(Ecore_X_Window win,
diff --git a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_gesture.c b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_gesture.c
index e89421bf4b..3c390a9e6d 100644
--- a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_gesture.c
+++ b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_gesture.c
@@ -33,8 +33,9 @@ _ecore_x_gesture_init(void)
33} 33}
34 34
35/* 35/*
36 * @brief query whether gesture is available or not 36 * @brief Query whether gesture is available or not.
37 * @return EINA_TRUE, if extension is available, else EINA_FALSE 37 *
38 * @return @c EINA_TRUE, if extension is available, @c EINA_FALSE otherwise.
38 */ 39 */
39EAPI Eina_Bool 40EAPI Eina_Bool
40ecore_x_gesture_supported(void) 41ecore_x_gesture_supported(void)
diff --git a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr.c b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr.c
index d4d834f290..58a28305ac 100644
--- a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr.c
+++ b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr.c
@@ -53,8 +53,9 @@ _ecore_x_randr_init(void)
53} 53}
54 54
55/* 55/*
56 * @brief query whether randr is available or not 56 * @brief Query whether randr is available or not.
57 * @return EINA_TRUE, if extension is available, else EINA_FALSE 57 *
58 * @return @c EINA_TRUE, if extension is available, @c EINA_FALSE otherwise.
58 */ 59 */
59EAPI Eina_Bool 60EAPI Eina_Bool
60ecore_x_randr_query(void) 61ecore_x_randr_query(void)
@@ -63,8 +64,8 @@ ecore_x_randr_query(void)
63} 64}
64 65
65/* 66/*
66 * @return version of the RandRR extension supported by the server or, 67 * @return version of the RandR extension supported by the server or, in case
67 * in case RandRR extension is not available, Ecore_X_Randr_Unset (=-1). 68 * RandR extension is not available, Ecore_X_Randr_Unset (=-1).
68 * bit version information: 31 MAJOR 16 | 15 MINOR 0 69 * bit version information: 31 MAJOR 16 | 15 MINOR 0
69 */ 70 */
70EAPI int 71EAPI int
diff --git a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_11.c b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_11.c
index 816f8d5a03..f239c026f8 100644
--- a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_11.c
+++ b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_11.c
@@ -69,10 +69,13 @@ ecore_x_randr_screen_primary_output_orientation_get(Ecore_X_Window root)
69} 69}
70 70
71/* 71/*
72 * @brief sets a given screen's primary output's orientation 72 * @brief Sets a given screen's primary output's orientation.
73 * @param root window which's screen's primary output will be queried 73 *
74 * @param orientation orientation which should be set for the root window's screen primary output 74 * @param root Window which's screen's primary output will be queried.
75 * @return EINA_TRUE if the primary output's orientation could be successfully altered 75 * @param orientation orientation which should be set for the root window's
76 * screen primary output.
77 * @return @c EINA_TRUE if the primary output's orientation could be
78 * successfully altered.
76 */ 79 */
77EAPI Eina_Bool 80EAPI Eina_Bool
78ecore_x_randr_screen_primary_output_orientation_set( 81ecore_x_randr_screen_primary_output_orientation_set(
@@ -200,10 +203,14 @@ ecore_x_randr_screen_primary_output_current_size_get(Ecore_X_Window root,
200} 203}
201 204
202/* 205/*
203 * @brief sets a given screen's primary output size, but disables all other outputs at the same time 206 * @brief Sets a given screen's primary output size, but disables all other
204 * @param root window which's primary output will be queried 207 * outputs at the same time.
205 * @param size_index within the list of sizes reported as supported by the root window's screen primary output 208 *
206 * @return EINA_TRUE on success, EINA_FALSE on failure due to e.g. invalid times 209 * @param root Window which's primary output will be queried.
210 * @param size_index Within the list of sizes reported as supported by the root
211 * window's screen primary output.
212 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure due to e.g.
213 * invalid times.
207 */ 214 */
208EAPI Eina_Bool 215EAPI Eina_Bool
209ecore_x_randr_screen_primary_output_size_set(Ecore_X_Window root, 216ecore_x_randr_screen_primary_output_size_set(Ecore_X_Window root,
@@ -300,11 +307,12 @@ ecore_x_randr_screen_primary_output_refresh_rates_get(Ecore_X_Window root,
300 307
301//>= 1.1 308//>= 1.1
302/* 309/*
303 * @brief sets the current primary output's refresh rate 310 * @brief Sets the current primary output's refresh rate.
304 * @param root window which's primary output will be queried 311 *
305 * @param size_index referencing the size to be set 312 * @param root Window which's primary output will be queried.
306 * @param rate the refresh rate to be set 313 * @param size_index Referencing the size to be set.
307 * @return EINA_TRUE on success else EINA_FALSE 314 * @param rate The refresh rate to be set.
315 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
308 */ 316 */
309EAPI Eina_Bool 317EAPI Eina_Bool
310ecore_x_randr_screen_primary_output_refresh_rate_set( 318ecore_x_randr_screen_primary_output_refresh_rate_set(
diff --git a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c
index ec23b3c502..967180c874 100644
--- a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c
+++ b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c
@@ -43,10 +43,11 @@ extern int _randr_version;
43#endif 43#endif
44 44
45/** 45/**
46 * @brief enable event selection. This enables basic interaction with 46 * @brief Enable event selection. This enables basic interaction with
47 * output/crtc events and requires RRandR >= 1.2. 47 * output/crtc events and requires RandR >= 1.2.
48 * @param win select this window's properties for RandRR events 48 *
49 * @param on enable/disable selecting 49 * @param win Select this window's properties for RandR events.
50 * @param on Enable/disable selecting.
50 */ 51 */
51EAPI void 52EAPI void
52ecore_x_randr_events_select(Ecore_X_Window win, 53ecore_x_randr_events_select(Ecore_X_Window win,
@@ -72,10 +73,12 @@ ecore_x_randr_events_select(Ecore_X_Window win,
72} 73}
73 74
74/** 75/**
75 * @brief validates a CRTC for a given root window's screen. 76 * @brief Validates a CRTC for a given root window's screen.
76 * @param root the window which's default display will be queried 77 *
77 * @param crtc the CRTC to be validated. 78 * @param root The window which's default display will be queried.
78 * @return in case it is found EINA_TRUE will be returned. Else EINA_FALSE is returned. 79 * @param crtc The CRTC to be validated.
80 * @return In case it is found, @c EINA_TRUE will be returned, @c EINA_FALSE
81 * otherwise.
79 */ 82 */
80static inline Eina_Bool 83static inline Eina_Bool
81_ecore_x_randr_crtc_validate(Ecore_X_Window root, 84_ecore_x_randr_crtc_validate(Ecore_X_Window root,
@@ -244,13 +247,18 @@ ecore_x_randr_screen_size_range_get(Ecore_X_Window root,
244} 247}
245 248
246/* 249/*
247 * @param root window which's screen's size should be set. If invalid (e.g. NULL) no action is taken. 250 * @param root Window which's screen's size should be set. If invalid (e.g.
248 * @param w width in px the screen should be set to. If out of valid boundaries, current value is assumed. 251 * @c NULL) no action is taken.
249 * @param h height in px the screen should be set to. If out of valid boundaries, current value is assumed. 252 * @param w Width in px the screen should be set to. If out of valid
250 * @param w_mm width in mm the screen should be set to. If 0, current aspect is assumed. 253 * boundaries, current value is assumed.
251 * @param h_mm height in mm the screen should be set to. If 0, current aspect is assumed. 254 * @param h Height in px the screen should be set to. If out of valid
252 * @return EINA_TRUE if request was successfully sent or screen is already in 255 * boundaries, current value is assumed.
253 * requested size, EINA_FALSE if parameters are invalid 256 * @param w_mm Width in mm the screen should be set to. If @c 0, current
257 * aspect is assumed.
258 * @param h_mm Height in mm the screen should be set to. If @c 0, current
259 * aspect is assumed.
260 * @return @c EINA_TRUE if request was successfully sent or screen is already
261 * in requested size, @c EINA_FALSE if parameters are invalid.
254 */ 262 */
255EAPI Eina_Bool 263EAPI Eina_Bool
256ecore_x_randr_screen_current_size_set(Ecore_X_Window root, 264ecore_x_randr_screen_current_size_set(Ecore_X_Window root,
@@ -380,8 +388,9 @@ ecore_x_randr_modes_info_get(Ecore_X_Window root,
380} 388}
381 389
382/* 390/*
383 * @brief add a mode to a display 391 * @brief Add a mode to a display.
384 * @param root window to which's screen's ressources are added 392 *
393 * @param root Window to which's screen's ressources are added.
385 * @param mode_info 394 * @param mode_info
386 * @return Ecore_X_Randr_Mode of the added mode. Ecore_X_Randr_None if mode 395 * @return Ecore_X_Randr_Mode of the added mode. Ecore_X_Randr_None if mode
387 * adding failed. 396 * adding failed.
@@ -405,7 +414,8 @@ ecore_x_randr_mode_info_add(Ecore_X_Window root,
405} 414}
406 415
407/* 416/*
408 * @brief delete a mode from the display 417 * @brief Delete a mode from the display.
418 *
409 * @param mode_info 419 * @param mode_info
410 * @since 1.2.0 420 * @since 1.2.0
411 */ 421 */
@@ -480,9 +490,10 @@ ecore_x_randr_mode_info_get(Ecore_X_Window root,
480} 490}
481 491
482/* 492/*
483 * @brief free detailed mode information. The pointer handed in will be set to 493 * @brief Free detailed mode information. The pointer handed in will be set to
484 * NULL after freeing the memory. 494 * @c NULL after freeing the memory.
485 * @param mode_info the mode information that should be freed 495 *
496 * @param mode_info The mode information that should be freed.
486 */ 497 */
487EAPI void 498EAPI void
488ecore_x_randr_mode_info_free(Ecore_X_Randr_Mode_Info *mode_info) 499ecore_x_randr_mode_info_free(Ecore_X_Randr_Mode_Info *mode_info)
@@ -501,10 +512,11 @@ ecore_x_randr_mode_info_free(Ecore_X_Randr_Mode_Info *mode_info)
501} 512}
502 513
503/* 514/*
504 * @brief get all known CRTCs related to a root window's screen 515 * @brief Get all known CRTCs related to a root window's screen.
505 * @param root window which's screen's ressources are queried 516 *
506 * @param num number of CRTCs returned 517 * @param root Window which's screen's ressources are queried.
507 * @return CRTC IDs 518 * @param num Number of CRTCs returned.
519 * @return CRTC IDs.
508 */ 520 */
509EAPI Ecore_X_Randr_Crtc * 521EAPI Ecore_X_Randr_Crtc *
510ecore_x_randr_crtcs_get(Ecore_X_Window root, 522ecore_x_randr_crtcs_get(Ecore_X_Window root,
@@ -538,7 +550,7 @@ ecore_x_randr_crtcs_get(Ecore_X_Window root,
538 * @brief get the CRTCs, which display a certain window 550 * @brief get the CRTCs, which display a certain window
539 * @param window window the displaying crtcs shall be found for 551 * @param window window the displaying crtcs shall be found for
540 * @param num the number of crtcs displaying the window 552 * @param num the number of crtcs displaying the window
541 * @return array of crtcs that display a certain window. NULL if no crtcs 553 * @return Array of crtcs that display a certain window. @c NULL if no crtcs
542 * was found that displays the specified window. 554 * was found that displays the specified window.
543 */ 555 */
544EAPI Ecore_X_Randr_Crtc * 556EAPI Ecore_X_Randr_Crtc *
@@ -552,7 +564,7 @@ ecore_x_randr_current_crtc_get(Ecore_X_Window window,
552 * @brief get the CRTCs, which display a certain window 564 * @brief get the CRTCs, which display a certain window
553 * @param window window the displaying crtcs shall be found for 565 * @param window window the displaying crtcs shall be found for
554 * @param num the number of crtcs displaying the window 566 * @param num the number of crtcs displaying the window
555 * @return array of crtcs that display a certain window. NULL if no crtcs 567 * @return Array of crtcs that display a certain window. @c NULL if no crtcs
556 * was found that displays the specified window. 568 * was found that displays the specified window.
557 * @since 1.2.0 569 * @since 1.2.0
558 */ 570 */
@@ -768,12 +780,16 @@ ecore_x_randr_crtc_geometry_get(Ecore_X_Window root,
768} 780}
769 781
770/* 782/*
771 * @brief sets the position of given CRTC within root window's screen 783 * @brief Sets the position of given CRTC within root window's screen.
772 * @param root the window's screen to be queried 784 *
773 * @param crtc the CRTC which's position within the mentioned screen is to be altered 785 * @param root The window's screen to be queried.
774 * @param x position on the x-axis (0 == left) of the screen. if x < 0 current value will be kept. 786 * @param crtc The CRTC which's position within the mentioned screen is to be
775 * @param y position on the y-ayis (0 == top) of the screen. if y < 0, current value will be kept. 787 * altered.
776 * @return EINA_TRUE if position could be successfully be altered. 788 * @param x Position on the x-axis (0 == left) of the screen. if x < 0 current
789 * value will be kept.
790 * @param y Position on the y-ayis (0 == top) of the screen. if y < 0, current
791 * value will be kept.
792 * @return @c EINA_TRUE if position could successfully be altered.
777 */ 793 */
778EAPI Eina_Bool 794EAPI Eina_Bool
779ecore_x_randr_crtc_pos_set(Ecore_X_Window root, 795ecore_x_randr_crtc_pos_set(Ecore_X_Window root,
@@ -858,16 +874,18 @@ ecore_x_randr_crtc_mode_get(Ecore_X_Window root,
858} 874}
859 875
860/** 876/**
861 * @brief sets a mode for a CRTC and the outputs attached to it 877 * @brief Sets a mode for a CRTC and the outputs attached to it.
862 * @param root the window's screen to be queried 878 *
863 * @param crtc the CRTC which shall be set 879 * @param root The window's screen to be queried.
864 * @param outputs array of outputs which have to be compatible with the mode. If 880 * @param crtc The CRTC which shall be set.
865 * NULL CRTC will be disabled. 881 * @param outputs Array of outputs which have to be compatible with the mode.
866 * @param noutputs number of outputs in array to be used. Use 882 * If @c NULL, CRTC will be disabled.
867 * Ecore_X_Randr_Unset (or -1) to use currently used outputs. 883 * @param noutputs Number of outputs in array to be used. Use
868 * @param mode XID of the mode to be set. If set to 0 the CRTC will be disabled. 884 * Ecore_X_Randr_Unset (or @c -1) to use currently used outputs.
869 * If set to -1 the call will fail. 885 * @param mode XID of the mode to be set. If set to @c 0 the CRTC will be
870 * @return EINA_TRUE if mode setting was successful. Else EINA_FALSE 886 * disabled. If set to @c -1 the call will fail.
887 * @return @c EINA_TRUE if mode setting was successful, @c EINA_FALSE
888 * otherwise.
871 */ 889 */
872EAPI Eina_Bool 890EAPI Eina_Bool
873ecore_x_randr_crtc_mode_set(Ecore_X_Window root, 891ecore_x_randr_crtc_mode_set(Ecore_X_Window root,
@@ -1097,24 +1115,26 @@ ecore_x_randr_crtc_clone_set(Ecore_X_Window root,
1097} 1115}
1098 1116
1099/** 1117/**
1100 * @brief sets the demanded parameters for a given CRTC. Note that the CRTC is 1118 * @brief Sets the demanded parameters for a given CRTC. Note that the CRTC is
1101 * auto enabled in it's preferred mode, when it was disabled before. 1119 * auto enabled in it's preferred mode, when it was disabled before.
1102 * @param root the root window which's default display will be queried 1120 *
1103 * @param crtc the CRTC which's configuration should be altered 1121 * @param root The root window which's default display will be queried.
1104 * @param outputs an array of outputs, that should display this CRTC's content. 1122 * @param crtc The CRTC which's configuration should be altered.
1105 * @param noutputs number of outputs in the array of outputs. 1123 * @param outputs An array of outputs, that should display this CRTC's content.
1106 * If set to Ecore_X_Randr_Unset, current outputs and number of outputs will be used. 1124 * @param noutputs Number of outputs in the array of outputs. If set to
1107 * If set to Ecore_X_Randr_None, CRTC will be disabled 1125 * Ecore_X_Randr_Unset, current outputs and number of outputs will be used.
1108 * @param x new x coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current x 1126 * If set to Ecore_X_Randr_None, CRTC will be disabled.
1127 * @param x New x coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current x
1109 * corrdinate will be assumed. 1128 * corrdinate will be assumed.
1110 * @param y new y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y 1129 * @param y New y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y
1111 * corrdinate will be assumed. 1130 * corrdinate will be assumed.
1112 * @param mode the new mode to be set. If Ecore_X_Randr_None is passed, the 1131 * @param mode The new mode to be set. If Ecore_X_Randr_None is passed, the
1113 * CRTC will be disabled. If Ecore_X_Randr_Unset is passed, the current mode is assumed. 1132 * CRTC will be disabled. If Ecore_X_Randr_Unset is passed, the current mode is
1114 * @param orientation the new orientation to be set. If Ecore_X_Randr_Unset is used, 1133 * assumed.
1115 * the current mode is assumed. 1134 * @param orientation The new orientation to be set. If Ecore_X_Randr_Unset is
1116 * @return EINA_TRUE if the configuration alteration was successful, else 1135 * used, the current mode is assumed.
1117 * EINA_FALSE 1136 * @return @c EINA_TRUE if the configuration alteration was successful,
1137 * @c EINA_FALSE otherwise.
1118 */ 1138 */
1119EAPI Eina_Bool 1139EAPI Eina_Bool
1120ecore_x_randr_crtc_settings_set(Ecore_X_Window root, 1140ecore_x_randr_crtc_settings_set(Ecore_X_Window root,
@@ -1180,14 +1200,16 @@ ecore_x_randr_crtc_settings_set(Ecore_X_Window root,
1180} 1200}
1181 1201
1182/** 1202/**
1183 * @brief sets a CRTC relative to another one. 1203 * @brief Sets a CRTC relative to another one.
1184 * @param crtc_r1 the CRTC to be positioned. 1204 *
1185 * @param crtc_r2 the CRTC the position should be relative to 1205 * @param crtc_r1 The CRTC to be positioned.
1186 * @param policy the relation between the crtcs 1206 * @param crtc_r2 The CRTC the position should be relative to.
1187 * @param alignment in case CRTCs size differ, aligns CRTC1 accordingly at CRTC2's 1207 * @param policy The relation between the crtcs.
1188 * borders 1208 * @param alignment In case CRTCs size differ, aligns CRTC1 accordingly at
1189 * @return EINA_TRUE if crtc could be successfully positioned. EINA_FALSE if 1209 * CRTC2's borders.
1190 * repositioning failed or if position of new crtc would be out of given screen's min/max bounds. 1210 * @return @c EINA_TRUE if crtc could be successfully positioned, @c EINA_FALSE
1211 * if repositioning failed or if position of new crtc would be out of given
1212 * screen's min/max bounds.
1191 */ 1213 */
1192EAPI Eina_Bool 1214EAPI Eina_Bool
1193ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root, 1215ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root,
@@ -1484,12 +1506,14 @@ ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root,
1484} 1506}
1485 1507
1486/* 1508/*
1487 * @brief add given mode to given output 1509 * @brief Add given mode to given output.
1488 * @param output the output the mode is added to 1510 *
1489 * @param mode the mode added to the output 1511 * @param output The output the mode is added to.
1490 * @return EINA_FALSE if output or mode equal Ecore_X_Randr_None, else EINA_TRUE 1512 * @param mode The mode added to the output.
1491 * Additionally, if xcb backend is used, the success of the addition is reported 1513 * @return @c EINA_FALSE if output or mode equal Ecore_X_Randr_None, else
1492 * back directly. 1514 * @c EINA_TRUE.
1515 * Additionally, if xcb backend is used, the success of the addition is
1516 * reported back directly.
1493 * @since 1.2.0 1517 * @since 1.2.0
1494 */ 1518 */
1495EAPI Eina_Bool 1519EAPI Eina_Bool
@@ -1917,13 +1941,16 @@ ecore_x_randr_move_all_crtcs_but(Ecore_X_Window root,
1917} 1941}
1918 1942
1919/* 1943/*
1920 * @brief move given CRTCs belonging to the given root window's screen dx/dy pixels relative to their current position. The screen size will be automatically adjusted if necessary and possible. 1944 * @brief Move given CRTCs belonging to the given root window's screen dx/dy
1921 * @param root window which's screen's resources are used 1945 * pixels relative to their current position. The screen size will be
1922 * @param crtcs list of CRTCs to be moved 1946 * automatically adjusted if necessary and possible.
1923 * @param ncrtc number of CRTCs in array 1947 *
1924 * @param dx amount of pixels the CRTCs should be moved in x direction 1948 * @param root Window which's screen's resources are used.
1925 * @param dy amount of pixels the CRTCs should be moved in y direction 1949 * @param crtcs List of CRTCs to be moved.
1926 * @return EINA_TRUE if all crtcs could be moved successfully. 1950 * @param ncrtc Number of CRTCs in array.
1951 * @param dx Amount of pixels the CRTCs should be moved in x direction.
1952 * @param dy Amount of pixels the CRTCs should be moved in y direction.
1953 * @return @c EINA_TRUE if all crtcs could be moved successfully.
1927 */ 1954 */
1928EAPI Eina_Bool 1955EAPI Eina_Bool
1929ecore_x_randr_move_crtcs(Ecore_X_Window root, 1956ecore_x_randr_move_crtcs(Ecore_X_Window root,
@@ -2088,9 +2115,10 @@ ecore_x_randr_screen_reset(Ecore_X_Window root)
2088} 2115}
2089 2116
2090/** 2117/**
2091 * @brief set up the backlight level to the given level. 2118 * @brief Set up the backlight level to the given level.
2092 * @param root the window's screen which will be set. 2119 *
2093 * @param level of the backlight between 0 and 1 2120 * @param root The window's screen which will be set.
2121 * @param level Of the backlight between @c 0 and @c 1.
2094 */ 2122 */
2095 2123
2096EAPI void 2124EAPI void
@@ -2137,8 +2165,8 @@ ecore_x_randr_screen_backlight_level_set(Ecore_X_Window root,
2137} 2165}
2138 2166
2139/* 2167/*
2140 * @brief check if a backlight is available 2168 * @brief Check if a backlight is available.
2141 * @return whether a blacklight is available 2169 * @return Whether a backlight is available.
2142 */ 2170 */
2143 2171
2144EAPI Eina_Bool 2172EAPI Eina_Bool
@@ -2157,10 +2185,11 @@ ecore_x_randr_output_backlight_available(void)
2157} 2185}
2158 2186
2159/* 2187/*
2160 * @brief get the backlight level of the given output 2188 * @brief Get the backlight level of the given output.
2161 * @param root window which's screen should be queried 2189 *
2162 * @param output from which the backlight level should be retrieved 2190 * @param root Window which's screen should be queried.
2163 * @return the backlight level 2191 * @param output From which the backlight level should be retrieved.
2192 * @return The backlight level.
2164 */ 2193 */
2165 2194
2166EAPI double 2195EAPI double
@@ -2229,11 +2258,12 @@ ecore_x_randr_output_backlight_level_get(Ecore_X_Window root,
2229} 2258}
2230 2259
2231/* 2260/*
2232 * @brief set the backlight level of a given output 2261 * @brief Set the backlight level of a given output.
2233 * @param root window which's screen should be queried 2262 *
2234 * @param output that should be set 2263 * @param root Window which's screen should be queried.
2235 * @param level for which the backlight should be set 2264 * @param output That should be set.
2236 * @return EINA_TRUE in case of success 2265 * @param level For which the backlight should be set.
2266 * @return @c EINA_TRUE in case of success.
2237 */ 2267 */
2238 2268
2239EAPI Eina_Bool 2269EAPI Eina_Bool
@@ -2290,11 +2320,12 @@ ecore_x_randr_output_backlight_level_set(Ecore_X_Window root,
2290} 2320}
2291 2321
2292/* 2322/*
2293 * @brief get the outputs, which display a certain window 2323 * @brief Get the outputs, which display a certain window.
2294 * @param window window the displaying outputs shall be found for 2324 *
2295 * @param num the number of outputs displaying the window 2325 * @param window Window the displaying outputs shall be found for
2296 * @return array of outputs that display a certain window. NULL if no outputs 2326 * @param num The number of outputs displaying the window
2297 * was found that displays the specified window. 2327 * @return Array of outputs that display a certain window. @c NULL if no
2328 * outputs was found that displays the specified window.
2298 */ 2329 */
2299 2330
2300EAPI Ecore_X_Randr_Output * 2331EAPI Ecore_X_Randr_Output *
@@ -2344,11 +2375,12 @@ _ecore_x_randr_current_output_get_fail:
2344 2375
2345/* 2376/*
2346 * @deprecated bad naming. Use ecore_x_randr_window_outputs_get instead. 2377 * @deprecated bad naming. Use ecore_x_randr_window_outputs_get instead.
2347 * @brief get the outputs, which display a certain window 2378 * @brief Get the outputs, which display a certain window.
2348 * @param window window the displaying outputs shall be found for 2379 *
2349 * @param num the number of outputs displaying the window 2380 * @param window Window the displaying outputs shall be found for.
2350 * @return array of outputs that display a certain window. NULL if no outputs 2381 * @param num The number of outputs displaying the window.
2351 * was found that displays the specified window. 2382 * @return Array of outputs that display a certain window. @c NULL if no
2383 * outputs was found that displays the specified window.
2352 */ 2384 */
2353 2385
2354EAPI Ecore_X_Randr_Output * 2386EAPI Ecore_X_Randr_Output *