kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

From: Jérôme Pinot <ngc891@gmail.com> 

Subject: [E-devel] [patch] ecore doxygen doc (2)
Date: Thu, 12 Apr 2012 12:46:04 +0900

Hi,

This is a big patch. It fixes:
- undef #EINA_{TRUE,FALSE} links
- @c for NULL and EINA_{TRUE,FALSE}
- some formatting/spello
- several missing return types


SVN revision: 70117
This commit is contained in:
Jérôme Pinot 2012-04-12 03:51:36 +00:00 committed by Mike Blumenkrantz
parent 369617c161
commit 7d464af0a1
28 changed files with 687 additions and 573 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
legacy/ecore/src/lib/ecore/Ecore.h
View File

@ -680,7 +680,7 @@ struct _Ecore_Event_Signal_Realtime /** Realtime event */
* @param type The type of the event this handler will get called for
* @param func The function to call when the event is found in the queue
* @param data A data pointer to pass to the called function @p func
* @return A new Event handler, or NULL on failure
* @return A new Event handler, or @c NULL on failure.
*
* Add an event handler to the list of handlers. This will, on success, return
* 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_
*
* Delete a specified event handler from the handler list. On success this will
* delete the event handler and return the pointer passed as @p data when the
* handler was added by ecore_event_handler_add(). On failure NULL will be
* handler was added by ecore_event_handler_add(). On failure @c NULL will be
* returned. Once a handler is deleted it will no longer be called.
*/
EAPI void *ecore_event_handler_del(Ecore_Event_Handler *event_handler);
@ -775,23 +775,24 @@ EAPI int ecore_event_type_new(void);
* @param func_filter Function to call on each event
* @param func_end Function to call after the queue has been filtered
* @param data Data to pass to the filter functions
* @return A filter handle on success, NULL otherwise
* @return A filter handle on success, @c NULL otherwise.
*
* Adds a callback to filter events from the event queue. Filters are called on
* the queue just before Event handler processing to try and remove redundant
* events. Just as processing is about to start @a func_start is called and
* passed the @a data pointer, the return value of this functions is passed to
* @a func_filter as loop_data. @a func_filter is also passed @a data and the
* event type and event structure. If this @a func_filter returns #EINA_FALSE,
* the event is removed from the queue, if it returns #EINA_TRUE, the event is
* kept. When processing is finished @p func_end is called and is passed the
* loop_data(returned by @c func_start) and @p data pointer to clean up.
* event type and event structure. If this @a func_filter returns
* @c EINA_FALSE, the event is removed from the queue, if it returns
* @c EINA_TRUE, the event is kept. When processing is finished @p func_end is
* called and is passed the loop_data(returned by @c func_start) and @p data
* pointer to clean up.
*/
EAPI 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);
/**
* @brief Delete an event filter.
* @param ef The event filter handle
* @return The data set for the filter on success, NULL otherwise
* @return The data set for the filter on success, @c NULL otherwise.
*
* Delete a filter that has been added by its @p ef handle.
*/
@ -814,7 +815,7 @@ EAPI int ecore_event_current_type_get(void);
/**
* @brief Return the current event type pointer handled.
* @return The current event pointer being handled if inside a handler callback,
* NULL otherwise
* @c NULL otherwise.
*
* If the program is currently inside an Ecore event handler callback this
* will return the pointer of the current event being processed.
@ -900,7 +901,7 @@ struct _Ecore_Exe_Event_Del /** Process exit event */
{
pid_t pid; /**< The process ID of the process that exited */
int exit_code; /**< The exit code of the process */
Ecore_Exe *exe; /**< The handle to the exited process, or NULL if not found */
Ecore_Exe *exe; /**< The handle to the exited process, or @c NULL if not found */
int exit_signal; /** < The signal that caused the process to exit */
Eina_Bool exited : 1; /** < set to 1 if the process exited of its own accord */
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 */
Ecore_Exe *exe; /**< The handle to the process */
void *data; /**< the raw binary data from the child process that was received */
int size; /**< the size of this data in bytes */
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 */
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 */
};
EAPI 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
/**
* @brief Marks an FD handler for deletion.
* @param fd_handler The FD handler.
* @return The data pointer set using @ref ecore_main_fd_handler_add, for @a
* fd_handler on success, @c NULL otherwise.
* @return The data pointer set using @ref ecore_main_fd_handler_add, for
* @a fd_handler on success, @c NULL otherwise.
* This function marks an fd handler to be deleted during an iteration of the
* main loop. It does NOT close the associated fd!
*
@ -1095,9 +1096,9 @@ EAPI int ecore_main_fd_handler_fd_get(Ecore_Fd_Handler *fd_handler);
/**
* @brief Gets which flags are active on an FD handler.
* @param fd_handler The given FD handler.
* @param flags The flags, @c ECORE_FD_READ, @c ECORE_FD_WRITE or @c
* ECORE_FD_ERROR to query.
* @return #EINA_TRUE if any of the given flags are active, #EINA_FALSE
* @param flags The flags, @c ECORE_FD_READ, @c ECORE_FD_WRITE or
* @c ECORE_FD_ERROR to query.
* @return @c EINA_TRUE if any of the given flags are active, @c EINA_FALSE
* otherwise.
*/
EAPI 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);
* @param data The data to pass to the function
* @return A handle to the new animator
*
* This function adds a animator and returns its handle on success and NULL on
* failure. The function @p func will be called every N seconds where N is the
* @p frametime interval set by ecore_animator_frametime_set(). The function
* will be passed the @p data pointer as its parameter.
* This function adds a animator and returns its handle on success and @c NULL
* on failure. The function @p func will be called every N seconds where N is
* the @p frametime interval set by ecore_animator_frametime_set(). The
* function will be passed the @p data pointer as its parameter.
*
* When the animator @p func is called, it must return a value of either 1 or
* 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_
*
* Delete the specified @p animator from the set of animators that are
* executed during main loop execution. This function returns the data
* parameter that was being passed to the callback on success, or NULL on
* parameter that was being passed to the callback on success, or @c NULL on
* failure. After this call returns the specified animator object @p animator
* is invalid and should not be used again. It will not get called again after
* deletion.
@ -1521,7 +1522,7 @@ EAPI Ecore_Animator_Source ecore_animator_source_get(void);
* to allow the source of ticks to be dynamically enabled or disabled as
* needed, the @p func when set is called to enable the tick source to
* produce tick events that call ecore_animator_custom_tick(). If @p func
* is NULL then no function is called to begin custom ticking.
* is @c NULL then no function is called to begin custom ticking.
*
* @see ecore_animator_source_set()
* @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
* @param data The data passed to the tick end function as its parameter
*
* This function is a matching pair to the function set by
*ecore_animator_custom_source_tick_begin_callback_set() and is called
* when ticking is to stop. If @p func is NULL then no function will be
* ecore_animator_custom_source_tick_begin_callback_set() and is called
* when ticking is to stop. If @p func is @c NULL then no function will be
* called to stop ticking. For more information please see
*ecore_animator_custom_source_tick_begin_callback_set().
* ecore_animator_custom_source_tick_begin_callback_set().
*
* @see ecore_animator_source_set()
* @see ecore_animator_custom_source_tick_begin_callback_set()
@ -1594,8 +1595,8 @@ EAPI double ecore_loop_time_get(void);
* }
* ecore_timer_add(interval_in_seconds, my_func, data_given_to_function);
* @endcode
* @note If the function was to be executed only once simply return EINA_FALSE
* instead.
* @note If the function was to be executed only once simply return
* @c EINA_FALSE instead.
*
* An example that shows the usage of a lot of these:
* @li @ref ecore_timer_example_c
@ -1678,12 +1679,12 @@ typedef struct _Ecore_Idle_Exiter Ecore_Idle_Exiter; /**< A handle for idle exi
* Add an idler handler.
* @param func The function to call when idling.
* @param data The data to be passed to this @p func call.
* @return A idler handle if successfully added. NULL otherwise.
* @return A idler handle if successfully added, @c NULL otherwise.
*
* Add an idler handle to the event loop, returning a handle on
* success and NULL otherwise. The function @p func will be called
* success and @c NULL otherwise. The function @p func will be called
* repeatedly while no other events are ready to be processed, as
* long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0
* long as it returns @c 1 (or ECORE_CALLBACK_RENEW). A return of @c 0
* (or ECORE_CALLBACK_CANCEL) deletes the idler.
*
* 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);
/**
* Delete an idler callback from the list to be executed.
* @param idler The handle of the idler callback to delete
* @return The data pointer passed to the idler callback on success. NULL
* @return The data pointer passed to the idler callback on success, @c NULL
* otherwise.
*/
EAPI void *ecore_idler_del(Ecore_Idler *idler);
@ -1822,7 +1823,7 @@ typedef void (*Ecore_Thread_Notify_Cb)(void *data, Ecore_Thread *thread, void *m
* @param func_cancel Function to call from main loop if the thread running
* @p func_blocking is cancelled or fails to start (may be NULL)
* @param data User context data to pass to all callbacks.
* @return A new thread handler, or NULL on failure
* @return A new thread handler, or @c NULL on failure.
*
* This function will try to create a new thread to run @p func_blocking in,
* 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_
* @p func_heavy is cancelled or fails to start
* @param data User context data to pass to all callback.
* @param try_no_queue If you want to run outside of the thread pool.
* @return A new thread handler, or NULL on failure
* @return A new thread handler, or @c NULL on failure.
*
* See ecore_thread_run() for a general description of this function.
*
@ -1918,26 +1919,26 @@ EAPI Ecore_Thread *ecore_thread_feedback_run(Ecore_Thread_Cb func_heavy, Ecore_T
* Cancel a running thread.
*
* @param thread The thread to cancel.
* @return Will return EINA_TRUE if the thread has been cancelled,
* EINA_FALSE if it is pending.
* @return Will return @c EINA_TRUE if the thread has been cancelled,
* @c EINA_FALSE if it is pending.
*
* This function can be called both in the main loop or in the running thread.
*
* This function cancels a running thread. If @p thread can be immediately
* cancelled (it's still pending execution after creation or rescheduling),
* then the @c cancel callback will be called, @p thread will be freed and
* the function will return EINA_TRUE.
* the function will return @c EINA_TRUE.
*
* If the thread is already running, then this function returns EINA_FALSE
* If the thread is already running, then this function returns @c EINA_FALSE
* after marking the @p thread as pending cancellation. For the thread to
* actually be terminated, it needs to return from the user function back
* into Ecore control. This can happen in several ways:
* @li The function ends and returns normally. If it hadn't been cancelled,
* @c func_end would be called here, but instead @c func_cancel will happen.
* @li The function returns after requesting to be rescheduled with
*ecore_thread_reschedule().
* ecore_thread_reschedule().
* @li The function is prepared to leave early by checking if
*ecore_thread_check() returns EINA_TRUE.
* ecore_thread_check() returns @c EINA_TRUE.
*
* The user function can cancel itself by calling ecore_thread_cancel(), but
* 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
* other way.
*
* @p thread will be freed and should not be used again if this function
* returns EINA_TRUE or after the @c func_cancel callback returns.
* returns @c EINA_TRUE or after the @c func_cancel callback returns.
*
* @see ecore_thread_check()
*/
@ -1954,13 +1955,13 @@ EAPI Eina_Bool ecore_thread_cancel(Ecore_Thread *thread);
* Checks if a thread is pending cancellation
*
* @param thread The thread to test.
* @return EINA_TRUE if the thread is pending cancellation,
* EINA_FALSE if it is not.
* @return @c EINA_TRUE if the thread is pending cancellation,
* @c EINA_FALSE if it is not.
*
* This function can be called both in the main loop or in the running thread.
*
* When ecore_thread_cancel() is called on an already running task, the
* thread is marked as pending cancellation. This function returns EINA_TRUE
* thread is marked as pending cancellation. This function returns @c EINA_TRUE
* if this mark is set for the given @p thread and can be used from the
* main loop thread to check if a still active thread has been cancelled,
* 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);
*
* @param thread The current ::Ecore_Thread context to send data from
* @param msg_data Data to be transmitted to the main loop
* @return EINA_TRUE if @p msg_data was successfully sent to main loop,
* EINA_FALSE if anything goes wrong.
* @return @c EINA_TRUE if @p msg_data was successfully sent to main loop,
* @c EINA_FALSE if anything goes wrong.
*
* You should use this function only in the @c func_heavy call.
*
* Only the address to @p msg_data will be sent and once this function
* returns EINA_TRUE, the job running in the thread should never touch the
* returns @c EINA_TRUE, the job running in the thread should never touch the
* contents of it again. The data sent should be malloc()'ed or something
* similar, as long as it's not memory local to the thread that risks being
* 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)
* Asks for the function in the thread to be called again at a later time
*
* @param thread The current ::Ecore_Thread context to rescheduled
* @return EINA_TRUE if the task was successfully rescheduled,
* EINA_FALSE if anything goes wrong.
* @return @c EINA_TRUE if the task was successfully rescheduled,
* @c EINA_FALSE if anything goes wrong.
*
* This function should be called only from the same function represented
* by @p thread.
@ -2007,7 +2008,7 @@ EAPI Eina_Bool ecore_thread_feedback(Ecore_Thread *thread, const void *msg_data)
* If no other tasks are waiting or there are sufficient threads available,
* the rescheduled task will be launched again immediately.
*
* This should never return EINA_FALSE, unless it was called from the wrong
* This should never return @c EINA_FALSE, unless it was called from the wrong
* thread or with the wrong arguments.
*
* 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);
* through the Ecore_Thread API.
*
* @note Jobs started through the ecore_thread_feedback_run() function with
* the @c try_no_queue parameter set to EINA_TRUE will not be accounted for
* the @c try_no_queue parameter set to @c EINA_TRUE will not be accounted for
* in the return of this function unless the thread creation fails and it
* falls back to using one from the pool.
*/
@ -2120,7 +2121,7 @@ EAPI int ecore_thread_available_get(void);
* @param cb Function to free the data when removed from the hash
* @param direct If true, this will not copy the key string (like
* eina_hash_direct_add())
* @return EINA_TRUE on success, EINA_FALSE on failure
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
*
* Ecore Thread has a mechanism to share data across several worker functions
* 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);
* change the value under a @p key, or you don't know if one exists already,
* you can use ecore_thread_local_data_set().
*
* Neither @p key nor @p value may be NULL and @p key will be copied in the
* Neither @p key nor @p value may be @c NULL and @p key will be copied in the
* hash, unless @p direct is set, in which case the string used should not
* be freed until the data is removed from the hash.
*
@ -2183,7 +2184,7 @@ EAPI int ecore_thread_available_get(void);
* because @p thread was terminated and the hash destroyed. This parameter
* may be NULL, in which case @p value needs to be manually freed after
* removing it from the hash with either ecore_thread_local_data_del() or
*ecore_thread_local_data_set(), but it's very unlikely that this is what
* ecore_thread_local_data_set(), but it's very unlikely that this is what
* you want.
*
* 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
* If the hash already contains something under @p key, the data will be
* replaced by @p value and the old value will be returned.
*
* NULL will also be returned if either @p key or @p value are NULL, or if
* an error occurred.
* @c NULL will also be returned if either @p key or @p value are @c NULL, or
* if an error occurred.
*
* This function, and all of the others in the @c ecore_thread_local_data
* 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
*
* @param thread The thread context the data belongs to
* @param key The name under which the data is stored
* @return The value under the given key, or NULL on error
* @return The value under the given key, or @c NULL on error.
*
* Finds and return the data stored in the shared hash under the key @p key.
*
@ -2248,11 +2249,11 @@ EAPI void *ecore_thread_local_data_find(Ecore_Thread *thread, const char *key);
*
* @param thread The thread context the data belongs to
* @param key The name under which the data is stored
* @return EINA_TRUE on success, EINA_FALSE on failure
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
*
* If there's any data stored associated with @p key in the global hash,
* this function will remove it from it and return EINA_TRUE. If no data
* exists or an error occurs, it returns EINA_FALSE.
* this function will remove it from it and return @c EINA_TRUE. If no data
* exists or an error occurs, it returns @c EINA_FALSE.
*
* If the data was added to the hash with a free function, then it will
* 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
* @param cb Function to free the data when removed from the hash
* @param direct If true, this will not copy the key string (like
* eina_hash_direct_add())
* @return EINA_TRUE on success, EINA_FALSE on failure
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
*
* Ecore Thread keeps a hash that can be used to share data across several
* 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
* change the value under a @p key, or you don't know if one exists already,
* you can use ecore_thread_global_data_set().
*
* Neither @p key nor @p value may be NULL and @p key will be copied in the
* Neither @p key nor @p value may be @c NULL and @p key will be copied in the
* hash, unless @p direct is set, in which case the string used should not
* be freed until the data is removed from the hash.
*
@ -2322,8 +2323,8 @@ EAPI Eina_Bool ecore_thread_global_data_add(const char *key, void *value, Eina_F
* If the hash already contains something under @p key, the data will be
* replaced by @p value and the old value will be returned.
*
* NULL will also be returned if either @p key or @p value are NULL, or if
* an error occurred.
* @c NULL will also be returned if either @p key or @p value are @c NULL, or
* if an error occurred.
*
* @see ecore_thread_global_data_add()
* @see ecore_thread_global_data_del()
@ -2334,7 +2335,7 @@ EAPI void *ecore_thread_global_data_set(const char *key, void *value, Eina_Free_
* Gets data stored in the hash shared by all threads
*
* @param key The name under which the data is stored
* @return The value under the given key, or NULL on error
* @return The value under the given key, or @c NULL on error.
*
* Finds and return the data stored in the shared hash under the key @p key.
*
@ -2351,11 +2352,11 @@ EAPI void *ecore_thread_global_data_find(const char *key);
* Deletes from the shared hash the data corresponding to the given key
*
* @param key The name under which the data is stored
* @return EINA_TRUE on success, EINA_FALSE on failure
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
*
* If there's any data stored associated with @p key in the global hash,
* this function will remove it from it and return EINA_TRUE. If no data
* exists or an error occurs, it returns EINA_FALSE.
* this function will remove it from it and return @c EINA_TRUE. If no data
* exists or an error occurs, it returns @c EINA_FALSE.
*
* If the data was added to the hash with a free function, then it will
* 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);
*
* @param key The name under which the data is stored
* @param seconds The amount of time in seconds to wait for the data.
* @return The value under the given key, or NULL on error
* @return The value under the given key, or @c NULL on error.
*
* Finds and return the data stored in the shared hash under the key @p key.
*
* If there's nothing in the hash under the given @p key, the function
* will block and wait up to @p seconds seconds for some other thread to
* add it with either ecore_thread_global_data_add() or
*ecore_thread_global_data_set(). If after waiting there's still no data
* to get, NULL will be returned.
* ecore_thread_global_data_set(). If after waiting there's still no data
* to get, @c NULL will be returned.
*
* If @p seconds is 0, then no waiting will happen and this function works
* like ecore_thread_global_data_find(). If @p seconds is less than 0, then

4
legacy/ecore/src/lib/ecore/ecore_exe.c
View File

@ -733,7 +733,7 @@ ecore_exe_callback_pre_free_set(Ecore_Exe *exe,
* @param exe The child process to send to
* @param data The data to send
* @param size The size of the data to send, in bytes
* @return EINA_TRUE if successful, EINA_FALSE on failure.
* @return @c EINA_TRUE if successful, @c EINA_FALSE on failure.
*/
EAPI Eina_Bool
ecore_exe_send(Ecore_Exe *exe,
@ -1145,7 +1145,7 @@ ecore_exe_pid_get(const Ecore_Exe *exe)
/**
* Retrieves the command of the given spawned process.
* @param exe Handle to the given spawned process.
* @return The command on success. NULL otherwise. This string is the
* @return The command on success, @c NULL otherwise. This string is the
* pointer to the internal value and must not be modified in
* any way.
*/

17
legacy/ecore/src/lib/ecore/ecore_getopt.c
View File

@ -1674,7 +1674,7 @@ _ecore_getopt_parse_find_long_other(const Ecore_Getopt *parser,
/**
* Check parser for duplicate entries, print them out.
*
* @return EINA_TRUE if there are duplicates, EINA_FALSE otherwise.
* @return @c EINA_TRUE if there are duplicates, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_getopt_parser_has_duplicates(const Ecore_Getopt *parser)
@ -1743,8 +1743,9 @@ _ecore_getopt_find_help(const Ecore_Getopt *parser)
* (others than @c ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES), are expected
* to provide a value in @c def to be used.
*
* The following actions will store 1 on value as a boolean
* (@c value->boolp) if it's not NULL to indicate these actions were executed:
* The following actions will store @c 1 on value as a boolean
* (@c value->boolp) if it's not @c NULL to indicate these actions were
* executed:
* - @c ECORE_GETOPT_ACTION_HELP
* - @c ECORE_GETOPT_ACTION_VERSION
* - @c ECORE_GETOPT_ACTION_COPYRIGHT
@ -1758,7 +1759,7 @@ _ecore_getopt_find_help(const Ecore_Getopt *parser)
* integer and so on.
*
* If parser is in strict mode (see @c Ecore_Getopt->strict), then any
* error will abort parsing and -1 is returned. Otherwise it will try
* error will abort parsing and @c -1 is returned. Otherwise it will try
* to continue as far as possible.
*
* This function may reorder @a argv elements.
@ -1845,7 +1846,7 @@ error:
* Utility to free list and nodes allocated by @a ECORE_GETOPT_ACTION_APPEND.
*
* @param list pointer to list to be freed.
* @return always NULL, so you can easily make your list head NULL.
* @return always @c NULL, so you can easily make your list head @c NULL.
*/
EAPI Eina_List *
ecore_getopt_list_free(Eina_List *list)
@ -1863,7 +1864,7 @@ ecore_getopt_list_free(Eina_List *list)
* @param str Geometry value
* @param storage must be a pointer to @c Eina_Rectangle and will be used to
* store the four values passed in the given string.
* @return EINA_TRUE on success, EINA_FALSE on incorrect geometry value.
* @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect geometry value.
*
* @c callback_data value is ignored, you can safely use @c NULL.
*/
@ -1890,9 +1891,9 @@ ecore_getopt_callback_geometry_parse(const Ecore_Getopt *parser __UNUSED__,
*
* @param str size value
* @param storage must be a pointer to @c Eina_Rectangle and will be used to
* store the two values passed in the given string and 0 in the x and y
* store the two values passed in the given string and @c 0 in the x and y
* fields.
* @return EINA_TRUE on success, EINA_FALSE on incorrect size value.
* @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect size value.
*
* @c callback_data value is ignored, you can safely use @c NULL.
*/

2
legacy/ecore/src/lib/ecore/ecore_pipe.c
View File

@ -373,7 +373,7 @@ ecore_pipe_write_close(Ecore_Pipe *p)
* @param p The Ecore_Pipe object.
* @param buffer The data to write into the pipe.
* @param nbytes The size of the @p buffer in bytes
* @return Returns EINA_TRUE on a successful write, EINA_FALSE on an error
* @return @c EINA_TRUE on a successful write, @c EINA_FALSE on error.
*/
EAPI Eina_Bool
ecore_pipe_write(Ecore_Pipe *p,

48
legacy/ecore/src/lib/ecore_con/Ecore_Con.h
View File

@ -681,8 +681,8 @@ EAPI int ecore_con_shutdown(void);
* @param name IP address or server name to translate.
* @param done_cb Callback to notify when done.
* @param data User data to be given to done_cb.
* @return EINA_TRUE if the request did not fail to be set up, EINA_FALSE if it
* failed.
* @return @c EINA_TRUE if the request did not fail to be set up, @c EINA_FALSE
* if it failed.
*
* This function performs a DNS lookup on the hostname specified by @p name,
* 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,
* Retrieves whether the given server is currently connected.
*
* @param svr The given server.
* @return #EINA_TRUE if the server is connected. #EINA_FALSE otherwise.
* @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ecore_con_server_connected_get(Ecore_Con_Server *svr);
/**
@ -1013,7 +1013,8 @@ EAPI void ecore_con_server_client_limit_set(Ecore_Con_Server *svr,
* @return A pointer to an internal string that contains the IP address of
* the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation.
* This string should not be modified or trusted to stay valid after
* deletion for the @p svr object. If no IP is known NULL is returned.
* deletion for the @p svr object. If no IP is known @c NULL is
* returned.
*/
EAPI const char * ecore_con_server_ip_get(Ecore_Con_Server *svr);
/**
@ -1167,7 +1168,7 @@ EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl);
* the connected client in the form "XXX.YYY.ZZZ.AAA" IP notation.
*
* The returned string should not be modified, freed or trusted to stay valid
* after deletion for the @p cl object. If no IP is known NULL is returned.
* after deletion for the @p cl object. If no IP is known @c NULL is returned.
*/
EAPI const char * ecore_con_client_ip_get(Ecore_Con_Client *cl);
/**
@ -1228,7 +1229,7 @@ EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double
* Returns whether the client is still connected
*
* @param cl The given client.
* @return #EINA_TRUE if connected, else EINA_FALSE
* @return @c EINA_TRUE if connected, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ecore_con_client_connected_get(Ecore_Con_Client *cl);
/**
@ -1361,7 +1362,7 @@ typedef enum _Ecore_Con_Url_Http_Version
* Change the HTTP version used for the request
* @param url_con Connection object through which the request will be sent.
* @param version The version to be used
* @return EINA_TRUE on success, EINA_FALSE on failure to change version
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure to change version.
* @since 1.2
* @see ecore_con_url_pipeline_get()
*/
@ -1388,7 +1389,7 @@ EAPI int ecore_con_url_shutdown(void);
/**
* Enable or disable HTTP 1.1 pipelining.
* @param enable EINA_TRUE will turn it on, EINA_FALSE will disable it.
* @param enable @c EINA_TRUE will turn it on, @c EINA_FALSE will disable it.
*
* Pipelining allows to send one request after another one, without having to
* wait for the reply of the first request. The respective replies are received
@ -1404,7 +1405,7 @@ EAPI int ecore_con_url_shutdown(void);
EAPI void ecore_con_url_pipeline_set(Eina_Bool enable);
/**
* Is HTTP 1.1 pipelining enable ?
* @return EINA_TRUE if it is enable.
* @return @c EINA_TRUE if it is enable.
*
* @see ecore_con_url_pipeline_set()
*/
@ -1416,7 +1417,7 @@ EAPI Eina_Bool ecore_con_url_pipeline_get(void);
* @param url URL that will receive requests. Can be changed using
* ecore_con_url_url_set.
*
* @return NULL on error, a new Ecore_Con_Url on success.
* @return @c NULL on error, a new Ecore_Con_Url on success.
*
* Creates and initializes a new Ecore_Con_Url connection object that can be
* used for sending requests.
@ -1431,7 +1432,7 @@ EAPI Ecore_Con_Url * ecore_con_url_new(const char *url);
* @param url URL that will receive requests
* @param custom_request Custom request (e.g. GET, POST, HEAD, PUT, etc)
*
* @return NULL on error, a new Ecore_Con_Url on success.
* @return @c NULL on error, a new Ecore_Con_Url on success.
*
* Creates and initializes a new Ecore_Con_Url for a custom request (e.g. HEAD,
* 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);
* @param url_con Connection object through which the request will be sent.
* @param url URL that will receive the request
*
* @return EINA_TRUE on success, EINA_FALSE on error.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE on error.
*/
EAPI Eina_Bool ecore_con_url_url_set(Ecore_Con_Url *url_con,
const char *url);
@ -1465,7 +1465,8 @@ EAPI Eina_Bool ecore_con_url_url_set(Ecore_Con_Url *url_con,
* Gets the URL to send the request to.
*
* @param url_con Connection object through which the request will be sent.
* @return URL that will receive the request, NULL on failure. URL is stringshared.
* @return URL that will receive the request, @c NULL on failure. URL is
* stringshared.
* @since 1.1
*/
EAPI 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);
* @param password Password to use in authentication
* @param safe Whether to use "safer" methods (eg, NOT http basic auth)
*
* @return #EINA_TRUE on success, #EINA_FALSE on error.
* @return @c EINA_TRUE on success, @c EINA_FALSE on error.
*
* ATTENTION: requires libcurl >= 7.19.1 to work, otherwise will always return 0.
* @attention Requires libcurl >= 7.19.1 to work, otherwise will always return
* @c 0.
*/
EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con,
const char *username,
@ -1591,7 +1593,7 @@ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con,
*
* @param url_con Connection object to perform a request on, previously created
*
* @return #EINA_TRUE on success, #EINA_FALSE on error.
* @return @c EINA_TRUE on success, @c EINA_FALSE on error.
*
* The request is performed immediately, but you need to setup event handlers
* 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);
* @param content_type Content type of the payload (e.g. text/xml). Can be @c
* NULL.
*
* @return #EINA_TRUE on success, #EINA_FALSE on error.
* @return @c EINA_TRUE on success, @c EINA_FALSE on error.
*
* The request starts immediately, but you need to setup event handlers
* 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,
/**
* @brief Uploads a file to an ftp site.
*
* @param url_con The Ecore_Con_Url object to send with
* @param filename The path to the file to send
* @param user The username to log in with
* @param pass The password to log in with
* @param upload_dir The directory to which the file should be uploaded
* @return #EINA_TRUE on success, else #EINA_FALSE.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* Upload @p filename to an ftp server set in @p url_con using @p user
* and @p pass to directory @p upload_dir
*/
@ -1864,7 +1868,7 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con,
* @param url_con Connection object that will use the proxy.
* @param proxy Porxy string or @c NULL to disable
*
* @return #EINA_TRUE on success, #EINA_FALSE on error.
* @return @c EINA_TRUE on success, @c EINA_FALSE on error.
* @since 1.2
*/
EAPI 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
* @param url_con Connection object that will use the proxy.
* @param username Username string.
*
* @return #EINA_TRUE on success, #EINA_FALSE on error.
* @return @c EINA_TRUE on success, @c EINA_FALSE on error.
*
* @see ecore_con_url_proxy_set()
*
@ -1893,7 +1897,7 @@ EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const ch
* @param url_con Connection object that will use the proxy.
* @param password Password string.
*
* @return #EINA_TRUE on success, #EINA_FALSE on error.
* @return @c EINA_TRUE on success, @c EINA_FALSE on error.
*
* @see ecore_con_url_proxy_set()
*

12
legacy/ecore/src/lib/ecore_con/ecore_con_private.h
View File

@ -174,15 +174,15 @@ struct _Ecore_Con_Server
double disconnect_time;
double client_disconnect_time;
const char *ip;
Eina_Bool created : 1; /* EINA_TRUE if server is our listening server */
Eina_Bool connecting : 1; /* EINA_FALSE if just initialized or connected */
Eina_Bool handshaking : 1; /* EINA_TRUE if server is ssl handshaking */
Eina_Bool created : 1; /* @c EINA_TRUE if server is our listening server */
Eina_Bool connecting : 1; /* @c EINA_FALSE if just initialized or connected */
Eina_Bool handshaking : 1; /* @c EINA_TRUE if server is ssl handshaking */
Eina_Bool upgrade : 1; /* STARTTLS queued */
Eina_Bool ssl_prepared : 1;
Eina_Bool use_cert : 1; /* EINA_TRUE if using certificate auth */
Eina_Bool use_cert : 1; /* @c EINA_TRUE if using certificate auth */
Ecore_Con_Ssl_State ssl_state; /* current state of ssl handshake on the server */
Eina_Bool verify : 1; /* EINA_TRUE if certificates will be verified */
Eina_Bool verify_basic : 1; /* EINA_TRUE if certificates will be verified only against the hostname */
Eina_Bool verify : 1; /* @c EINA_TRUE if certificates will be verified */
Eina_Bool verify_basic : 1; /* @c EINA_TRUE if certificates will be verified only against the hostname */
Eina_Bool reject_excess_clients : 1;
Eina_Bool delete_me : 1; /* del event has been queued */
#ifdef _WIN32

14
legacy/ecore/src/lib/ecore_con/ecore_con_ssl.c
View File

@ -654,7 +654,7 @@ ecore_con_ssl_server_verify_name_get(Ecore_Con_Server *svr)
* If there is an error loading the certificate, an error will automatically be logged.
* @param svr The server object
* @param cert The path to the certificate.
* @return EINA_FALSE if the file cannot be loaded, otherwise EINA_TRUE.
* @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
*/
EAPI Eina_Bool
@ -686,7 +686,7 @@ ecore_con_ssl_server_cert_add(Ecore_Con_Server *svr,
* If there is an error loading the CAs, an error will automatically be logged.
* @param svr The server object
* @param ca_file The path to the CA file.
* @return EINA_FALSE if the file cannot be loaded, otherwise EINA_TRUE.
* @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
* @note since 1.2, this function can load directores
*/
@ -719,8 +719,7 @@ ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr,
* If there is an error loading the key, an error will automatically be logged.
* @param svr The server object
* @param key_file The path to the key file.
* @return EINA_FALSE if the file cannot be loaded,
* otherwise EINA_TRUE.
* @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
*/
EAPI Eina_Bool
@ -752,8 +751,7 @@ ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr,
* If there is an error loading the CRL, an error will automatically be logged.
* @param svr The server object
* @param crl_file The path to the CRL file.
* @return EINA_FALSE if the file cannot be loaded,
* otherwise EINA_TRUE.
* @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
*/
EAPI Eina_Bool
@ -785,7 +783,7 @@ ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr,
* The connection should be treated as disconnected until the next event.
* @param svr The server object
* @param ssl_type The SSL connection type (ONLY).
* @return EINA_FALSE if the connection cannot be upgraded, otherwise EINA_TRUE.
* @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE.
* @note This function is NEVER to be used on a server object created with ecore_con_server_add
* @warning Setting a wrong value for @p compl_type WILL mess up your program.
* @since 1.1
@ -824,7 +822,7 @@ ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore_Con_Type ssl_type)
* The connection should be treated as disconnected until the next event.
* @param cl The client object
* @param ssl_type The SSL connection type (ONLY).
* @return EINA_FALSE if the connection cannot be upgraded, otherwise EINA_TRUE.
* @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE.
* @warning Setting a wrong value for @p compl_type WILL mess up your program.
* @since 1.1
*/

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

@ -222,7 +222,7 @@ EAPI void ecore_evas_engines_free(Eina_List *engines);
* @brief Creates a new Ecore_Evas based on engine name and common parameters.
*
* @param engine_name engine name as returned by
* ecore_evas_engines_get() or NULL to use environment variable
* ecore_evas_engines_get() or @c NULL to use environment variable
* ECORE_EVAS_ENGINE, that can be undefined and in this case
* this call will try to find the first working engine.
* @param x horizontal position of window (not supported in all engines)
@ -230,19 +230,20 @@ EAPI void ecore_evas_engines_free(Eina_List *engines);
* @param w width of window
* @param h height of window
* @param extra_options string with extra parameter, dependent on engines
* or NULL. String is usually in the form: 'key1=value1;key2=value2'.
* or @ NULL. String is usually in the form: 'key1=value1;key2=value2'.
* Pay attention that when getting that from shell commands, most
* consider ';' as the command terminator, so you need to escape
* it or use quotes.
*
* @return Ecore_Evas instance or NULL if creation failed.
* @return Ecore_Evas instance or @c NULL if creation failed.
*/
EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options);
/**
* @brief Set whether an Ecore_Evas has an alpha channel or not.
*
* @param ee The Ecore_Evas to shape
* @param alpha EINA_TRUE to enable the alpha channel, EINA_FALSE to disable it
* @param alpha @c EINA_TRUE to enable the alpha channel, @c EINA_FALSE to
* disable it
*
* This function allows you to make an Ecore_Evas translucent using an
* 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);
/**
* @brief Query whether an Ecore_Evas has an alpha channel.
* @param ee The Ecore_Evas to query.
* @return EINA_TRUE if ee has an alpha channel, EINA_FALSE if it does not.
* @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does
* not.
*
* This function returns EINA_TRUE if @p ee has an alpha channel, and EINA_FALSE
* if it does not.
* This function returns @c EINA_TRUE if @p ee has an alpha channel, and
* @c EINA_FALSE if it does not.
*
* @see ecore_evas_alpha_set()
*/
@ -269,8 +271,8 @@ EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee);
* @brief Set whether an Ecore_Evas has an transparent window or not.
*
* @param ee The Ecore_Evas to shape
* @param transparent EINA_TRUE to enable the transparent window, EINA_FALSE to
* disable it
* @param transparent @c EINA_TRUE to enable the transparent window,
* @c EINA_FALSE to disable it
*
* This function sets some translucency options, for more complete support see
* ecore_evas_alpha_set().
@ -284,7 +286,7 @@ EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparen
* @brief Query whether an Ecore_Evas is transparent.
*
* @param ee The Ecore_Evas to query.
* @return EINA_TRUE if ee is transparent, EINA_FALSE if it isn't.
* @return @c EINA_TRUE if ee is transparent, @c EINA_FALSE if it isn't.
*
* @see ecore_evas_transparent_set()
*/
@ -300,7 +302,7 @@ EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee);
*
* This function takes four pointers to (already allocated) ints, and places
* the geometry of @p ee in them. If any of the parameters is not desired you
* may pass NULL on them.
* may pass @c NULL on them.
*
* @code
* int x, y, w, h;
@ -323,11 +325,12 @@ EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, i
* @param h A pointer to an int to place the h size in
*
* This function takes four pointers to (already allocated) ints, and places
* the geometry which @p ee was latest recently requested . If any of the parameters is not desired you
* may pass NULL on them.
* the geometry which @p ee was latest recently requested . If any of the
* parameters is not desired you may pass @c NULL on them.
* This function can represent recently requested geometry.
* ecore_evas_geometry_get function returns the value is updated after engine finished request.
* By comparison, ecore_evas_request_geometry_get returns recently requested value.
* ecore_evas_geometry_get function returns the value is updated after engine
* finished request. By comparison, ecore_evas_request_geometry_get returns
* recently requested value.
*
* @code
* int x, y, w, h;
@ -341,10 +344,10 @@ EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, i
* @brief Set the focus of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param on EINA_TRUE for focus, EINA_FALSE to defocus.
* @param on @c EINA_TRUE for focus, @c EINA_FALSE to defocus.
*
* This function focuses @p ee if @p on is EINA_TRUE, or unfocuses @p ee if @p
* on is EINA_FALSE.
* This function focuses @p ee if @p on is @c EINA_TRUE, or unfocuses @p ee if
* @p on is @c EINA_FALSE.
*
* @warning Support for this depends on the underlying windowing system.
*/
@ -353,7 +356,7 @@ EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on);
* @brief Query whether an Ecore_Evas' window is focused or not.
*
* @param ee The Ecore_Evas to set
* @return EINA_TRUE if @p ee if focused, EINA_FALSE if not.
* @return @c EINA_TRUE if @p ee if focused, @c EINA_FALSE if not.
*
* @see ecore_evas_focus_set()
*/
@ -362,10 +365,10 @@ EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee);
* @brief Iconify or uniconify an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param on EINA_TRUE to iconify, EINA_FALSE to uniconify.
* @param on @c EINA_TRUE to iconify, @c EINA_FALSE to uniconify.
*
* This function iconifies @p ee if @p on is EINA_TRUE, or uniconifies @p ee if
* @p on is EINA_FALSE.
* This function iconifies @p ee if @p on is @c EINA_TRUE, or uniconifies @p ee
* if @p on is @c EINA_FALSE.
*
* @note Iconify and minimize are synonyms.
*
@ -376,7 +379,7 @@ EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on);
* @brief Query whether an Ecore_Evas' window is iconified or not.
*
* @param ee The Ecore_Evas to set
* @return EINA_TRUE if @p ee is iconified, EINA_FALSE if not.
* @return @c EINA_TRUE if @p ee is iconified, @c EINA_FALSE if not.
*
* @note Iconify and minimize are synonyms.
*
@ -387,10 +390,10 @@ EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee);
* @brief Set whether an Ecore_Evas' window is borderless or not.
*
* @param ee The Ecore_Evas
* @param on EINA_TRUE for borderless, EINA_FALSE for bordered.
* @param on @c EINA_TRUE for borderless, @c EINA_FALSE for bordered.
*
* This function makes @p ee borderless if @p on is EINA_TRUE, or bordered if @p
* on is EINA_FALSE.
* This function makes @p ee borderless if @p on is @c EINA_TRUE, or bordered
* if @p on is @c EINA_FALSE.
*
* @warning Support for this depends on the underlying windowing system.
*/
@ -399,7 +402,7 @@ EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on);
* @brief Query whether an Ecore_Evas' window is borderless or not.
*
* @param ee The Ecore_Evas to set
* @return EINA_TRUE if @p ee is borderless, EINA_FALSE if not.
* @return @c EINA_TRUE if @p ee is borderless, @c EINA_FALSE if not.
*
* @see ecore_evas_borderless_set()
*/
@ -408,10 +411,10 @@ EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee);
* @brief Set whether or not an Ecore_Evas' window is fullscreen.
*
* @param ee The Ecore_Evas
* @param on EINA_TRUE fullscreen, EINA_FALSE not.
* @param on @c EINA_TRUE fullscreen, @c EINA_FALSE not.
*
* This function causes @p ee to be fullscreen if @p on is EINA_TRUE,
* or not if @p on is EINA_FALSE.
* This function causes @p ee to be fullscreen if @p on is @c EINA_TRUE, or
* not if @p on is @c EINA_FALSE.
*
* @warning Support for this depends on the underlying windowing system.
*/
@ -420,7 +423,7 @@ EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on);
* @brief Query whether an Ecore_Evas' window is fullscreen or not.
*
* @param ee The Ecore_Evas to set
* @return EINA_TRUE if @p ee is fullscreen, EINA_FALSE if not.
* @return @c EINA_TRUE if @p ee is fullscreen, @c EINA_FALSE if not.
*
* @see ecore_evas_fullscreen_set()
*/
@ -431,7 +434,7 @@ EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee);
* @param ee The Ecore_Evas
* @param ee_group The other group member
*
* If @p ee_group is NULL, @p ee is removed from the group, otherwise it is
* If @p ee_group is @c NULL, @p ee is removed from the group, otherwise it is
* added. Note that if you free the @p ee_group canvas before @p ee, then
* getting the group canvas with ecore_evas_window_group_get() will return
* an invalid handle.
@ -639,10 +642,10 @@ EAPI int ecore_evas_layer_get(const Ecore_Evas *ee);
* @brief Maximize (or unmaximize) an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param on EINA_TRUE to maximize, EINA_FALSE to unmaximize.
* @param on @c EINA_TRUE to maximize, @c EINA_FALSE to unmaximize.
*
* This function maximizes @p ee if @p on is EINA_TRUE, or unmaximizes @p ee
* if @p on is EINA_FALSE.
* This function maximizes @p ee if @p on is @c EINA_TRUE, or unmaximizes @p ee
* if @p on is @c EINA_FALSE.
*
* @warning Support for this depends on the underlying windowing system.
*/
@ -651,7 +654,7 @@ EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on);
* @brief Query whether an Ecore_Evas' window is maximized or not.
*
* @param ee The Ecore_Evas to set
* @return EINA_TRUE if @p ee is maximized, EINA_FALSE if not.
* @return @c EINA_TRUE if @p ee is maximized, @c EINA_FALSE if not.
*
* @see ecore_evas_maximized_set()
*/
@ -823,6 +826,7 @@ EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n,
* @brief Returns a pointer to the underlying window.
*
* @param ee The Ecore_Evas whose window is desired.
* @return A pointer to the underlying window.
*
* @warning Support for this depends on the underlying windowing system.
*/
@ -1166,7 +1170,7 @@ EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
* @brief Return the Ecore_Evas for this Evas
*
* @param e The Evas to get the Ecore_Evas from
* @return The Ecore_Evas that holds this Evas, or NULL if not held by one.
* @return The Ecore_Evas that holds this Evas, or @c NULL if not held by one.
*
* @warning Only use on Evas' created with ecore evas!
*/
@ -1188,7 +1192,7 @@ EAPI void ecore_evas_free(Ecore_Evas *ee);
* This function retrieves user specific data that has been stored within an
* Ecore_Evas structure with ecore_evas_data_set().
*
* @returns NULL on error or no data found, A pointer to the user data on
* @returns @c NULL on error or no data found, A pointer to the user data on
* success.
*
* @see ecore_evas_data_set()
@ -1649,10 +1653,10 @@ EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee);
* @brief Get geometry of screen associated with this Ecore_Evas.
*
* @param ee The Ecore_Evas whose window's to query container screen geometry.
* @param x where to return the horizontal offset value. May be NULL.
* @param y where to return the vertical offset value. May be NULL.
* @param w where to return the width value. May be NULL.
* @param h where to return the height value. May be NULL.
* @param x where to return the horizontal offset value. May be @c NULL.
* @param y where to return the vertical offset value. May be @c NULL.
* @param w where to return the width value. May be @c NULL.
* @param h where to return the height value. May be @c NULL.
*
* @since 1.1
*/
@ -1667,7 +1671,7 @@ EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee);
* @param ee The Ecore_Evas to associate to @a obj
* @param obj The object to associate to @a ee
* @param flags The association flags.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* Association means that operations on one will affect the other, for
* 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,
*
* @param ee The Ecore_Evas to dissociate from @a obj
* @param obj The object to dissociate from @a ee
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj);
/**
* @brief Get the object associated with @p ee
*
* @param ee The Ecore_Evas to get the object from.
* @return The associated object, or NULL if there is no associated object.
* @return The associated object, or @c NULL if there is no associated object.
*/
EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee);
@ -1757,13 +1761,15 @@ EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee);
/**
* Sets the engine to be used by the backing store engine.
*
* @return EINA_TRUE on success, EINA_FALSE if ews is already in use.
* @return @c EINA_TRUE on success, @c EINA_FALSE if ews is already in use.
* @since 1.1
*/
EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options);
/**
* Reconfigure the backing store used.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
* @since 1.1
*/
EAPI 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);
/**
* Return the internal backing store in use.
*
* @return The internal backing store in use.
* @note this will forced it to be created, making future calls to
* ecore_evas_ews_engine_set() void.
*
@ -1782,6 +1789,7 @@ EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void);
/**
* Return the internal backing store in use.
*
* @return The internal backing store in use.
* @note this will forced it to be created, making future calls to
* ecore_evas_ews_engine_set() void.
*
@ -1809,7 +1817,8 @@ EAPI void ecore_evas_ews_background_set(Evas_Object *o);
/**
* Return all Ecore_Evas* created by EWS.
*
* @note do not change the returned list or its contents.
* @return An eina list of Ecore_evases.
e @note Do not change the returned list or its contents.
* @since 1.1
*/
EAPI 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
* This creates a new extn_socket canvas wrapper, with image data array
* @b bound to the ARGB format, 8 bits per pixel.
*
* If creation is successful, an Ecore_Evas handle is returned or NULL if creation
* fails. Also focus, show, hide etc. callbacks
* will also be called if the plug object is shown, or already visible on
* connect, or if it is hidden later, focused or unfocused.
* If creation is successful, an Ecore_Evas handle is returned or @c NULL if
* creation fails. Also focus, show, hide etc. callbacks will also be called
* if the plug object is shown, or already visible on connect, or if it is
* hidden later, focused or unfocused.
*
* This function has to be flowed by ecore_evas_extn_socket_listen(),
* for starting ecore ipc service.
@ -1959,17 +1968,23 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a p
EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h);
/**
* @brief Create a socket to provide the service for external ecore evas socket.
* @brief Create a socket to provide the service for external ecore evas
* socket.
*
* @param ee The Ecore_Evas
* @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail.
* @param svcnum A number (any value, 0 beig the common default) to differentiate multiple instances of services with the same name.
* @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.
* @return EINA_TRUE if creation is successful, EINA_FALSE if it does not.
* @param ee The Ecore_Evas.
* @param svcname The name of the service to be advertised. ensure that it is
* unique (when combined with @p svcnum) otherwise creation may fail.
* @param svcnum A number (any value, @c 0 being the common default) to
* differentiate multiple instances of services with the same name.
* @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.
* @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
* not.
*
* This creates socket specified by @p svcname, @p svcnum and @p svcsys. If creation
* is successful, EINA_TRUE is returned or EINA_FALSE if creation
* fails.
* This creates socket specified by @p svcname, @p svcnum and @p svcsys. If
* creation is successful, @c EINA_TRUE is returned or @c EINA_FALSE if
* creation fails.
*
* @see ecore_evas_extn_socket_new()
* @see ecore_evas_extn_plug_new()
@ -2051,14 +2066,17 @@ EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj);
EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target);
/**
* @brief Connect a external ecore evas plug to service provided by external ecore evas socket
* @brief Connect an external ecore evas plug to service provided by external
* ecore evas socket.
*
* @param obj The Ecore_Evas containing the canvas in which the new image object will live.
* @param obj The Ecore_Evas containing the canvas in which the new image
* object will live.
* @param svcname The service name to connect to set up by the socket.
* @param svcnum The service number to connect to (set up by socket).
* @param svcsys Booleain to set if the service is a system one or not (set up by socket).
* @return EINA_TRUE if creation is successful, EINA_FALSE if it does not.
*
* @param svcsys Boolean to set if the service is a system one or not (set up
* by socket).
* @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
* not.
*
* @see ecore_evas_extn_plug_new()
*

35
legacy/ecore/src/lib/ecore_evas/ecore_evas.c
View File

@ -1350,15 +1350,16 @@ ecore_evas_rotation_get(const Ecore_Evas *ee)
/**
* Set whether an Ecore_Evas is shaped or not.
* @param ee The Ecore_Evas to shape
* @param shaped EINA_TRUE to shape, EINA_FALSE to not
*
* @param ee The Ecore_Evas to shape.
* @param shaped @c EINA_TRUE to shape, @c EINA_FALSE to not.
*
* This function allows one to make an Ecore_Evas shaped to the contents of the
* evas. If @p shaped is EINA_TRUE, @p ee will be transparent in parts of the evas that
* contain no objects. If @p shaped is EINA_FALSE, then @p ee will be rectangular, and
* and parts with no data will show random framebuffer artifacting. For
* non-shaped Ecore_Evases, it is recommend to cover the entire evas with a
* background object.
* evas. If @p shaped is @c EINA_TRUE, @p ee will be transparent in parts of
* the evas that contain no objects. If @p shaped is @c EINA_FALSE, then @p ee
* will be rectangular, and parts with no data will show random framebuffer
* artifacting. For non-shaped Ecore_Evases, it is recommended to cover the
* entire evas with a background object.
*/
EAPI void
ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped)
@ -1375,10 +1376,11 @@ ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped)
/**
* Query whether an Ecore_Evas is shaped or not.
* @param ee The Ecore_Evas to query.
* @return EINA_TRUE if shaped, EINA_FALSE if not.
*
* This function returns EINA_TRUE if @p ee is shaped, and EINA_FALSE if not.
* @param ee The Ecore_Evas to query.
* @return @c EINA_TRUE if shaped, @c EINA_FALSE if not.
*
* This function returns @c EINA_TRUE if @p ee is shaped, and @c EINA_FALSE if not.
*/
EAPI Eina_Bool
ecore_evas_shaped_get(const Ecore_Evas *ee)
@ -1909,11 +1911,12 @@ ecore_evas_borderless_get(const Ecore_Evas *ee)
/**
* Tell the WM whether or not to ignore an Ecore_Evas' window
* @param ee The Ecore_Evas
* @param on EINA_TRUE to ignore, EINA_FALSE to not.
*
* This function causes the window manager to ignore @p ee if @p on is EINA_TRUE,
* or not ignore @p ee if @p on is EINA_FALSE.
* @param ee The Ecore_Evas.
* @param on @c EINA_TRUE to ignore, @c EINA_FALSE to not.
*
* This function causes the window manager to ignore @p ee if @p on is
* @c EINA_TRUE, or not ignore @p ee if @p on is @c EINA_FALSE.
*/
EAPI void
ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on)
@ -1930,9 +1933,9 @@ ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on)
/**
* Query whether an Ecore_Evas' window is overridden or not
* @param ee The Ecore_Evas to set
* @return EINA_TRUE if @p ee is overridden, EINA_FALSE if not.
*
* @param ee The Ecore_Evas to set.
* @return @c EINA_TRUE if @p ee is overridden, @c EINA_FALSE if not.
*/
EAPI Eina_Bool
ecore_evas_override_get(const Ecore_Evas *ee)

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

@ -428,11 +428,12 @@ _ecore_fb_li_device_fd_callback(void *data, Ecore_Fd_Handler *fdh __UNUSED__)
* @brief Set the listen mode for an input device .
*
* @param dev The device to set the mode of.
* @param listen EINA_FALSE to disable listening mode, EINA_TRUE to enable it.
* @param listen @c EINA_FALSE to disable listening mode, @c EINA_TRUE to
* enable it.
*
* This function enables or disables listening on the input device @p
* dev. If @p listen is #EINA_FALSE, listening mode is disabled, if it
* is #EINA_TRUE, it is enabled.
* This function enables or disables listening on the input device @p dev.
* If @p listen is @c EINA_FALSE, listening mode is disabled, if it is
* @c EINA_TRUE, it is enabled.
*/
EAPI void
ecore_fb_input_device_listen(Ecore_Fb_Input_Device *dev, Eina_Bool listen)

87
legacy/ecore/src/lib/ecore_file/ecore_file.c
View File

@ -162,10 +162,10 @@ ecore_file_size(const char *file)
* @brief Check if the given file exists.
*
* @param file The name of the file.
* @return Return EINA_TRUE if the file exists, EINA_FALSE otherwise.
* @return @c EINA_TRUE if the @p file exists, @c EINA_FALSE otherwise.
*
* This function returns EINA_TRUE if @p file exists on local filesystem,
* EINA_FALSE otherwise.
* This function returns @c EINA_TRUE if @p file exists on local filesystem,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_exists(const char *file)
@ -182,11 +182,11 @@ ecore_file_exists(const char *file)
* @brief Check if the given file is a directory.
*
* @param file The name of the file.
* @return Return EINA_TRUE if the file exists and is a directory,
* EINA_FALSE otherwise.
* @return @c EINA_TRUE if the file exists and is a directory, @c EINA_FALSE
* otherwise.
*
* This function returns EINA_TRUE if @p file exists exists and is a
* directory on local filesystem, EINA_FALSE otherwise.
* This function returns @c EINA_TRUE if @p file exists exists and is a
* directory on local filesystem, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_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
* @brief Create a new directory.
*
* @param dir The name of the directory to create
* @return EINA_TRUE on successful creation, EINA_FALSE otherwise.
* @return @c EINA_TRUE on successful creation, @c EINA_FALSE otherwise.
*
* This function creates the directory @p dir with the mode S_IRUSR |
* S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH. On
* success, it returns EINA_TRUE, EINA_FALSE otherwise.
* success, it returns @c EINA_TRUE, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_mkdir(const char *dir)
@ -342,10 +342,10 @@ ecore_file_mksubdirs(const char *base, const char **subdirs)
* @brief Delete the given directory.
*
* @param dir The name of the directory to delete.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function deletes @p dir. It returns EINA_TRUE on success,
* EINA_FALSE otherwise.
* This function deletes @p dir. It returns @c EINA_TRUE on success,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_rmdir(const char *dir)
@ -358,10 +358,10 @@ ecore_file_rmdir(const char *dir)
* @brief Delete the given file.
*
* @param file The name of the file to delete.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function deletes @p file. It returns EINA_TRUE on success,
* EINA_FALSE otherwise.
* This function deletes @p file. It returns @c EINA_TRUE on success,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_unlink(const char *file)
@ -374,10 +374,10 @@ ecore_file_unlink(const char *file)
* @brief Remove the given file or directory.
*
* @param file The name of the file or directory to delete.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function removes @p file. It returns EINA_TRUE on success,
* EINA_FALSE otherwise.
* This function removes @p file. It returns @c EINA_TRUE on success,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_remove(const char *file)
@ -390,11 +390,11 @@ ecore_file_remove(const char *file)
* @brief Delete the given directory and all its contents.
*
* @param dir The name of the directory to delete.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function delete @p dir and all its contents. If @p dir is a
* link only the link is removed. It returns EINA_TRUE on success,
* EINA_FALSE otherwise.
* link only the link is removed. It returns @c EINA_TRUE on success,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_recursive_rm(const char *dir)
@ -462,12 +462,12 @@ _ecore_file_mkpath_if_not_exists(const char *path)
* @brief Create a complete path.
*
* @param path The path to create
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function creates @p path and all the subdirectories it
* contains. The separator is '/' or '\'. If @p path exists, this
* function returns EINA_TRUE immediately. It returns EINA_TRUE on
* success, EINA_FALSE otherwise.
* function returns @c EINA_TRUE immediately. It returns @c EINA_TRUE on
* success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_mkpath(const char *path)
@ -523,12 +523,12 @@ ecore_file_mkpaths(const char **paths)
*
* @param src The name of the source file.
* @param dst The name of the destination file.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function copies @p src to @p dst. If the absolute path name of
* @p src and @p dst can not be computed, or if they are equal, or if
* the copy fails, the function returns EINA_FALSE, otherwise it
* returns EINA_TRUE.
* the copy fails, the function returns @c EINA_FALSE, otherwise it
* returns @c EINA_TRUE.
*/
EAPI Eina_Bool
ecore_file_cp(const char *src, const char *dst)
@ -564,10 +564,10 @@ ecore_file_cp(const char *src, const char *dst)
*
* @param src The name of the source file.
* @param dst The name of the destination file.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function moves @p src to @p dst. It returns EINA_TRUE on
* success, EINA_FALSE otherwise.
* This function moves @p src to @p dst. It returns @c EINA_TRUE on
* success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_mv(const char *src, const char *dst)
@ -638,11 +638,11 @@ FAIL:
*
* @param src The name of the file to link.
* @param dest The name of link.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function create the symbolic link @p dest of @p src. This
* function does not work on Windows. It returns EINA_TRUE on success,
* EINA_FALSE otherwise.
* function does not work on Windows. It returns @c EINA_TRUE on success,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_symlink(const char *src, const char *dest)
@ -727,9 +727,9 @@ ecore_file_dir_get(const char *file)
* @brief Check if the given file can be read.
*
* @param file The name of the file.
* @return EINA_TRUE if the file is readable, EINA_FALSE otherwise.
* @return @c EINA_TRUE if the @p file is readable, @c EINA_FALSE otherwise.
*
* This function returns EINA_TRUE if @p file can be read, EINA_FALSE
* This function returns @c EINA_TRUE if @p file can be read, @c EINA_FALSE
* otherwise.
*/
EAPI Eina_Bool
@ -744,9 +744,9 @@ ecore_file_can_read(const char *file)
* @brief Check if the given file can be written.
*
* @param file The name of the file.
* @return EINA_TRUE if the file is writable, EINA_FALSE otherwise.
* @return @c EINA_TRUE if the @p file is writable, @c EINA_FALSE otherwise.
*
* This function returns EINA_TRUE if @p file can be written, EINA_FALSE
* This function returns @c EINA_TRUE if @p file can be written, @c EINA_FALSE
* otherwise.
*/
EAPI Eina_Bool
@ -761,9 +761,10 @@ ecore_file_can_write(const char *file)
* @brief Check if the given file can be executed.
*
* @param file The name of the file.
* @return EINA_TRUE if the file can be executed, EINA_FALSE otherwise.
* @return @c EINA_TRUE if the @p file can be executed, @c EINA_FALSE
* otherwise.
*
* This function returns EINA_TRUE if @p file can be executed, EINA_FALSE
* This function returns @c EINA_TRUE if @p file can be executed, @c EINA_FALSE
* otherwise.
*/
EAPI Eina_Bool
@ -1042,7 +1043,7 @@ ecore_file_escape_name(const char *filename)
*
* @param path The name of the file.
* @return A newly allocated string with the extension stripped out or
* NULL on errors.
* @c NULL on errors.
*
* This function removes the extension from @p path and returns the
* 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)
* @brief Check if the given directory is empty.
*
* @param dir The name of the directory to check.
* @return 1 if directory is empty, 0 if it has at least one file or
* -1 in case of errors.
* @return @c 1 if directory is empty, @c 0 if it has at least one file or
* @c -1 in case of errors.
*
* This functions checks if @p dir is empty. The '.' and '..' files
* will be ignored. If @p dir is empty, 1 is returned, if it contains
* at least 1 file, 0 is returned. On failure, -1 is returned.
* at least one file, @c 0 is returned. On failure, @c -1 is returned.
*/
EAPI int
ecore_file_dir_is_empty(const char *dir)

14
legacy/ecore/src/lib/ecore_file/ecore_file_download.c
View File

@ -197,13 +197,13 @@ _ecore_file_download(const char *url,
* @param progress_cb A callback called during the download operation.
* @param data User data passed to both callbacks.
* @param job_ret Job used to abort the download.
* @return EINA_TRUE if the download start or EINA_FALSE on failure
* @return @c EINA_TRUE if the download start or @c EINA_FALSE on failure.
*
* This function starts the download of the URL @p url and saves it to
* @p dst. @p url must provide the protocol, including 'http://',
* 'ftp://' or 'file://'. Ecore_File must be compiled with CURL to
* download using http and ftp protocols. If @p dst is ill-formed, or
* if it already exists, the function returns EINA_FALSE. When the
* if it already exists, the function returns @c EINA_FALSE. When the
* download is complete, the callback @p completion_cb is called and
* @p data is passed to it. The @p status parameter of @p completion_cb
* will be filled with the status of the download (200, 404,...). The
@ -215,7 +215,7 @@ _ecore_file_download(const char *url,
* that case @p job_ret can be filled. It can be used with
* ecore_file_download_abort() or ecore_file_download_abort_all() to
* respectively abort one or all download operations. This function returns
* EINA_TRUE if the download starts, EINA_FALSE otherwise.
* @c EINA_TRUE if the download starts, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_file_download(const char *url,
@ -238,7 +238,7 @@ ecore_file_download(const char *url,
* @param data User data passed to both callbacks.
* @param job_ret Job used to abort the download.
* @param headers pointer of header lists.
* @return EINA_TRUE if the download start or EINA_FALSE on failure
* @return @c EINA_TRUE if the download start or @c EINA_FALSE on failure.
*/
EAPI Eina_Bool
ecore_file_download_full(const char *url,
@ -256,10 +256,10 @@ ecore_file_download_full(const char *url,
* @brief Check if the given protocol is available.
*
* @param protocol The protocol to check.
* @return EINA_TRUE if protocol is handled, EINA_FALSE otherwise.
* @return @c EINA_TRUE if protocol is handled, @c EINA_FALSE otherwise.
*
* This function returns EINA_TRUE if @p protocol is supported,
* EINA_FALSE otherwise. @p protocol can be 'http://', 'ftp://' or
* This function returns @c EINA_TRUE if @p protocol is supported,
* @c EINA_FALSE otherwise. @p protocol can be 'http://', 'ftp://' or
* 'file://'. Ecore_FILE must be compiled with CURL to handle http and
* ftp protocols.
*/

13
legacy/ecore/src/lib/ecore_file/ecore_file_path.c
View File

@ -87,12 +87,12 @@ _ecore_file_path_from_env(const char *env)
* @brief Check if the given directory is in PATH.
*
* @param in_dir The name of the directory to search in PATH.
* @return EINA_TRUE if the directory exist in PATH, EINA_FALSE otherwise.
* @return @c EINA_TRUE if the directory exist in PATH, @c EINA_FALSE otherwise.
*
* This function checks if @p in_dir is in the environment variable
* PATH. If @p in_dir is @c NULL, or if PATH is empty, or @p in_dir is
* not in PATH, the function returns EINA_FALSE, otherwise it returns
* EINA_TRUE.
* not in PATH, the function returns @c EINA_FALSE, otherwise it returns
* @c EINA_TRUE.
*/
EAPI Eina_Bool
ecore_file_path_dir_exists(const char *in_dir)
@ -117,13 +117,12 @@ ecore_file_path_dir_exists(const char *in_dir)
* @brief Check if the given application is installed.
*
* @param exe The name of the application
* @return EINA_TRUE if the exe is in PATH and is executable,
* EINA_FALSE otherwise.
*
* @return @c EINA_TRUE if the @p exe is in PATH and is executable,
* @c EINA_FALSE otherwise.
*
* This function checks if @p exe exists in PATH and is executable. If
* @p exe is @c NULL or is not executable, the function returns
* EINA_FALSE, otherwise it returns EINA_TRUE.
* @c EINA_FALSE, otherwise it returns @c EINA_TRUE.
*/
EAPI Eina_Bool
ecore_file_app_installed(const char *exe)

31
legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
View File

@ -294,7 +294,7 @@ ecore_imf_context_del(Ecore_IMF_Context *ctx)
* also be used for purposes internal to the Input Method Context.
*
* @param ctx An #Ecore_IMF_Context.
* @param window The client window. This may be NULL to indicate
* @param window The client window. This may be @c NULL to indicate
* that the previous client window no longer exists.
* @ingroup Ecore_IMF_Context_Group
*/
@ -342,7 +342,7 @@ ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx)
* also be used for purposes internal to the Input Method Context.
*
* @param ctx An #Ecore_IMF_Context.
* @param canvas The client canvas. This may be NULL to indicate
* @param canvas The client canvas. This may be @c NULL to indicate
* that the previous client canvas no longer exists.
* @ingroup Ecore_IMF_Context_Group
*/
@ -660,8 +660,8 @@ ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int
/**
* Set whether the IM context should use the preedit string
* to display feedback. If @c use_preedit is EINA_FALSE (default
* is EINA_TRUE), then the IM context may use some other method to display
* to display feedback. If @c use_preedit is @c EINA_FALSE (default
* is @c EINA_TRUE), then the IM context may use some other method to display
* feedback, such as displaying it in a child of the root window.
*
* @param ctx An #Ecore_IMF_Context.
@ -682,7 +682,8 @@ ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit)
/**
* Set whether the IM context should allow to use the text prediction.
* If @c prediction is EINA_FALSE (default is EINA_TRUE), then the IM context will not display the text prediction window.
* If @p prediction is @c EINA_FALSE (default is @c EINA_TRUE), then the IM
* context will not display the text prediction window.
*
* @param ctx An #Ecore_IMF_Context.
* @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
* Get whether the IM context should allow to use the text prediction.
*
* @param ctx An #Ecore_IMF_Context.
* @return EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE.
* @return @c EINA_TRUE if it allows to use the text prediction, otherwise
* @c EINA_FALSE.
* @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
@ -842,17 +844,17 @@ ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx)
/**
* Allow an Ecore Input Context to internally handle an event.
* If this function returns EINA_TRUE, then no further processing
* If this function returns @c EINA_TRUE, then no further processing
* should be done for this event.
*
* Input methods must be able to accept all types of events (simply
* returning EINA_FALSE if the event was not handled), but there is no
* returning @c EINA_FALSE if the event was not handled), but there is no
* obligation of any events to be submitted to this function.
*
* @param ctx An #Ecore_IMF_Context.
* @param type The type of event defined by #Ecore_IMF_Event_Type.
* @param event The event itself.
* @return EINA_TRUE if the event was handled; otherwise EINA_FALSE.
* @return @c EINA_TRUE if the event was handled; otherwise @c EINA_FALSE.
* @ingroup Ecore_IMF_Context_Group
*
* Example
@ -983,11 +985,12 @@ EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx)
* @param ctx An #Ecore_IMF_Context.
* @param text Location to store a UTF-8 encoded string of text
* holding context around the insertion point.
* If the function returns EINA_TRUE, then you must free
* If the function returns @c EINA_TRUE, then you must free
* the result stored in this location with free().
* @param cursor_pos Location to store the position in characters of
* the insertion cursor within @p text.
* @return EINA_TRUE if surrounding text was provided; otherwise EINA_FALSE.
* @return @c EINA_TRUE if surrounding text was provided; otherwise
* @c EINA_FALSE.
* @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI Eina_Bool
@ -1668,7 +1671,7 @@ ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Ei
* Get whether the return key on the input panel should be disabled or not.
*
* @param ctx An #Ecore_IMF_Context.
* @return EINA_TRUE if it should be disabled
* @return @c EINA_TRUE if it should be disabled.
* @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
@ -1689,7 +1692,7 @@ ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx)
* Set the caps lock mode on the input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @param mode Turn on caps lock on the input panel if EINA_TRUE
* @param mode Turn on caps lock on the input panel if @c EINA_TRUE.
* @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
@ -1713,7 +1716,7 @@ ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bo
* Get the caps lock mode on the input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @return EINA_TRUE if the caps lock is turned on.
* @return @c EINA_TRUE if the caps lock is turned on.
* @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/

5
legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c
View File

@ -504,7 +504,7 @@ ecore_ipc_server_data_get(Ecore_Ipc_Server *svr)
/**
* Retrieves whether the given IPC server is currently connected.
* @param svr The given IPC server.
* @return #EINA_TRUE if the server is connected. #EINA_FALSE otherwise.
* @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise.
* @ingroup Ecore_IPC_Server_Group
*/
EAPI Eina_Bool
@ -971,7 +971,8 @@ ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl)
* @return A pointer to an internal string that contains the IP address of
* the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation.
* This string should not be modified or trusted to stay valid after
* deletion for the @p cl object. If no IP is known NULL is returned.
* deletion for the @p cl object. If no IP is known @c NULL is
* returned.
* @ingroup Ecore_Ipc_Client_Group
*/
EAPI const char *

14
legacy/ecore/src/lib/ecore_win32/ecore_win32_dnd.c
View File

@ -103,12 +103,12 @@ ecore_win32_dnd_shutdown()
*
* @param data The name pf the Drag operation.
* @param size The size of the name.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function start a Drag operation with the name @p data. If
* @p data is @c NULL, EINA_FALSE is returned. if @p size is less than
* 0, it is set to the length (as strlen()) of @p data. On success the
* function returns EINA_TRUE, otherwise it returns EINA_FALSE.
* @p data is @c NULL, @c EINA_FALSE is returned. if @p size is less than
* @c 0, it is set to the length (as strlen()) of @p data. On success the
* function returns @c EINA_TRUE, otherwise it returns @c EINA_FALSE.
*/
EAPI Eina_Bool
ecore_win32_dnd_begin(const char *data,
@ -174,12 +174,12 @@ ecore_win32_dnd_begin(const char *data,
* @param window The destination of the Drop operation.
* @param callback The callback called when the Drop operation
* finishes.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function register a Drop operation on @p window. Once the Drop
* operation finishes, @p callback is called. If @p window is @c NULL,
* the function returns EINA_FALSE. On success, it returns EINA_TRUE,
* otherwise it returns EINA_FALSE.
* the function returns @c EINA_FALSE. On success, it returns @c EINA_TRUE,
* otherwise it returns @c EINA_FALSE.
*/
EAPI Eina_Bool
ecore_win32_dnd_register_drop_target(Ecore_Win32_Window *window,

36
legacy/ecore/src/lib/ecore_win32/ecore_win32_window.c
View File

@ -926,13 +926,13 @@ ecore_win32_window_focus_get(void)
* @brief Iconify or restore the given window.
*
* @param window The window.
* @param on EINA_TRUE to iconify the window, EINA_FALSE to restore it.
* @param on @c EINA_TRUE to iconify the window, @c EINA_FALSE to restore it.
*
* This function iconify or restore @p window. If @p on
* is set to EINA_TRUE, the window will be iconified, if it is set to
* EINA_FALSE, it will be restored. If @p window is @c NULL or if the
* state does not change (like iconifying the window while it is
* already iconified), this function does nothing.
* This function iconify or restore @p window. If @p on is set to @c EINA_TRUE,
* the window will be iconified, if it is set to @c EINA_FALSE, it will be
* restored. If @p window is @c NULL or if the state does not change (like
* iconifying the window while it is already iconified), this function does
* nothing.
*/
EAPI void
ecore_win32_window_iconified_set(Ecore_Win32_Window *window,
@ -954,13 +954,13 @@ ecore_win32_window_iconified_set(Ecore_Win32_Window *window,
* @brief Remove or restore the border of the given window.
*
* @param window The window.
* @param on EINA_TRUE to remove the border, EINA_FALSE to restore it.
* @param on @c EINA_TRUE to remove the border, @c EINA_FALSE to restore it.
*
* This function remove or restore the border of @p window. If @p on
* is set to EINA_TRUE, the window will have no border, if it is set to
* EINA_FALSE, it will have a border. If @p window is @c NULL or if the
* state does not change (like setting to borderless while the window
* has no border), this function does nothing.
* This function remove or restore the border of @p window. If @p on is set to
* @c EINA_TRUE, the window will have no border, if it is set to @c EINA_FALSE,
* it will have a border. If @p window is @c NULL or if the state does not
* change (like setting to borderless while the window has no border), this
* function does nothing.
*/
EAPI void
ecore_win32_window_borderless_set(Ecore_Win32_Window *window,
@ -1030,13 +1030,13 @@ ecore_win32_window_borderless_set(Ecore_Win32_Window *window,
* @brief Set the given window to fullscreen.
*
* @param window The window.
* @param on EINA_TRUE for fullscreen mode, EINA_FALSE for windowed mode.
* @param on @c EINA_TRUE for fullscreen mode, @c EINA_FALSE for windowed mode.
*
* This function set @p window to fullscreen or windowed mode. If @p on
* is set to EINA_TRUE, the window will be fullscreen, if it is set to
* EINA_FALSE, it will be windowed. If @p window is @c NULL or if the
* state does not change (like setting to fullscreen while the window
* is already fullscreen), this function does nothing.
* This function set @p window to fullscreen or windowed mode. If @p on is set
* to @c EINA_TRUE, the window will be fullscreen, if it is set to
* @c EINA_FALSE, it will be windowed. If @p window is @c NULL or if the state
* does not change (like setting to fullscreen while the window is already
* fullscreen), this function does nothing.
*/
EAPI void
ecore_win32_window_fullscreen_set(Ecore_Win32_Window *window,

12
legacy/ecore/src/lib/ecore_wince/ecore_wince_window.c
View File

@ -696,13 +696,13 @@ ecore_wince_window_size_get(Ecore_WinCE_Window *window,
* @brief Set the given window to fullscreen.
*
* @param window The window.
* @param on EINA_TRUE for fullscreen mode, EINA_FALSE for windowed mode.
* @param on @c EINA_TRUE for fullscreen mode, @c EINA_FALSE for windowed mode.
*
* This function set @p window to fullscreen or windowed mode. If @p on
* is set to EINA_TRUE, the window will be fullscreen, if it is set to
* EINA_FALSE, it will be windowed. If @p window is @c NULL or if the
* state does not change (like setting to fullscreen while the window
* is already fullscreen), this function does nothing.
* This function set @p window to fullscreen or windowed mode. If @p on is set
* to @c EINA_TRUE, the window will be fullscreen, if it is set to
* @c EINA_FALSE, it will be windowed. If @p window is @c NULL or if the state
* does not change (like setting to fullscreen while the window is already
* fullscreen), this function does nothing.
*/
EAPI void
ecore_wince_window_fullscreen_set(Ecore_WinCE_Window *window,

48
legacy/ecore/src/lib/ecore_x/Ecore_X.h
View File

@ -2962,9 +2962,9 @@ ecore_x_randr_output_crtc_set(Ecore_X_Window root,
/*
* @brief Validates the header from raw EDID data.
*
* @param edid the edid structure
* @param edid_length length of the edid structure
* @return EINA_TRUE, if the header is valid. Else EINA_FALSE.
* @param edid The edid structure.
* @param edid_length Length of the edid structure.
* @return @c EINA_TRUE, if the header is valid, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_edid_has_valid_header(unsigned char *edid,
@ -2973,9 +2973,9 @@ ecore_x_randr_edid_has_valid_header(unsigned char *edid,
/*
* @brief Checks whether a display's EDID has a valid checksum.
*
* @param edid the edid structure
* @param edid_length length of the edid structure
* @return EINA_TRUE, if the checksum is valid. Else EINA_FALSE.
* @param edid The edid structure.
* @param edid_length Length of the edid structure.
* @return @c EINA_TRUE, if the checksum is valid, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_edid_info_has_valid_checksum(unsigned char *edid,
@ -3080,9 +3080,10 @@ ecore_x_randr_edid_manufacturer_model_get(unsigned char *edid,
/*
* @brief Looks up the DPMS support from raw EDID data.
*
* @param edid the edid structure
* @param edid_length length of the edid structure
* @return EINA_TRUE, if DPMS is supported in some way. Else EINA_FALSE.
* @param edid The edid structure.
* @param edid_length Length of the edid structure.
* @return @c EINA_TRUE, if DPMS is supported in some way, @c EINA_FALSE
* otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_edid_dpms_available_get(unsigned char *edid,
@ -3091,9 +3092,9 @@ ecore_x_randr_edid_dpms_available_get(unsigned char *edid,
/*
* @brief Looks up the DPMS Standby support from raw EDID data.
*
* @param edid the edid structure
* @param edid_length length of the edid structure
* @return EINA_TRUE, if DPMS Standby is supported. Else EINA_FALSE.
* @param edid The edid structure.
* @param edid_length Length of the edid structure.
* @return @c EINA_TRUE, if DPMS Standby is supported, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_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,
/*
* @brief Looks up the DPMS Suspend support from raw EDID data.
*
* @param edid the edid structure
* @param edid_length length of the edid structure
* @return EINA_TRUE, if DPMS Suspend is supported. Else EINA_FALSE.
* @param edid The edid structure.
* @param edid_length Length of the edid structure.
* @return @c EINA_TRUE, if DPMS Suspend is supported, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_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,
/*
* @brief Looks up the DPMS Off support from raw EDID data.
*
* @param edid the edid structure
* @param edid_length length of the edid structure
* @return EINA_TRUE, if DPMS Off is supported. Else EINA_FALSE.
* @param edid The edid structure.
* @param edid_length Length of the edid structure.
* @return @c EINA_TRUE, if DPMS Off is supported, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_edid_dpms_off_available_get(unsigned char *edid,
@ -3157,9 +3158,10 @@ ecore_x_randr_edid_display_colorscheme_get(unsigned char *edid,
/*
* @brief Get the display type from raw EDID data.
*
* @param edid the edid structure
* @param edid_length length of the edid structure
* @return EINA_TRUE, if the display is a digital one. Else EINA_FALSE.
* @param edid The edid structure.
* @param edid_length Length of the edid structure.
* @return @c EINA_TRUE, if the display is a digital one, @c EINA_FALSE
* otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_edid_display_type_digital_get(unsigned char *edid,
@ -3355,8 +3357,8 @@ ecore_x_region_picture_clip_set(Ecore_X_Region region,
* xfixes selection notification request.
*
* This lets you choose which selections you want to get notifications for.
* @param selection the selection atom.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
* @param selection The selection atom.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
* @since 1.1.0
*/
EAPI Eina_Bool

8
legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c
View File

@ -414,7 +414,7 @@ ecore_x_ungrab(void)
* @param d3 The client message data item 4
* @param d4 The client message data item 5
*
* @return EINA_TRUE on success EINA_FALSE otherwise.
* @return @c EINA_TRUE on success @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_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,
* @param win The window the message is sent to.
* @param type The client message type.
* @param data Data to be sent.
* @param len Number of data bytes, max 20.
* @param len Number of data bytes, max @c 20.
*
* @return EINA_TRUE on success EINA_FALSE otherwise.
* @return @c EINA_TRUE on success @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_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)
* base + [(base * percent) / 100]
* where @c base is the bell's base volume as set by XChangeKeyboardControl(3).
*
* @returns EINA_TRUE on success, EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_bell(int percent)

3
legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_composite.c
View File

@ -69,7 +69,8 @@ _ecore_xcb_composite_finalize(void)
/**
* Return whether the Composite Extension is available
*
* @return EINA_TRUE is the Composite Extension is available, EINA_FALSE if not
* @return @c EINA_TRUE is the Composite Extension is available, @c EINA_FALSE
* if not.
*
* @ingroup Ecore_X_Composite_Group
*/

7
legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c
View File

@ -59,8 +59,8 @@ _ecore_xcb_dpms_finalize(void)
* @return @c EINA_TRUE if the DPMS extension is available,
* @c EINA_FALSE otherwise.
*
* Return EINA_TRUE if the X server supports the DPMS Extension version 1.0,
* EINA_FALSE otherwise.
* Return @c EINA_TRUE if the X server supports the DPMS Extension version 1.0,
* @c EINA_FALSE otherwise.
*
* @ingroup Ecore_X_DPMS_Group
*/
@ -194,10 +194,11 @@ ecore_x_dpms_timeouts_get(unsigned int *standby,
/**
* Sets the timeouts. The values are in unit of seconds.
*
* @param standby Amount of time of inactivity before standby mode will be invoked.
* @param suspend Amount of time of inactivity before the screen is placed into suspend mode.
* @param off Amount of time of inactivity before the monitor is shut off.
* @return EINA_TRUE on success, EINA_FALSE on failure.
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
* @ingroup Ecore_X_DPMS_Group
*/
EAPI Eina_Bool

258
legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c
View File

@ -227,8 +227,9 @@ _ecore_xcb_randr_root_to_screen(Ecore_X_Window root)
/* public functions */
/*
* @brief query whether randr is available or not
* @return EINA_TRUE, if extension is available, else EINA_FALSE
* @brief Query whether RandR is available or not.
*
* @return @c EINA_TRUE if extension is available, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_query(void)
@ -305,10 +306,13 @@ ecore_x_randr_screen_primary_output_orientation_get(Ecore_X_Window root)
}
/*
* @brief sets a given screen's primary output's orientation
* @param root window which's screen's primary output will be queried
* @param orientation orientation which should be set for the root window's screen primary output
* @return EINA_TRUE if the primary output's orientation could be successfully altered
* @brief Sets a given screen's primary output's orientation.
*
* @param root Window which's screen's primary output will be queried.
* @param orientation Orientation which should be set for the root window's
* screen primary output.
* @return @c EINA_TRUE if the primary output's orientation could be
* successfully altered.
*/
EAPI Eina_Bool
ecore_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,
}
/*
* @brief sets a given screen's primary output size, but disables all other outputs at the same time
* @param root window which's primary output will be queried
* @param size_index within the list of sizes reported as supported by the root window's screen primary output
* @return EINA_TRUE on success, EINA_FALSE on failure due to e.g. invalid times
* @brief Sets a given screen's primary output size, but disables all other
* outputs at the same time.
*
* @param root Window which's primary output will be queried.
* @param size_index Within the list of sizes reported as supported by the root
* window's screen primary output.
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure due to e.g.
* invalid times.
*/
EAPI Eina_Bool
ecore_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,
}
/*
* @brief sets the current primary output's refresh rate
* @param root window which's primary output will be queried
* @param size_index referencing the size to be set
* @param rate the refresh rate to be set
* @return EINA_TRUE on success else EINA_FALSE
* @brief Sets the current primary output's refresh rate.
*
* @param root Window which's primary output will be queried.
* @param size_index Referencing the size to be set.
* @param rate The refresh rate to be set.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_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
}
/*
* @brief free detailed mode information. The pointer handed in will be set to
* NULL after freeing the memory.
* @param mode_info the mode information that should be freed
* @brief Free detailed mode information. The pointer handed in will be set to
* @c NULL after freeing the memory.
*
* @param mode_info The mode information that should be freed.
*/
EAPI void
ecore_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,
}
/**
* @brief gets the EDID information of an attached output if available.
* @brief Gets the EDID information of an attached output if available.
* Note that this information is not to be compared using ordinary string
* comparison functions, since it includes 0-bytes.
* @param root window this information should be queried from
* @param output the XID of the output
* @param length length of the byte-array. If @c NULL, request will fail.
*
* @param root Window this information should be queried from.
* @param output The XID of the output.
* @param length Length of the byte-array. If @c NULL, request will fail.
* @return EDID information of the output.
*/
EAPI unsigned char *
@ -990,10 +1001,11 @@ ecore_x_randr_output_edid_get(Ecore_X_Window root,
}
/**
* @brief gets the outputs which might be used simultaneously on the same CRTC.
* @param root window that this information should be queried for.
* @param output the output which's clones we concern
* @param num number of possible clones
* @brief Gets the outputs which might be used simultaneously on the same CRTC.
*
* @param root Window that this information should be queried for.
* @param output The output which's clones we concern.
* @param num Number of possible clones.
* @return The existing outputs, @c NULL otherwise.
*/
EAPI Ecore_X_Randr_Output *
@ -1180,24 +1192,26 @@ ecore_x_randr_output_size_mm_get(Ecore_X_Window root, Ecore_X_Randr_Output outpu
}
/**
* @brief sets the demanded parameters for a given CRTC. Note that the CRTC is
* @brief Sets the demanded parameters for a given CRTC. Note that the CRTC is
* auto enabled in it's preferred mode, when it was disabled before.
* @param root the root window which's default display will be queried
* @param crtc the CRTC which's configuration should be altered
* @param outputs an array of outputs, that should display this CRTC's content.
* @param noutputs number of outputs in the array of outputs.
* If set to Ecore_X_Randr_Unset, current outputs and number of outputs will be used.
* If set to Ecore_X_Randr_None, CRTC will be disabled
* @param x new x coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current x
* corrdinate will be assumed.
* @param y new y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y
* corrdinate will be assumed.
* @param mode the new mode to be set. If Ecore_X_Randr_None is passed, the
* CRTC will be disabled. If Ecore_X_Randr_Unset is passed, the current mode is assumed.
* @param orientation the new orientation to be set. If Ecore_X_Randr_Unset is used,
* the current mode is assumed.
* @return EINA_TRUE if the configuration alteration was successful, else
* EINA_FALSE
*
* @param root The root window which's default display will be queried.
* @param crtc The CRTC which's configuration should be altered.
* @param outputs An array of outputs, that should display this CRTC's content.
* @param noutputs Number of outputs in the array of outputs. If set to
* Ecore_X_Randr_Unset, current outputs and number of outputs will be used. If
* set to Ecore_X_Randr_None, CRTC will be disabled.
* @param x New x coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current x
* coordinate will be assumed.
* @param y New y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y
* coordinate will be assumed.
* @param mode The new mode to be set. If Ecore_X_Randr_None is passed, the
* CRTC will be disabled. If Ecore_X_Randr_Unset is passed, the current mode is
* assumed.
* @param orientation The new orientation to be set. If Ecore_X_Randr_Unset is
* used, the current mode is assumed.
* @return @c EINA_TRUE if the configuration alteration was successful,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_crtc_settings_set(Ecore_X_Window root,
@ -1276,16 +1290,18 @@ ecore_x_randr_crtc_settings_set(Ecore_X_Window root,
}
/**
* @brief sets a mode for a CRTC and the outputs attached to it
* @param root the window's screen to be queried
* @param crtc the CRTC which shall be set
* @param outputs array of outputs which have to be compatible with the mode. If
* NULL CRTC will be disabled.
* @param noutputs number of outputs in array to be used. Use
* Ecore_X_Randr_Unset (or -1) to use currently used outputs.
* @param mode XID of the mode to be set. If set to 0 the CRTC will be disabled.
* If set to -1 the call will fail.
* @return EINA_TRUE if mode setting was successful. Else EINA_FALSE
* @brief Sets a mode for a CRTC and the outputs attached to it.
*
* @param root The window's screen to be queried
* @param crtc The CRTC which shall be set
* @param outputs Array of outputs which have to be compatible with the mode. If
* @c NULL CRTC will be disabled.
* @param num Number of outputs in array to be used. Use
* Ecore_X_Randr_Unset (or @c -1) to use currently used outputs.
* @param mode XID of the mode to be set. If set to @c 0 the CRTC will be
* disabled. If set to @c -1 the call will fail.
* @return @c EINA_TRUE if mode setting was successful, @c EINA_FALSE
* otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_crtc_mode_set(Ecore_X_Window root,
@ -1562,10 +1578,11 @@ ecore_x_randr_crtcs_get(Ecore_X_Window root,
/*
* @deprecated bad naming. Use ecore_x_randr_window_crtcs_get instead.
* @brief get the CRTCs, which display a certain window
* @param window window the displaying CRTCs shall be found for
* @param num the number of CRTCs displaying the window
* @return array of CRTCs that display a certain window. NULL if no CRTCs
* @brief Get the CRTCs, which display a certain window.
*
* @param window Window the displaying CRTCs shall be found for.
* @param num The number of CRTCs displaying the window.
* @return Array of CRTCs that display a certain window. @c NULL if no CRTCs
* was found that displays the specified window.
*/
EAPI Ecore_X_Randr_Crtc *
@ -1576,10 +1593,11 @@ ecore_x_randr_current_crtc_get(Ecore_X_Window window,
}
/*
* @brief get the CRTCs, which display a certain window
* @param window window the displaying crtcs shall be found for
* @param num the number of crtcs displaying the window
* @return array of crtcs that display a certain window. NULL if no crtcs
* @brief Get the CRTCs, which display a certain window.
*
* @param window Window the displaying crtcs shall be found for.
* @param num The number of crtcs displaying the window.
* @return Array of crtcs that display a certain window. @c NULL if no crtcs
* was found that displays the specified window.
* @since 1.2.0
*/
@ -1730,14 +1748,16 @@ ecore_x_randr_crtc_geometry_get(Ecore_X_Window root,
}
/**
* @brief sets a CRTC relative to another one.
* @param crtc1 the CRTC to be positioned.
* @param crtc2 the CRTC the position should be relative to
* @param policy the relation between the crtcs
* @param alignment in case CRTCs size differ, aligns CRTC1 accordingly at CRTC2's
* borders
* @return EINA_TRUE if crtc could be successfully positioned. EINA_FALSE if
* repositioning failed or if position of new crtc would be out of given screen's min/max bounds.
* @brief Sets a CRTC relative to another one.
*
* @param crtc1 The CRTC to be positioned.
* @param crtc2 The CRTC the position should be relative to.
* @param policy The relation between the crtcs.
* @param alignment In case CRTCs size differ, aligns CRTC1 accordingly at
* CRTC2's borders.
* @return @c EINA_TRUE if crtc could be successfully positioned, @c EINA_FALSE
* if repositioning failed or if position of new crtc would be out of given
* screen's min/max bounds.
*/
EAPI Eina_Bool
ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root,
@ -1888,12 +1908,16 @@ ecore_x_randr_crtc_pos_get(Ecore_X_Window root,
}
/*
* @brief sets the position of given CRTC within root window's screen
* @param root the window's screen to be queried
* @param crtc the CRTC which's position within the mentioned screen is to be altered
* @param x position on the x-axis (0 == left) of the screen. if x < 0 current value will be kept.
* @param y position on the y-ayis (0 == top) of the screen. if y < 0, current value will be kept.
* @return EINA_TRUE if position could be successfully be altered.
* @brief Sets the position of given CRTC within root window's screen.
*
* @param root The window's screen to be queried.
* @param crtc The CRTC which's position within the mentioned screen is to be
* altered.
* @param x Position on the x-axis (0 == left) of the screen. if x < 0 current
* value will be kept.
* @param y Position on the y-ayis (0 == top) of the screen. if y < 0, current
* value will be kept.
* @return @c EINA_TRUE if position could be successfully be altered.
*/
EAPI Eina_Bool
ecore_x_randr_crtc_pos_set(Ecore_X_Window root,
@ -2031,13 +2055,16 @@ ecore_x_randr_crtc_refresh_rate_get(Ecore_X_Window root,
}
/*
* @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.
* @param root window which's screen's resources are used
* @param crtcs list of CRTCs to be moved
* @param ncrtc number of CRTCs in array
* @param dx amount of pixels the CRTCs should be moved in x direction
* @param dy amount of pixels the CRTCs should be moved in y direction
* @return EINA_TRUE if all crtcs could be moved successfully.
* @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.
*
* @param root Window which's screen's resources are used.
* @param crtcs List of CRTCs to be moved.
* @param ncrtc Number of CRTCs in array.
* @param dx Amount of pixels the CRTCs should be moved in x direction.
* @param dy Amount of pixels the CRTCs should be moved in y direction.
* @return @c EINA_TRUE if all crtcs could be moved successfully.
*/
EAPI Eina_Bool
ecore_x_randr_move_crtcs(Ecore_X_Window root,
@ -2319,13 +2346,18 @@ ecore_x_randr_screen_current_size_get(Ecore_X_Window root,
}
/*
* @param root window which's screen's size should be set. If invalid (e.g. NULL) no action is taken.
* @param w width in px the screen should be set to. If out of valid boundaries, current value is assumed.
* @param h height in px the screen should be set to. If out of valid boundaries, current value is assumed.
* @param w_mm width in mm the screen should be set to. If 0, current aspect is assumed.
* @param h_mm height in mm the screen should be set to. If 0, current aspect is assumed.
* @return EINA_TRUE if request was successfully sent or screen is already in
* requested size, EINA_FALSE if parameters are invalid
* @param root Window which's screen's size should be set. If invalid (e.g.
* @c NULL) no action is taken.
* @param w Width in px the screen should be set to. If out of valid
* boundaries, current value is assumed.
* @param h Height in px the screen should be set to. If out of valid
* boundaries, current value is assumed.
* @param w_mm Width in mm the screen should be set to. If @c 0, current
* aspect is assumed.
* @param h_mm Height in mm the screen should be set to. If @c 0, current
* aspect is assumed.
* @return @c EINA_TRUE if request was successfully sent or screen is already
* in requested size, @c EINA_FALSE if parameters are invalid.
*/
EAPI Eina_Bool
ecore_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,
/*
* @deprecated bad naming. Use ecore_x_randr_window_outputs_get instead.
* @brief get the outputs, which display a certain window
* @param window window the displaying outputs shall be found for
* @param num the number of outputs displaying the window
* @return array of outputs that display a certain window. NULL if no outputs
* was found that displays the specified window.
* @brief Get the outputs, which display a certain window.
*
* @param window Window the displaying outputs shall be found for.
* @param num The number of outputs displaying the window.
* @return Array of outputs that display a certain window. @c NULL if no
* outputs was found that displays the specified window.
*/
Ecore_X_Randr_Output *
@ -2391,11 +2424,12 @@ ecore_x_randr_current_output_get(Ecore_X_Window window,
}
/*
* @brief get the outputs, which display a certain window
* @param window window the displaying outputs shall be found for
* @param num the number of outputs displaying the window
* @return array of outputs that display a certain window. NULL if no outputs
* was found that displays the specified window.
* @brief Get the outputs, which display a certain window.
*
* @param window Window the displaying outputs shall be found for.
* @param num The number of outputs displaying the window.
* @return Array of outputs that display a certain window. @c NULL if no
* outputs was found that displays the specified window.
*/
EAPI Ecore_X_Randr_Output *
ecore_x_randr_window_outputs_get(Ecore_X_Window window,
@ -2550,11 +2584,12 @@ ecore_x_randr_output_backlight_level_get(Ecore_X_Window root,
}
/*
* @brief set the backlight level of a given output
* @param root window which's screen should be queried
* @param output that should be set
* @param level for which the backlight should be set
* @return EINA_TRUE in case of success
* @brief Set the backlight level of a given output.
*
* @param root Window which's screen should be queried.
* @param output That should be set.
* @param level For which the backlight should be set.
* @return @c EINA_TRUE in case of success.
*/
EAPI Eina_Bool
ecore_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,
}
/*
* @brief check if a backlight is available
* @return whether a blacklight is available
* @brief Check if a backlight is available.
*
* @return Whether a backlight is available.
*/
EAPI Eina_Bool
ecore_x_randr_output_backlight_available(void)
@ -2802,10 +2838,12 @@ _ecore_xcb_randr_output_validate(Ecore_X_Window root,
}
/**
* @brief validates a CRTC for a given root window's screen.
* @param root the window which's default display will be queried
* @param crtc the CRTC to be validated.
* @return in case it is found EINA_TRUE will be returned. Else EINA_FALSE is returned.
* @brief Validates a CRTC for a given root window's screen.
*
* @param root The window which's default display will be queried.
* @param crtc The CRTC to be validated.
* @return In case it is found @c EINA_TRUE will be returned, else
* @c EINA_FALSE is returned.
*/
static Eina_Bool
_ecore_xcb_randr_crtc_validate(Ecore_X_Window root,

8
legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c
View File

@ -977,7 +977,7 @@ ecore_x_dpi_get(void)
* base + [(base * percent) / 100]
* where @c base is the bell's base volume as set by XChangeKeyboardControl(3).
*
* @returns EINA_TRUE on success, EINA_FALSE otherwise.
* @returns @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_bell(int percent)
@ -1808,7 +1808,7 @@ ecore_x_window_key_ungrab(Ecore_X_Window win,
* @param d3 The client message data item 4
* @param d4 The client message data item 5
*
* @return EINA_TRUE on success EINA_FALSE otherwise.
* @return @c EINA_TRUE on success @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_client_message32_send(Ecore_X_Window win,
@ -1842,9 +1842,9 @@ ecore_x_client_message32_send(Ecore_X_Window win,
* @param win The window the message is sent to.
* @param type The client message type.
* @param data Data to be sent.
* @param len Number of data bytes, max 20.
* @param len Number of data bytes, max @c 20.
*
* @return EINA_TRUE on success EINA_FALSE otherwise.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_client_message8_send(Ecore_X_Window win,

5
legacy/ecore/src/lib/ecore_x/xlib/ecore_x_gesture.c
View File

@ -33,8 +33,9 @@ _ecore_x_gesture_init(void)
}
/*
* @brief query whether gesture is available or not
* @return EINA_TRUE, if extension is available, else EINA_FALSE
* @brief Query whether gesture is available or not.
*
* @return @c EINA_TRUE, if extension is available, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_gesture_supported(void)

9
legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr.c
View File

@ -53,8 +53,9 @@ _ecore_x_randr_init(void)
}
/*
* @brief query whether randr is available or not
* @return EINA_TRUE, if extension is available, else EINA_FALSE
* @brief Query whether randr is available or not.
*
* @return @c EINA_TRUE, if extension is available, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_query(void)
@ -63,8 +64,8 @@ ecore_x_randr_query(void)
}
/*
* @return version of the RandRR extension supported by the server or,
* in case RandRR extension is not available, Ecore_X_Randr_Unset (=-1).
* @return version of the RandR extension supported by the server or, in case
* RandR extension is not available, Ecore_X_Randr_Unset (=-1).
* bit version information: 31 MAJOR 16 | 15 MINOR 0
*/
EAPI int

34
legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_11.c
View File

@ -69,10 +69,13 @@ ecore_x_randr_screen_primary_output_orientation_get(Ecore_X_Window root)
}
/*
* @brief sets a given screen's primary output's orientation
* @param root window which's screen's primary output will be queried
* @param orientation orientation which should be set for the root window's screen primary output
* @return EINA_TRUE if the primary output's orientation could be successfully altered
* @brief Sets a given screen's primary output's orientation.
*
* @param root Window which's screen's primary output will be queried.
* @param orientation orientation which should be set for the root window's
* screen primary output.
* @return @c EINA_TRUE if the primary output's orientation could be
* successfully altered.
*/
EAPI Eina_Bool
ecore_x_randr_screen_primary_output_orientation_set(
@ -200,10 +203,14 @@ ecore_x_randr_screen_primary_output_current_size_get(Ecore_X_Window root,
}
/*
* @brief sets a given screen's primary output size, but disables all other outputs at the same time
* @param root window which's primary output will be queried
* @param size_index within the list of sizes reported as supported by the root window's screen primary output
* @return EINA_TRUE on success, EINA_FALSE on failure due to e.g. invalid times
* @brief Sets a given screen's primary output size, but disables all other
* outputs at the same time.
*
* @param root Window which's primary output will be queried.
* @param size_index Within the list of sizes reported as supported by the root
* window's screen primary output.
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure due to e.g.
* invalid times.
*/
EAPI Eina_Bool
ecore_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,
//>= 1.1
/*
* @brief sets the current primary output's refresh rate
* @param root window which's primary output will be queried
* @param size_index referencing the size to be set
* @param rate the refresh rate to be set
* @return EINA_TRUE on success else EINA_FALSE
* @brief Sets the current primary output's refresh rate.
*
* @param root Window which's primary output will be queried.
* @param size_index Referencing the size to be set.
* @param rate The refresh rate to be set.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_screen_primary_output_refresh_rate_set(

238
legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c
View File

@ -43,10 +43,11 @@ extern int _randr_version;
#endif
/**
* @brief enable event selection. This enables basic interaction with
* output/crtc events and requires RRandR >= 1.2.
* @param win select this window's properties for RandRR events
* @param on enable/disable selecting
* @brief Enable event selection. This enables basic interaction with
* output/crtc events and requires RandR >= 1.2.
*
* @param win Select this window's properties for RandR events.
* @param on Enable/disable selecting.
*/
EAPI void
ecore_x_randr_events_select(Ecore_X_Window win,
@ -72,10 +73,12 @@ ecore_x_randr_events_select(Ecore_X_Window win,
}
/**
* @brief validates a CRTC for a given root window's screen.
* @param root the window which's default display will be queried
* @param crtc the CRTC to be validated.
* @return in case it is found EINA_TRUE will be returned. Else EINA_FALSE is returned.
* @brief Validates a CRTC for a given root window's screen.
*
* @param root The window which's default display will be queried.
* @param crtc The CRTC to be validated.
* @return In case it is found, @c EINA_TRUE will be returned, @c EINA_FALSE
* otherwise.
*/
static inline Eina_Bool
_ecore_x_randr_crtc_validate(Ecore_X_Window root,
@ -244,13 +247,18 @@ ecore_x_randr_screen_size_range_get(Ecore_X_Window root,
}
/*
* @param root window which's screen's size should be set. If invalid (e.g. NULL) no action is taken.
* @param w width in px the screen should be set to. If out of valid boundaries, current value is assumed.
* @param h height in px the screen should be set to. If out of valid boundaries, current value is assumed.
* @param w_mm width in mm the screen should be set to. If 0, current aspect is assumed.
* @param h_mm height in mm the screen should be set to. If 0, current aspect is assumed.
* @return EINA_TRUE if request was successfully sent or screen is already in
* requested size, EINA_FALSE if parameters are invalid
* @param root Window which's screen's size should be set. If invalid (e.g.
* @c NULL) no action is taken.
* @param w Width in px the screen should be set to. If out of valid
* boundaries, current value is assumed.
* @param h Height in px the screen should be set to. If out of valid
* boundaries, current value is assumed.
* @param w_mm Width in mm the screen should be set to. If @c 0, current
* aspect is assumed.
* @param h_mm Height in mm the screen should be set to. If @c 0, current
* aspect is assumed.
* @return @c EINA_TRUE if request was successfully sent or screen is already
* in requested size, @c EINA_FALSE if parameters are invalid.
*/
EAPI Eina_Bool
ecore_x_randr_screen_current_size_set(Ecore_X_Window root,
@ -380,8 +388,9 @@ ecore_x_randr_modes_info_get(Ecore_X_Window root,
}
/*
* @brief add a mode to a display
* @param root window to which's screen's ressources are added
* @brief Add a mode to a display.
*
* @param root Window to which's screen's ressources are added.
* @param mode_info
* @return Ecore_X_Randr_Mode of the added mode. Ecore_X_Randr_None if mode
* adding failed.
@ -405,7 +414,8 @@ ecore_x_randr_mode_info_add(Ecore_X_Window root,
}
/*
* @brief delete a mode from the display
* @brief Delete a mode from the display.
*
* @param mode_info
* @since 1.2.0
*/
@ -480,9 +490,10 @@ ecore_x_randr_mode_info_get(Ecore_X_Window root,
}
/*
* @brief free detailed mode information. The pointer handed in will be set to
* NULL after freeing the memory.
* @param mode_info the mode information that should be freed
* @brief Free detailed mode information. The pointer handed in will be set to
* @c NULL after freeing the memory.
*
* @param mode_info The mode information that should be freed.
*/
EAPI void
ecore_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)
}
/*
* @brief get all known CRTCs related to a root window's screen
* @param root window which's screen's ressources are queried
* @param num number of CRTCs returned
* @return CRTC IDs
* @brief Get all known CRTCs related to a root window's screen.
*
* @param root Window which's screen's ressources are queried.
* @param num Number of CRTCs returned.
* @return CRTC IDs.
*/
EAPI Ecore_X_Randr_Crtc *
ecore_x_randr_crtcs_get(Ecore_X_Window root,
@ -538,7 +550,7 @@ ecore_x_randr_crtcs_get(Ecore_X_Window root,
* @brief get the CRTCs, which display a certain window
* @param window window the displaying crtcs shall be found for
* @param num the number of crtcs displaying the window
* @return array of crtcs that display a certain window. NULL if no crtcs
* @return Array of crtcs that display a certain window. @c NULL if no crtcs
* was found that displays the specified window.
*/
EAPI Ecore_X_Randr_Crtc *
@ -552,7 +564,7 @@ ecore_x_randr_current_crtc_get(Ecore_X_Window window,
* @brief get the CRTCs, which display a certain window
* @param window window the displaying crtcs shall be found for
* @param num the number of crtcs displaying the window
* @return array of crtcs that display a certain window. NULL if no crtcs
* @return Array of crtcs that display a certain window. @c NULL if no crtcs
* was found that displays the specified window.
* @since 1.2.0
*/
@ -768,12 +780,16 @@ ecore_x_randr_crtc_geometry_get(Ecore_X_Window root,
}
/*
* @brief sets the position of given CRTC within root window's screen
* @param root the window's screen to be queried
* @param crtc the CRTC which's position within the mentioned screen is to be altered
* @param x position on the x-axis (0 == left) of the screen. if x < 0 current value will be kept.
* @param y position on the y-ayis (0 == top) of the screen. if y < 0, current value will be kept.
* @return EINA_TRUE if position could be successfully be altered.
* @brief Sets the position of given CRTC within root window's screen.
*
* @param root The window's screen to be queried.
* @param crtc The CRTC which's position within the mentioned screen is to be
* altered.
* @param x Position on the x-axis (0 == left) of the screen. if x < 0 current
* value will be kept.
* @param y Position on the y-ayis (0 == top) of the screen. if y < 0, current
* value will be kept.
* @return @c EINA_TRUE if position could successfully be altered.
*/
EAPI Eina_Bool
ecore_x_randr_crtc_pos_set(Ecore_X_Window root,
@ -858,16 +874,18 @@ ecore_x_randr_crtc_mode_get(Ecore_X_Window root,
}
/**
* @brief sets a mode for a CRTC and the outputs attached to it
* @param root the window's screen to be queried
* @param crtc the CRTC which shall be set
* @param outputs array of outputs which have to be compatible with the mode. If
* NULL CRTC will be disabled.
* @param noutputs number of outputs in array to be used. Use
* Ecore_X_Randr_Unset (or -1) to use currently used outputs.
* @param mode XID of the mode to be set. If set to 0 the CRTC will be disabled.
* If set to -1 the call will fail.
* @return EINA_TRUE if mode setting was successful. Else EINA_FALSE
* @brief Sets a mode for a CRTC and the outputs attached to it.
*
* @param root The window's screen to be queried.
* @param crtc The CRTC which shall be set.
* @param outputs Array of outputs which have to be compatible with the mode.
* If @c NULL, CRTC will be disabled.
* @param noutputs Number of outputs in array to be used. Use
* Ecore_X_Randr_Unset (or @c -1) to use currently used outputs.
* @param mode XID of the mode to be set. If set to @c 0 the CRTC will be
* disabled. If set to @c -1 the call will fail.
* @return @c EINA_TRUE if mode setting was successful, @c EINA_FALSE
* otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_crtc_mode_set(Ecore_X_Window root,
@ -1097,24 +1115,26 @@ ecore_x_randr_crtc_clone_set(Ecore_X_Window root,
}
/**
* @brief sets the demanded parameters for a given CRTC. Note that the CRTC is
* @brief Sets the demanded parameters for a given CRTC. Note that the CRTC is
* auto enabled in it's preferred mode, when it was disabled before.
* @param root the root window which's default display will be queried
* @param crtc the CRTC which's configuration should be altered
* @param outputs an array of outputs, that should display this CRTC's content.
* @param noutputs number of outputs in the array of outputs.
* If set to Ecore_X_Randr_Unset, current outputs and number of outputs will be used.
* If set to Ecore_X_Randr_None, CRTC will be disabled
* @param x new x coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current x
*
* @param root The root window which's default display will be queried.
* @param crtc The CRTC which's configuration should be altered.
* @param outputs An array of outputs, that should display this CRTC's content.
* @param noutputs Number of outputs in the array of outputs. If set to
* Ecore_X_Randr_Unset, current outputs and number of outputs will be used.
* If set to Ecore_X_Randr_None, CRTC will be disabled.
* @param x New x coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current x
* corrdinate will be assumed.
* @param y new y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y
* @param y New y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y
* corrdinate will be assumed.
* @param mode the new mode to be set. If Ecore_X_Randr_None is passed, the
* CRTC will be disabled. If Ecore_X_Randr_Unset is passed, the current mode is assumed.
* @param orientation the new orientation to be set. If Ecore_X_Randr_Unset is used,
* the current mode is assumed.
* @return EINA_TRUE if the configuration alteration was successful, else
* EINA_FALSE
* @param mode The new mode to be set. If Ecore_X_Randr_None is passed, the
* CRTC will be disabled. If Ecore_X_Randr_Unset is passed, the current mode is
* assumed.
* @param orientation The new orientation to be set. If Ecore_X_Randr_Unset is
* used, the current mode is assumed.
* @return @c EINA_TRUE if the configuration alteration was successful,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
ecore_x_randr_crtc_settings_set(Ecore_X_Window root,
@ -1180,14 +1200,16 @@ ecore_x_randr_crtc_settings_set(Ecore_X_Window root,
}
/**
* @brief sets a CRTC relative to another one.
* @param crtc_r1 the CRTC to be positioned.
* @param crtc_r2 the CRTC the position should be relative to
* @param policy the relation between the crtcs
* @param alignment in case CRTCs size differ, aligns CRTC1 accordingly at CRTC2's
* borders
* @return EINA_TRUE if crtc could be successfully positioned. EINA_FALSE if
* repositioning failed or if position of new crtc would be out of given screen's min/max bounds.
* @brief Sets a CRTC relative to another one.
*
* @param crtc_r1 The CRTC to be positioned.
* @param crtc_r2 The CRTC the position should be relative to.
* @param policy The relation between the crtcs.
* @param alignment In case CRTCs size differ, aligns CRTC1 accordingly at
* CRTC2's borders.
* @return @c EINA_TRUE if crtc could be successfully positioned, @c EINA_FALSE
* if repositioning failed or if position of new crtc would be out of given
* screen's min/max bounds.
*/
EAPI Eina_Bool
ecore_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,
}
/*
* @brief add given mode to given output
* @param output the output the mode is added to
* @param mode the mode added to the output
* @return EINA_FALSE if output or mode equal Ecore_X_Randr_None, else EINA_TRUE
* Additionally, if xcb backend is used, the success of the addition is reported
* back directly.
* @brief Add given mode to given output.
*
* @param output The output the mode is added to.
* @param mode The mode added to the output.
* @return @c EINA_FALSE if output or mode equal Ecore_X_Randr_None, else
* @c EINA_TRUE.
* Additionally, if xcb backend is used, the success of the addition is
* reported back directly.
* @since 1.2.0
*/
EAPI Eina_Bool
@ -1917,13 +1941,16 @@ ecore_x_randr_move_all_crtcs_but(Ecore_X_Window root,
}
/*
* @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.
* @param root window which's screen's resources are used
* @param crtcs list of CRTCs to be moved
* @param ncrtc number of CRTCs in array
* @param dx amount of pixels the CRTCs should be moved in x direction
* @param dy amount of pixels the CRTCs should be moved in y direction
* @return EINA_TRUE if all crtcs could be moved successfully.
* @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.
*
* @param root Window which's screen's resources are used.
* @param crtcs List of CRTCs to be moved.
* @param ncrtc Number of CRTCs in array.
* @param dx Amount of pixels the CRTCs should be moved in x direction.
* @param dy Amount of pixels the CRTCs should be moved in y direction.
* @return @c EINA_TRUE if all crtcs could be moved successfully.
*/
EAPI Eina_Bool
ecore_x_randr_move_crtcs(Ecore_X_Window root,
@ -2088,9 +2115,10 @@ ecore_x_randr_screen_reset(Ecore_X_Window root)
}
/**
* @brief set up the backlight level to the given level.
* @param root the window's screen which will be set.
* @param level of the backlight between 0 and 1
* @brief Set up the backlight level to the given level.
*
* @param root The window's screen which will be set.
* @param level Of the backlight between @c 0 and @c 1.
*/
EAPI void
@ -2137,8 +2165,8 @@ ecore_x_randr_screen_backlight_level_set(Ecore_X_Window root,
}
/*
* @brief check if a backlight is available
* @return whether a blacklight is available
* @brief Check if a backlight is available.
* @return Whether a backlight is available.
*/
EAPI Eina_Bool
@ -2157,10 +2185,11 @@ ecore_x_randr_output_backlight_available(void)
}
/*
* @brief get the backlight level of the given output
* @param root window which's screen should be queried
* @param output from which the backlight level should be retrieved
* @return the backlight level
* @brief Get the backlight level of the given output.
*
* @param root Window which's screen should be queried.
* @param output From which the backlight level should be retrieved.
* @return The backlight level.
*/
EAPI double
@ -2229,11 +2258,12 @@ ecore_x_randr_output_backlight_level_get(Ecore_X_Window root,
}
/*
* @brief set the backlight level of a given output
* @param root window which's screen should be queried
* @param output that should be set
* @param level for which the backlight should be set
* @return EINA_TRUE in case of success
* @brief Set the backlight level of a given output.
*
* @param root Window which's screen should be queried.
* @param output That should be set.
* @param level For which the backlight should be set.
* @return @c EINA_TRUE in case of success.
*/
EAPI Eina_Bool
@ -2290,11 +2320,12 @@ ecore_x_randr_output_backlight_level_set(Ecore_X_Window root,
}
/*
* @brief get the outputs, which display a certain window
* @param window window the displaying outputs shall be found for
* @param num the number of outputs displaying the window
* @return array of outputs that display a certain window. NULL if no outputs
* was found that displays the specified window.
* @brief Get the outputs, which display a certain window.
*
* @param window Window the displaying outputs shall be found for
* @param num The number of outputs displaying the window
* @return Array of outputs that display a certain window. @c NULL if no
* outputs was found that displays the specified window.
*/
EAPI Ecore_X_Randr_Output *
@ -2344,11 +2375,12 @@ _ecore_x_randr_current_output_get_fail:
/*
* @deprecated bad naming. Use ecore_x_randr_window_outputs_get instead.
* @brief get the outputs, which display a certain window
* @param window window the displaying outputs shall be found for
* @param num the number of outputs displaying the window
* @return array of outputs that display a certain window. NULL if no outputs
* was found that displays the specified window.
* @brief Get the outputs, which display a certain window.
*
* @param window Window the displaying outputs shall be found for.
* @param num The number of outputs displaying the window.
* @return Array of outputs that display a certain window. @c NULL if no
* outputs was found that displays the specified window.
*/
EAPI Ecore_X_Randr_Output *