raster pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=676a42f4b7f77ea153b8b2a8eddb16db9de665da
commit 676a42f4b7f77ea153b8b2a8eddb16db9de665da Author: Carsten Haitzler (Rasterman) <[email protected]> Date: Mon May 12 19:11:14 2014 +0900 eo ecore timer - improve documentation in the eo file --- src/lib/ecore/ecore_timer.eo | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/src/lib/ecore/ecore_timer.eo b/src/lib/ecore/ecore_timer.eo index c0173b4..fb72e22 100644 --- a/src/lib/ecore/ecore_timer.eo +++ b/src/lib/ecore/ecore_timer.eo @@ -3,32 +3,32 @@ class Ecore_Timer (Eo_Base) eo_prefix: ecore_obj_timer; constructors { loop_constructor { - /*@ Contructor. */ + /*@ Create a timer to call in a given time from now */ params { - @in double in; - @in Ecore_Task_Cb func; - @in const void *data; + @in double in; /*@ The time, in seconds, from now when to go off */ + @in Ecore_Task_Cb func; /*@ The callback function to call when the timer goes off */ + @in const void *data; /*@ A pointer to pass to the callback function as its data pointer */ } } constructor { - /*@ Contructor. */ + /*@ Create a timer to call in a given time from when the mainloop woke up from sleep */ params { - @in double in; - @in Ecore_Task_Cb func; - @in const void *data; + @in double in; /*@ The time, in seconds, from when the main loop woke up, to go off */ + @in Ecore_Task_Cb func; /*@ The callback function to call when the timer goes off */ + @in const void *data; /*@ A pointer to pass to the callback function as its data pointer */ } } } properties { interval { set { - /*@ Change the interval the timer ticks of. */ + /*@ Change the interval the timer ticks off. */ } get { /*@ Get the interval the timer ticks on. */ } values { - double in; + double in; /*@ The new interval in seconds */ } } pending { @@ -40,12 +40,13 @@ class Ecore_Timer (Eo_Base) } methods { reset { - /*@ Reset a timer to its full interval. */ + /*@ Reset a timer to its full interval. This effectively makes + * the timer start ticking off from zero now. */ } delay { /*@ Add some delay for the next occurrence of a timer. */ params { - @in double add; + @in double add; /*@ The amount of time to delay the timer by in seconds */ } } } @@ -56,4 +57,4 @@ class Ecore_Timer (Eo_Base) Eo_Base::event_freeze::get; Eo_Base::event_thaw; } -} \ No newline at end of file +} --
