Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore
Modified Files:
Ecore.h ecore_time.c ecore_timer.c
Log Message:
Ecore_Con module documentation, timer functions cleaned up, Time functions linked into
Ecore.h docs.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Ecore.h,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -3 -r1.16 -r1.17
--- Ecore.h 23 Sep 2004 04:05:13 -0000 1.16
+++ Ecore.h 23 Sep 2004 04:58:16 -0000 1.17
@@ -13,6 +13,8 @@
* and event handlers. Events for file descriptor events are covered in
* @ref Ecore_FD_Handler_Group.
*
+ * Time functions are covered in @ref Ecore_Time_Group.
+ *
* There is also provision for callbacks for when the loop enters or
* exits an idle state. See @ref Idle_Group for more information.
*
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_time.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- ecore_time.c 20 Feb 2004 07:06:25 -0000 1.3
+++ ecore_time.c 23 Sep 2004 04:58:16 -0000 1.4
@@ -4,12 +4,9 @@
#include <sys/time.h>
/**
- * 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.
+ * Retrieves the current system time as a floating point value in seconds.
+ * @return The number of seconds since 12.00AM 1st January 1970.
+ * @ingroup Ecore_Time_Group
*/
double
ecore_time_get(void)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_timer.c,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- ecore_timer.c 5 Sep 2004 08:00:10 -0000 1.7
+++ ecore_timer.c 23 Sep 2004 04:58:16 -0000 1.8
@@ -8,26 +8,20 @@
static Ecore_Timer *timers = NULL;
/**
- * 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
- * @return A handle to the new timer
- * @ingroup Ecore_Timer_Group
- *
- * This function adds a timer and returns its handle on success and NULL on
- * failure. The function @p func will be called in @p in seconds from the
- * time this function call was made. The function @p func is passed the
- * @p data pointer as its parameter.
- *
- * When the timer @p func is called, it must return a value of either 1 or 0.
- * If it returns 1, it will be re-scheduled to repeat in the same interval
- * after this timer was triggered (ie if this timer was triggered with an
- * @p in value of 1.0 then the next timer will be triggered at the time this
- * timer was called plus 1.0).
- *
- * For more information, see the @link timer_example.c ecore_timer @endlink
- * example.
+ * @defgroup Ecore_Time_Group Ecore Time Functions
+ *
+ * Functions that deal with time. These functions include those that simply
+ * retrieve it in a given format, and those that create events based on it.
+ */
+
+/**
+ * Creates a timer to call the given function in the given period of time.
+ * @param in The interval in seconds.
+ * @param func The given function. If @p func returns 1, the timer is
+ * rescheduled for the next interval @p in.
+ * @param data Data to pass to @p func when it is called.
+ * @return A timer object on success. @c NULL on failure.
+ * @ingroup Ecore_Time_Group
*/
Ecore_Timer *
ecore_timer_add(double in, int (*func) (void *data), const void *data)
@@ -47,15 +41,10 @@
/**
* Delete the specified timer from the timer list.
- * @param timer The timer to delete
- * @return The data pointer set for the timer
- * @ingroup Ecore_Timer_Group
- *
- * Delete the specified @p timer from the set of timers 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 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.
+ * @param timer The timer to delete.
+ * @return The data pointer set for the timer when @ref ecore_timer_add was
+ * called. @c NULL is returned if the function is unsuccessful.
+ * @ingroup Ecore_Time_Group
*/
void *
ecore_timer_del(Ecore_Timer *timer)
-------------------------------------------------------
This SF.Net email is sponsored by: YOU BE THE JUDGE. Be one of 170
Project Admins to receive an Apple iPod Mini FREE for your judgement on
who ports your project to Linux PPC the best. Sponsored by IBM.
Deadline: Sept. 24. Go here: http://sf.net/ppc_contest.php
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
