* @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
*
* 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);
* @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.
*/
/**
* @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.
{
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 */
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);
/**
* @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!
*
/**
* @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);
* @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
*
* 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.
* 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()
* @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()
* }
* 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
* 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.
/**
* 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);
* @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
* @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.
*
* 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
* 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()
*/
* 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
*
* @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.
* 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.
* 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
* 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.
*/
* @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
* 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.
*
* 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
* 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
*
* @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.
*
*
* @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
* @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
* 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.
*
* 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()
* 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.
*
* 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
*
* @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
* @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,
/**
* 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.
*/
/**
* 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)
* (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
* 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.
* 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)
* @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.
*/
*
* @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.
*/
* @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,
* @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.
* 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);
/**
* @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);
/**
* 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);
/**
* 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);
/**
* 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()
*/
/**
* 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
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()
*/
* @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.
* @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
* @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);
* 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);
* @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,
*
* @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
* @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
/**
* @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
*/
* @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);
* @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()
*
* @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()
*
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
* 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
* 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
*/
* 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
* 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
* 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
* 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
*/
* @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)
* @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
/**
* @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()
*/
* @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().
* @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()
*/
*
* 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;
* @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;
* @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.
*/
* @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()
*/
* @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.
*
* @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.
*
* @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.
*/
* @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()
*/
* @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.
*/
* @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()
*/
* @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.
* @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.
*/
* @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()
*/
* @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.
*/
* @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!
*/
* 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()
* @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
*/
* @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
*
* @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);
/**
* 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);
/**
* 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.
*
/**
* 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.
*
/**
* 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);
* 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.
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()
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()
*
/**
* 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)
/**
* 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.
+ * @return @c EINA_TRUE if shaped, @c EINA_FALSE if not.
*
- * This function returns EINA_TRUE if @p ee is shaped, and 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)
/**
* 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)
/**
* 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)
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
*
* @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)
*
* @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)
*
* @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)
* @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
* @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
* @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
*
* @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
* @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)
* @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
* 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,
* @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,
* @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.
*/
* @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)
* @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)
* 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
*/
* 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
*/
/**
* 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.
/**
* 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.
* 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
*/
/**
* 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
* @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
* 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
*/
* 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
*/
* 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
*/
/**
* 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
* @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 *
*
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
/*
* @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,
/*
* @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,
/*
* @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,
/*
* @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,
/*
* @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,
/*
* @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,
/*
* @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,
* 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
* @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,
* @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,
* 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)
/**
* 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
*/
* @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
*/
/**
* 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
/* 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)
}
/*
- * @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,
}
/*
- * @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,
}
/*
- * @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,
}
/*
- * @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)
}
/**
- * @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 *
}
/**
- * @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 *
}
/**
- * @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,
}
/**
- * @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,
/*
* @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 *
}
/*
- * @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
*/
}
/**
- * @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,
}
/*
- * @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,
}
/*
- * @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,
}
/*
- * @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,
/*
* @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 *
}
/*
- * @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,
}
/*
- * @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,
}
/*
- * @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)
}
/**
- * @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,
* 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)
* @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,
* @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,
}
/*
- * @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)
}
/*
- * @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)
}
/*
- * @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
}
/*
- * @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(
}
/*
- * @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,
//>= 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(
#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,
}
/**
- * @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,
}
/*
- * @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,
}
/*
- * @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.
}
/*
- * @brief delete a mode from the display
+ * @brief Delete a mode from the display.
+ *
* @param mode_info
* @since 1.2.0
*/
}
/*
- * @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)
}
/*
- * @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,
* @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 *
* @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
*/
}
/*
- * @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,
}
/**
- * @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,
}
/**
- * @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,
}
/**
- * @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,
}
/*
- * @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
}
/*
- * @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,
}
/**
- * @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
}
/*
- * @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
}
/*
- * @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
}
/*
- * @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
}
/*
- * @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 *
/*
* @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 *
projects / profile / ivi / ecore.git / commitdiff