Enlightenment CVS committal
Author : raster
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore
Modified Files:
Tag: SPLIT
ecore.c ecore_app.c ecore_events.c ecore_exe.c
ecore_idle_enterer.c ecore_idler.c ecore_main.c ecore_time.c
ecore_timer.c
Log Message:
spacing between api calls... in docs
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Attic/ecore.c,v
retrieving revision 1.1.2.9
retrieving revision 1.1.2.10
diff -u -3 -r1.1.2.9 -r1.1.2.10
--- ecore.c 27 Feb 2003 01:03:45 -0000 1.1.2.9
+++ ecore.c 27 Feb 2003 01:58:10 -0000 1.1.2.10
@@ -24,6 +24,7 @@
* ecore_shutdown();
* }
* @endcode
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_init(void)
@@ -41,7 +42,8 @@
*
* 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>
+*/
void
ecore_shutdown(void)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Attic/ecore_app.c,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -u -3 -r1.1.2.3 -r1.1.2.4
--- ecore_app.c 25 Feb 2003 04:32:26 -0000 1.1.2.3
+++ ecore_app.c 27 Feb 2003 01:58:10 -0000 1.1.2.4
@@ -35,6 +35,7 @@
* 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)
@@ -55,6 +56,7 @@
* 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)
@@ -72,6 +74,7 @@
* 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)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Attic/ecore_events.c,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -u -3 -r1.1.2.8 -r1.1.2.9
--- ecore_events.c 25 Feb 2003 04:32:26 -0000 1.1.2.8
+++ ecore_events.c 27 Feb 2003 01:58:10 -0000 1.1.2.9
@@ -72,6 +72,7 @@
* 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) (int type, void *event, void *data),
const void *data)
@@ -99,6 +100,7 @@
* 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)
@@ -130,6 +132,7 @@
* 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 *ev, void *data), void
*data)
@@ -151,6 +154,7 @@
* 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)
@@ -174,6 +178,7 @@
* 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)
@@ -201,6 +206,7 @@
* 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) (int
type, void *event, void *loop_data, void *data), void (*func_end) (void *loop_data,
void *data), const void *data)
@@ -227,6 +233,7 @@
* 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)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Attic/ecore_exe.c,v
retrieving revision 1.1.2.7
retrieving revision 1.1.2.8
diff -u -3 -r1.1.2.7 -r1.1.2.8
--- ecore_exe.c 25 Feb 2003 04:32:26 -0000 1.1.2.7
+++ ecore_exe.c 27 Feb 2003 01:58:11 -0000 1.1.2.8
@@ -8,7 +8,7 @@
static Ecore_Exe *exes = NULL;
/**
- * Spawn off a child process and return a handle to that process
+ * Spawn off a child process and return a handle to that process.
* @param exe_cmd The command-line to run as if typed in a shell
* @param data A generic data pointer to attach to the process handle
* @return A process handle to the spawned off process
@@ -21,6 +21,7 @@
* 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)
@@ -51,7 +52,7 @@
}
/**
- * Free an exe handle
+ * Free an exe handle.
* @param exe
* @return The data pointer set on execution of the program
*
@@ -59,6 +60,7 @@
* 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)
@@ -73,11 +75,12 @@
}
/**
- * Get the process ID of a spawned process
+ * Get the process ID of a spawned process.
* @param exe The process handle returned by ecore_exe_run()
* @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)
@@ -92,12 +95,13 @@
}
/**
- * Get the data pointer attached to a process handle
+ * Get the data pointer attached to a process handle.
* @param exe The process handle returned by ecore_exe_run()
* @return An pointer to the attached data of the process handle
*
* 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)
@@ -112,10 +116,11 @@
}
/**
- * Pause a spawned process
+ * Pause a spawned process.
* @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)
@@ -130,11 +135,12 @@
}
/**
- * Continue a paused process
+ * Continue a paused process.
* @param exe The process handle to control
*
* 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)
@@ -153,6 +159,7 @@
* @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)
@@ -167,12 +174,13 @@
}
/**
- * Kill a process
+ * Kill a process.
* @param exe The process handle to control
*
* 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)
@@ -187,13 +195,14 @@
}
/**
- * Send a user signal to a process
+ * Send a user signal to a process.
* @param exe The process handle to control
* @param num The signal number to send to the process
*
* 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)
@@ -211,10 +220,11 @@
}
/**
- * Send a HUP signal to a process
+ * Send a HUP signal to a process.
* @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)
===================================================================
RCS file:
/cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Attic/ecore_idle_enterer.c,v
retrieving revision 1.1.2.5
retrieving revision 1.1.2.6
diff -u -3 -r1.1.2.5 -r1.1.2.6
--- ecore_idle_enterer.c 20 Feb 2003 06:56:40 -0000 1.1.2.5
+++ ecore_idle_enterer.c 27 Feb 2003 01:58:11 -0000 1.1.2.6
@@ -5,7 +5,7 @@
static int idle_enterers_delete_me = 0;
/**
- * Add an idle enterer handler
+ * Add an idle enterer handler.
* @param func The function to call when entering an idle state.
* @param data The data to be passed to the @p func call
* @return A handle to the idle enterer callback
@@ -18,6 +18,7 @@
* 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)
@@ -35,13 +36,14 @@
}
/**
- * Delete an idle enter handler
+ * Delete an idle enter handler.
* @param idle_enterer The idle enterer to delete
*
* Delete the specified @p idle_enterer from the set of idle_enterers that are
* 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)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Attic/ecore_idler.c,v
retrieving revision 1.1.2.5
retrieving revision 1.1.2.6
diff -u -3 -r1.1.2.5 -r1.1.2.6
--- ecore_idler.c 20 Feb 2003 06:56:40 -0000 1.1.2.5
+++ ecore_idler.c 27 Feb 2003 01:58:11 -0000 1.1.2.6
@@ -5,7 +5,7 @@
static int idlers_delete_me = 0;
/**
- * Add an idler handler
+ * 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
@@ -19,6 +19,7 @@
* 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)
@@ -36,13 +37,14 @@
}
/**
- * Delete an idler handler
+ * Delete an idler handler.
* @param idler The idler to delete
*
* Delete the specified @p idler from the set of idlers that are executed
* 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)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Attic/ecore_main.c,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -u -3 -r1.1.2.8 -r1.1.2.9
--- ecore_main.c 27 Feb 2003 01:03:46 -0000 1.1.2.8
+++ ecore_main.c 27 Feb 2003 01:58:11 -0000 1.1.2.9
@@ -17,12 +17,13 @@
static int fd_handlers_delete_me = 0;
/**
- * Run the application main loop
+ * Run the application main loop.
*
* This function does not return until ecore_main_loop_quit() is called. It
* 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)
@@ -148,11 +149,12 @@
}
/**
- * Quit the main loop after it is done processing
+ * Quit the main loop after it is done processing.
*
* 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)
@@ -161,7 +163,7 @@
}
/**
- * Add a handler for read/write notification of a file descriptor
+ * Add a handler for read/write notification of a file descriptor.
* @param fd The file descriptor to watch
* @param flags To watch it for read and/or write ability
* @param func The function to call when the file descriptor becomes active
@@ -189,6 +191,7 @@
* 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)
(Ecore_Fd_Handler *fd_handler, void *data), const void *data, int (*buf_func)
(Ecore_Fd_Handler *fd_handler, void *buf_data), const void *buf_data)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Attic/ecore_time.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -3 -r1.1.2.1 -r1.1.2.2
--- ecore_time.c 16 Jan 2003 08:48:51 -0000 1.1.2.1
+++ ecore_time.c 27 Feb 2003 01:58:12 -0000 1.1.2.2
@@ -4,12 +4,13 @@
#include <sys/time.h>
/**
- * Get the current system time as a floating point value in seconds
+ * Get the current system time as a floating point value in seconds.
* @return The current time (since the epoch start) in seconds
*
* 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)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Attic/ecore_timer.c,v
retrieving revision 1.1.2.9
retrieving revision 1.1.2.10
diff -u -3 -r1.1.2.9 -r1.1.2.10
--- ecore_timer.c 27 Feb 2003 01:03:46 -0000 1.1.2.9
+++ ecore_timer.c 27 Feb 2003 01:58:12 -0000 1.1.2.10
@@ -9,7 +9,7 @@
static Ecore_Timer *timers = NULL;
/**
- * Add a timer to tick off in a specified time during main loop execution
+ * Add a timer to tick off in a specified time during main loop execution.
* @param in The number of seconds in which to expire the timer
* @param func The function to call when it expires
* @param data The data to pass to the function
@@ -63,6 +63,7 @@
* 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)
@@ -81,7 +82,7 @@
}
/**
- * Delete the specified timer from the timer list
+ * Delete the specified timer from the timer list.
* @param timer
* @return The data pointer set for the timer
*
@@ -90,6 +91,7 @@
* 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)
-------------------------------------------------------
This SF.net email is sponsored by: Scholarships for Techies!
Can't afford IT training? All 2003 ictp students receive scholarships.
Get hands-on training in Microsoft, Cisco, Sun, Linux/UNIX, and more.
www.ictp.com/training/sourceforge.asp
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
