slight change in doc comments... get rid of htmlisms...

SVN revision: 9037
This commit is contained in:
Carsten Haitzler 2004-02-20 07:06:29 +00:00
parent 160e4083c1
commit 75047789ad
25 changed files with 7 additions and 236 deletions

View File

@ -25,7 +25,6 @@ static int _ecore_init_count = 0;
* ecore_shutdown();
* }
* @endcode
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_init(void)
@ -45,8 +44,7 @@ ecore_init(void)
*
* Do not call this function from any callback that may be called from the main
* loop, as the main loop will then fall over and not function properly.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
*/
int
ecore_shutdown(void)
{

View File

@ -35,7 +35,6 @@ static char **app_argv = NULL;
* ecore_shutdown();
* }
* @endcode
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_app_args_set(int argc, const char **argv)
@ -56,7 +55,6 @@ ecore_app_args_set(int argc, const char **argv)
* the pointer is not NULL, and the string array pointer @p argv will be filled
* also if the pointer is not NULL. The values they are filled with will be the
* same set by ecore_app_args_set().
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_app_args_get(int *argc, char ***argv)
@ -74,7 +72,6 @@ ecore_app_args_get(int *argc, char ***argv)
* configuration reasons or in the event of a crash.
*
* FIXME: Currently not implimented.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_app_restart(void)

View File

@ -76,7 +76,6 @@ static void *ecore_raw_event_event = NULL;
* ecore_shutdown();
* }
* @endcode
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Event_Handler *
ecore_event_handler_add(int type, int (*func) (void *data, int type, void *event), const void *data)
@ -104,7 +103,6 @@ ecore_event_handler_add(int type, int (*func) (void *data, int type, void *event
* 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
* returned. Once a handler is deleted it will no longer be called.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_event_handler_del(Ecore_Event_Handler *event_handler)
@ -136,7 +134,6 @@ ecore_event_handler_del(Ecore_Event_Handler *event_handler)
* longer needed, @p func_free will be called and passed the private sructure
* pointer for cleaning up. If @p func_free is NULL, nothnig will be called.
* This function is passed @p data as its data parameter.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Event *
ecore_event_add(int type, void *ev, void (*func_free) (void *data, void *ev), void *data)
@ -158,7 +155,6 @@ ecore_event_add(int type, void *ev, void (*func_free) (void *data, void *ev), vo
* does not immediately call the free function, and it may be called later on
* cleanup, and so if the free function depends on the data pointer to work,
* you should defer cleaning of this till the free function is called later.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_event_del(Ecore_Event *event)
@ -182,7 +178,6 @@ ecore_event_del(Ecore_Event *event)
* the program. There is no guarantee of the contents of this event ID, or how
* it is calculated, except that the ID will be unique to the current instance
* of the process.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_event_type_new(void)
@ -210,7 +205,6 @@ ecore_event_type_new(void)
* event is removed from the queue. If it returns 1, the event is kept. When
* processing is finished @p func_end is called and is passed the loop_data
* and @p data pointer to clean up.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Event_Filter *
ecore_event_filter_add(void * (*func_start) (void *data), int (*func_filter) (void *data, void *loop_data, int type, void *event), void (*func_end) (void *data, void *loop_data), const void *data)
@ -237,7 +231,6 @@ ecore_event_filter_add(void * (*func_start) (void *data), int (*func_filter) (vo
* Delete a filter that has been added by its @p ef handle. On success this
* will return the data pointer set when this filter was added. On failure
* NULL is returned.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_event_filter_del(Ecore_Event_Filter *ef)
@ -266,7 +259,6 @@ ecore_event_filter_del(Ecore_Event_Filter *ef)
* this extra information may be useful or needed and using this call can let
* the program know if the event type being handled is one it wants to get more
* information about.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_event_current_type_get(void)
@ -287,7 +279,6 @@ ecore_event_current_type_get(void)
* this extra information may be useful or needed and using this call can let
* the program access the event data if the type of the event is handled by
* the program.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_event_current_event_get(void)

View File

@ -21,7 +21,6 @@ static Ecore_Exe *exes = NULL;
* event is recieved. After all handlers for this child process terminated
* event have been called, this process handle will be freed and cleaned up
* by Ecore, and so any references to it will become invalid.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Exe *
ecore_exe_run(const char *exe_cmd, const void *data)
@ -60,7 +59,6 @@ ecore_exe_run(const char *exe_cmd, const void *data)
* that this handle was a result of) and returns the data pointer set on
* executable start. This does mean there is no handle for the spawned
* process anymore.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_exe_free(Ecore_Exe *exe)
@ -80,7 +78,6 @@ ecore_exe_free(Ecore_Exe *exe)
* @return A system process ID of the process handle
*
* This function returns the system process ID of a spawned off child process.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
pid_t
ecore_exe_pid_get(Ecore_Exe *exe)
@ -101,7 +98,6 @@ ecore_exe_pid_get(Ecore_Exe *exe)
*
* This function returns the data pointer attached to the spawned off process
* whose handle is @p exe.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_exe_data_get(Ecore_Exe *exe)
@ -120,7 +116,6 @@ ecore_exe_data_get(Ecore_Exe *exe)
* @param exe The process handle to control
*
* This function pauses a process that was spawned.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_exe_pause(Ecore_Exe *exe)
@ -140,7 +135,6 @@ ecore_exe_pause(Ecore_Exe *exe)
*
* This Continues a process. This is only useful if the process has already
* been paused by something like ecore_exe_pause().
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_exe_continue(Ecore_Exe *exe)
@ -159,7 +153,6 @@ ecore_exe_continue(Ecore_Exe *exe)
* @param exe The process handle to control
*
* This function asks a process to terminate.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_exe_terminate(Ecore_Exe *exe)
@ -180,7 +173,6 @@ ecore_exe_terminate(Ecore_Exe *exe)
* This function ills off a process, and that process has no choice and will
* exit as a result of this function, without having a chance to clean up,
* save data, or safely shut down.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_exe_kill(Ecore_Exe *exe)
@ -202,7 +194,6 @@ ecore_exe_kill(Ecore_Exe *exe)
* This function sends a user signal (SIGUSR) to a process. @p num determines
* what numbered user signal to send. This may be either 1 or 2. Other values
* are illegal and will be ignored, with this function doing nothing.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_exe_signal(Ecore_Exe *exe, int num)
@ -224,7 +215,6 @@ ecore_exe_signal(Ecore_Exe *exe, int num)
* @param exe The process handle to control
*
* This function sends a HUP signal to the specified process.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_exe_hup(Ecore_Exe *exe)

View File

@ -18,7 +18,6 @@ static int idle_enterers_delete_me = 0;
* use to update your program's state if it has a state engine. Do all your
* heavy processing here to update state (like drawing etc.). When @p func
* is called, it will be passed the pointer @p data.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Idle_Enterer *
ecore_idle_enterer_add(int (*func) (void *data), const void *data)
@ -43,7 +42,6 @@ ecore_idle_enterer_add(int (*func) (void *data), const void *data)
* executed during main loop execution. On success the data pointer that was
* being passed to the idle handler function, set by ecore_idle_enterer_add()
* will be returned.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_idle_enterer_del(Ecore_Idle_Enterer *idle_enterer)

View File

@ -19,7 +19,6 @@ static int idlers_delete_me = 0;
* get to do so. This is useful for when there are interfaces that require
* polling and timers will mean too slow a response from the process if polling
* is done by timers.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Idler *
ecore_idler_add(int (*func) (void *data), const void *data)
@ -44,7 +43,6 @@ ecore_idler_add(int (*func) (void *data), const void *data)
* during main loop execution. On success the data pointer set by
* ecore_idler_add() and passed to the idler function is returned, or NULL
* on failure.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_idler_del(Ecore_Idler *idler)

View File

@ -22,7 +22,6 @@ static int fd_handlers_delete_me = 0;
*
* This function Processes 1 iteration of the main loop, handling anything on
* the queue. See ecore_main_loop_begin() for more information.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_main_loop_iterate(void)
@ -37,7 +36,6 @@ ecore_main_loop_iterate(void)
* will keep looping internally and call all callbacks set up to handle timers,
* idle state and events Ecore recieves from X, fd's, IPC, signals etc. and
* anything else that has registered a handler with ecore itself.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_main_loop_begin(void)
@ -54,7 +52,6 @@ ecore_main_loop_begin(void)
* This function will flag a quit of the main loop once the current loop has
* finished processing all events. It will not quit instantly, so expect more
* callbacks to be called after this command has been issued.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_main_loop_quit(void)
@ -91,7 +88,6 @@ ecore_main_loop_quit(void)
* fd = open("/tmp/fifo", O_RDONLY);
* fdh = ecore_main_fd_handler_add(fd, ECORE_FD_READ, func_read_fifo, NULL);
* @endcode
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Fd_Handler *
ecore_main_fd_handler_add(int fd, Ecore_Fd_Handler_Flags flags, int (*func) (void *data, Ecore_Fd_Handler *fd_handler), const void *data, int (*buf_func) (void *buf_data, Ecore_Fd_Handler *fd_handler), const void *buf_data)

View File

@ -10,7 +10,6 @@
* This function returns the current system time in seconds from 12:00am
* 1st Janruary 1970. The time is returned as a double precision floating point
* value to allow for fractions of a second to be determined.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
double
ecore_time_get(void)

View File

@ -64,7 +64,6 @@ static Ecore_Timer *timers = NULL;
* ecore_shutdown();
* }
* @endcode
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Timer *
ecore_timer_add(double in, int (*func) (void *data), const void *data)
@ -92,7 +91,6 @@ ecore_timer_add(double in, int (*func) (void *data), const void *data)
* was being passed to the callback on success, or NULL on failure. After this
* call returns the specified timer object @p timer is invalid and should not
* be used again. It will not get called again after deletion.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_timer_del(Ecore_Timer *timer)

View File

@ -45,7 +45,6 @@ static int init_count = 0;
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_con_init(void)
@ -67,7 +66,6 @@ ecore_con_init(void)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_con_shutdown(void)
@ -85,7 +83,6 @@ ecore_con_shutdown(void)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Con_Server *
ecore_con_server_add(Ecore_Con_Type type,
@ -255,7 +252,6 @@ ecore_con_server_add(Ecore_Con_Type type,
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Con_Server *
ecore_con_server_connect(Ecore_Con_Type type,
@ -375,7 +371,6 @@ ecore_con_server_connect(Ecore_Con_Type type,
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_con_server_del(Ecore_Con_Server *svr)
@ -397,7 +392,6 @@ ecore_con_server_del(Ecore_Con_Server *svr)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_con_server_data_get(Ecore_Con_Server *svr)
@ -415,7 +409,6 @@ ecore_con_server_data_get(Ecore_Con_Server *svr)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_con_server_connected_get(Ecore_Con_Server *svr)
@ -434,7 +427,6 @@ ecore_con_server_connected_get(Ecore_Con_Server *svr)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_con_server_send(Ecore_Con_Server *svr, void *data, int size)
@ -474,7 +466,6 @@ ecore_con_server_send(Ecore_Con_Server *svr, void *data, int size)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_con_client_send(Ecore_Con_Client *cl, void *data, int size)
@ -514,7 +505,6 @@ ecore_con_client_send(Ecore_Con_Client *cl, void *data, int size)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Con_Server *
ecore_con_client_server_get(Ecore_Con_Client *cl)
@ -532,7 +522,6 @@ ecore_con_client_server_get(Ecore_Con_Client *cl)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_con_client_del(Ecore_Con_Client *cl)
@ -554,7 +543,6 @@ ecore_con_client_del(Ecore_Con_Client *cl)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_con_client_data_set(Ecore_Con_Client *cl, const void *data)
@ -572,7 +560,6 @@ ecore_con_client_data_set(Ecore_Con_Client *cl, const void *data)
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void *
ecore_con_client_data_get(Ecore_Con_Client *cl)

View File

@ -10,8 +10,7 @@ static int _ecore_evas_init_count = 0;
* Init the Evas system.
* @return greater than 0 on success, 0 on failure
*
* Set up the Evas wrapper system
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
* Set up the Evas wrapper system.
*/
int
ecore_evas_init(void)
@ -26,7 +25,6 @@ ecore_evas_init(void)
* @return 0 if ecore evas is fully shut down, or 1 if it still needs to be shut down
*
* This closes the Evas system down.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_shutdown(void)
@ -52,7 +50,6 @@ ecore_evas_shutdown(void)
* @param ee The Ecore_Evas to free
*
* This frees up any memory used by the Ecore_Evas.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_free(Ecore_Evas *ee)
@ -89,7 +86,6 @@ ecore_evas_free(Ecore_Evas *ee)
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is resized.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_resize_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -112,7 +108,6 @@ ecore_evas_callback_resize_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is moved.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_move_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -135,7 +130,6 @@ ecore_evas_callback_move_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is shown.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_show_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -158,7 +152,6 @@ ecore_evas_callback_show_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is hidden.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_hide_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -181,7 +174,6 @@ ecore_evas_callback_hide_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee gets a delete request.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_delete_request_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -204,7 +196,6 @@ ecore_evas_callback_delete_request_set(Ecore_Evas *ee, void (*func) (Ecore_Evas
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is destroyed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_destroy_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -227,7 +218,6 @@ ecore_evas_callback_destroy_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee gets focus.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_focus_in_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -250,7 +240,6 @@ ecore_evas_callback_focus_in_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee loses focus.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_focus_out_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -273,7 +262,6 @@ ecore_evas_callback_focus_out_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever the mouse enters @p ee.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -296,7 +284,6 @@ ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever the mouse leaves @p ee.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -319,7 +306,6 @@ ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called just before the evas in @p ee is rendered.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_pre_render_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -342,7 +328,6 @@ ecore_evas_callback_pre_render_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee)
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called just after the evas in @p ee is rendered.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_callback_post_render_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee))
@ -364,7 +349,6 @@ ecore_evas_callback_post_render_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee
* @return The Evas wrapped by @p ee
*
* This function returns the Evas contained within @p ee.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Evas *
ecore_evas_get(Ecore_Evas *ee)
@ -385,7 +369,6 @@ ecore_evas_get(Ecore_Evas *ee)
* @param y The y coordinate to move to
*
* This moves @p ee to the screen coordinates (@p x, @p y)
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_move(Ecore_Evas *ee, int x, int y)
@ -407,7 +390,6 @@ ecore_evas_move(Ecore_Evas *ee, int x, int y)
* @param h The h coordinate to resize to
*
* This resizes @p ee to @p w x @p h
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_resize(Ecore_Evas *ee, int w, int h)
@ -443,7 +425,6 @@ ecore_evas_resize(Ecore_Evas *ee, int w, int h)
* This moves @p ee to the screen coordinates (@p x, @p y) and resizes
* it to @p w x @p h.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h)
@ -484,7 +465,6 @@ ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h)
* ecore_evas_geometry_get(ee, &x, &y, &w, &h);
* @endcode
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_geometry_get(Ecore_Evas *ee, int *x, int *y, int *w, int *h)
@ -519,7 +499,6 @@ ecore_evas_geometry_get(Ecore_Evas *ee, int *x, int *y, int *w, int *h)
*
* The allowed values of @p rot depend on the engine being used. Most only
* allow multiples of 90.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_rotation_set(Ecore_Evas *ee, int rot)
@ -543,7 +522,6 @@ ecore_evas_rotation_set(Ecore_Evas *ee, int rot)
* @param ee The Ecore_Evas
* @return the angle (in degrees) of rotation.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_rotation_get(Ecore_Evas *ee)
@ -568,7 +546,6 @@ ecore_evas_rotation_get(Ecore_Evas *ee)
* 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.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_shaped_set(Ecore_Evas *ee, int shaped)
@ -589,7 +566,6 @@ ecore_evas_shaped_set(Ecore_Evas *ee, int shaped)
* @return 1 if shaped, 0 if not.
*
* This function returns 1 if @p ee is shaped, and 0 if not.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_shaped_get(Ecore_Evas *ee)
@ -608,7 +584,6 @@ ecore_evas_shaped_get(Ecore_Evas *ee)
* @param ee The Ecore_Evas to show.
*
* This function makes @p ee visible.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_show(Ecore_Evas *ee)
@ -628,7 +603,6 @@ ecore_evas_show(Ecore_Evas *ee)
* @param ee The Ecore_Evas to show.
*
* This function makes @p ee hidden.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_hide(Ecore_Evas *ee)
@ -649,7 +623,6 @@ ecore_evas_hide(Ecore_Evas *ee)
* @return 1 if visible, 0 if not.
*
* This function queries @p ee and returns 1 if it is visible, and 0 if not.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_visibility_get(Ecore_Evas *ee)
@ -668,7 +641,6 @@ ecore_evas_visibility_get(Ecore_Evas *ee)
* @param ee The Ecore_Evas to raise.
*
* This functions raises the Ecore_Evas to the front.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_raise(Ecore_Evas *ee)
@ -688,7 +660,6 @@ ecore_evas_raise(Ecore_Evas *ee)
* @param ee The Ecore_Evas to raise.
*
* This functions lowers the Ecore_Evas to the back.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_lower(Ecore_Evas *ee)
@ -709,7 +680,6 @@ ecore_evas_lower(Ecore_Evas *ee)
* @param t The title
*
* This function sets the title of @p ee to @p t.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_title_set(Ecore_Evas *ee, const char *t)
@ -730,7 +700,6 @@ ecore_evas_title_set(Ecore_Evas *ee, const char *t)
* @return The title of @p ee.
*
* This function returns the title of @p ee.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
const char *
ecore_evas_title_get(Ecore_Evas *ee)
@ -751,7 +720,6 @@ ecore_evas_title_get(Ecore_Evas *ee)
* @param c the class
*
* This function sets the name of @p ee to @p n, and its class to @p c.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c)
@ -774,7 +742,6 @@ ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c)
*
* This function gets puts the name of @p ee into @p n, and its class into
* @p c.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_name_class_get(Ecore_Evas *ee, const char **n, const char **c)
@ -796,7 +763,6 @@ ecore_evas_name_class_get(Ecore_Evas *ee, const char **n, const char **c)
* @param h The minimum height
*
* This function sets the minimum size of @p ee to @p w x @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h)
@ -828,7 +794,6 @@ ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h)
* @param h A pointer to an int to place the min height in.
*
* This function puts the minimum size of @p ee into @p w and @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_size_min_get(Ecore_Evas *ee, int *w, int *h)
@ -858,7 +823,6 @@ ecore_evas_size_min_get(Ecore_Evas *ee, int *w, int *h)
* @param h The maximum height
*
* This function sets the maximum size of @p ee to @p w x @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h)
@ -890,7 +854,6 @@ ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h)
* @param h A pointer to an int to place the max height in.
*
* This function puts the maximum size of @p ee into @p w and @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_size_max_get(Ecore_Evas *ee, int *w, int *h)
@ -920,7 +883,6 @@ ecore_evas_size_max_get(Ecore_Evas *ee, int *w, int *h)
* @param h The base height
*
* This function sets the base size of @p ee to @p w x @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h)
@ -952,7 +914,6 @@ ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h)
* @param h A pointer to an int to place the base height in.
*
* This function puts the base size of @p ee into @p w and @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_size_base_get(Ecore_Evas *ee, int *w, int *h)
@ -983,7 +944,6 @@ ecore_evas_size_base_get(Ecore_Evas *ee, int *w, int *h)
*
* This function sets the step size of @p ee to @p w x @p h. This limits the
* size of an Ecore_Evas to always being an integer multiple of the step size.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h)
@ -1015,7 +975,6 @@ ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h)
* @param h A pointer to an int to place the step height in.
*
* This function puts the step size of @p ee into @p w and @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_size_step_get(Ecore_Evas *ee, int *w, int *h)
@ -1049,7 +1008,6 @@ ecore_evas_size_step_get(Ecore_Evas *ee, int *w, int *h)
* @p file. The actual point within the image that the mouse is at is specified
* by @p hot_x and @p hot_y, which are coordinates with respect to the top left
* corner of the cursor image.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y)
@ -1073,7 +1031,6 @@ ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, in
* @param hot_y A pointer to an int to place the cursor's hot_y coordinate in.
*
* This function queries information about an Ecore_Evas' cursor.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_cursor_get(Ecore_Evas *ee, char **file, int *layer, int *hot_x, int *hot_y)
@ -1096,7 +1053,6 @@ ecore_evas_cursor_get(Ecore_Evas *ee, char **file, int *layer, int *hot_x, int *
* @param layer The layer to put @p ee on.
*
* This function moves @p ee to the layer @p layer.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_layer_set(Ecore_Evas *ee, int layer)
@ -1116,7 +1072,6 @@ ecore_evas_layer_set(Ecore_Evas *ee, int layer)
* @param ee The Ecore_Evas to set
* @return the layer @p ee's window is on.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_layer_get(Ecore_Evas *ee)
@ -1136,7 +1091,6 @@ ecore_evas_layer_get(Ecore_Evas *ee)
* @param on 1 for focus, 0 to defocus.
*
* This function focuses @p ee if @p on is 1, or defocuses @p ee if @p on is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_focus_set(Ecore_Evas *ee, int on)
@ -1156,7 +1110,6 @@ ecore_evas_focus_set(Ecore_Evas *ee, int on)
* @param ee The Ecore_Evas to set
* @return 1 if @p ee if focused, 0 if not.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_focus_get(Ecore_Evas *ee)
@ -1177,7 +1130,6 @@ ecore_evas_focus_get(Ecore_Evas *ee)
*
* This function iconifies @p ee if @p on is 1, or uniconifies @p ee if @p on
* is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_iconified_set(Ecore_Evas *ee, int on)
@ -1197,7 +1149,6 @@ ecore_evas_iconified_set(Ecore_Evas *ee, int on)
* @param ee The Ecore_Evas to set
* @return 1 if @p ee is iconified, 0 if not.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_iconified_get(Ecore_Evas *ee)
@ -1218,7 +1169,6 @@ ecore_evas_iconified_get(Ecore_Evas *ee)
*
* This function makes @p ee borderless if @p on is 1, or bordered if @p on
* is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_borderless_set(Ecore_Evas *ee, int on)
@ -1238,7 +1188,6 @@ ecore_evas_borderless_set(Ecore_Evas *ee, int on)
* @param ee The Ecore_Evas to set
* @return 1 if @p ee is borderless, 0 if not.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_borderless_get(Ecore_Evas *ee)
@ -1259,7 +1208,6 @@ ecore_evas_borderless_get(Ecore_Evas *ee)
*
* This function causes the window manager to ignore @p ee if @p on is 1,
* or not ignore @p ee if @p on is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_override_set(Ecore_Evas *ee, int on)
@ -1279,7 +1227,6 @@ ecore_evas_override_set(Ecore_Evas *ee, int on)
* @param ee The Ecore_Evas to set
* @return 1 if @p ee is overridden, 0 if not.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_override_get(Ecore_Evas *ee)
@ -1300,7 +1247,6 @@ ecore_evas_override_get(Ecore_Evas *ee)
*
* This function maximizes @p ee if @p on is 1, or unmaximizes @p ee
* if @p on is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_maximized_set(Ecore_Evas *ee, int on)
@ -1320,7 +1266,6 @@ ecore_evas_maximized_set(Ecore_Evas *ee, int on)
* @param ee The Ecore_Evas to set
* @return 1 if @p ee is maximized, 0 if not.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_maximized_get(Ecore_Evas *ee)
@ -1341,7 +1286,6 @@ ecore_evas_maximized_get(Ecore_Evas *ee)
*
* This function causes @p ee to be fullscreen if @p on is 1,
* or not if @p on is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_fullscreen_set(Ecore_Evas *ee, int on)
@ -1361,7 +1305,6 @@ ecore_evas_fullscreen_set(Ecore_Evas *ee, int on)
* @param ee The Ecore_Evas to set
* @return 1 if @p ee is fullscreen, 0 if not.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_fullscreen_get(Ecore_Evas *ee)
@ -1383,7 +1326,6 @@ ecore_evas_fullscreen_get(Ecore_Evas *ee)
*
* This function causes @p ee to be drawn to a pixmap to avoid recalculations.
* On expose events it will copy from the pixmap to the window.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_avoid_damage_set(Ecore_Evas *ee, int on)
@ -1403,7 +1345,6 @@ ecore_evas_avoid_damage_set(Ecore_Evas *ee, int on)
* @param ee The Ecore_Evas to set
* @return 1 if @p ee avoids damage, 0 if not.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_avoid_damage_get(Ecore_Evas *ee)
@ -1422,7 +1363,6 @@ ecore_evas_avoid_damage_get(Ecore_Evas *ee)
* @param ee The Ecore_Evas whose window's withdrawn state is set.
* @param withdrawn The Ecore_Evas window's new withdrawn state.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_withdrawn_set(Ecore_Evas *ee, int withdrawn)
@ -1443,7 +1383,6 @@ ecore_evas_withdrawn_set(Ecore_Evas *ee, int withdrawn)
* @param ee The Ecore_Evas whose window's withdrawn state is returned.
* @return The Ecore_Evas window's withdrawn state.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_withdrawn_get(Ecore_Evas *ee)
@ -1463,7 +1402,6 @@ ecore_evas_withdrawn_get(Ecore_Evas *ee)
* @param ee The Ecore_Evas whose window's sticky state is set.
* @param sticky The Ecore_Evas window's new sticky state.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_evas_sticky_set(Ecore_Evas *ee, int sticky)
@ -1485,7 +1423,6 @@ ecore_evas_sticky_set(Ecore_Evas *ee, int sticky)
* @param ee The Ecore_Evas whose window's sticky state is returned.
* @return The Ecore_Evas window's sticky state.
*
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_evas_sticky_get(Ecore_Evas *ee)

View File

@ -429,7 +429,6 @@ static const Ecore_Evas_Engine_Func _ecore_fb_engine_func =
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Evas *
ecore_evas_fb_new(char *disp_name, int rotation, int w, int h)

View File

@ -1093,7 +1093,6 @@ static const Ecore_Evas_Engine_Func _ecore_x_engine_func =
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_Evas *
ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent,
@ -1264,7 +1263,6 @@ ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent,
* To be documented.
*
* FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Ecore_X_Window
ecore_evas_software_x11_window_get(Ecore_Evas *ee)

View File

@ -381,7 +381,6 @@ static char *_ecore_fb_btn_syms[128] =
* @return 0 on failure, or greter than 0 on success.
*
* This starts up the ecore fb system
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_fb_init(const char *name)
@ -517,7 +516,6 @@ ecore_fb_init(const char *name)
* @return 0 if the system was shut down, or 1 if it still needs to be shut down
*
* This shuts down the ecore fb system.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_fb_shutdown(void)
@ -568,7 +566,6 @@ ecore_fb_shutdown(void)
* This sets the time between clicks before the double_click flag is set in a
* button down event. If 3 clicks occur within double this time then the
* triple_click flag is also set.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_fb_double_click_time_set(double t)
@ -582,7 +579,6 @@ ecore_fb_double_click_time_set(double t)
* @return The timeout for double clicks in seconds
*
* This returns the tiemout that can be set by ecore_fb_double_click_time_set()
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>