enlightenment/efl
enlightenment
/
efl
8
7
Fork 15
Code Issues 12 Pull Requests 1 Projects Releases Wiki Activity

eo ecore timer - improve documentation in the eo file

This commit is contained in:
Carsten Haitzler 2014-05-12 19:11:14 +09:00
parent b8413c880a
commit 676a42f4b7
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/lib/ecore/ecore_timer.eo
View File

@ -3,32 +3,32 @@ class Ecore_Timer (Eo_Base)
eo_prefix: ecore_obj_timer; eo_prefix: ecore_obj_timer;
constructors { constructors {
loop_constructor { loop_constructor {
/*@ Contructor. */ /*@ Create a timer to call in a given time from now */
params { params {
@in double in; @in double in; /*@ The time, in seconds, from now when to go off */
@in Ecore_Task_Cb func; @in Ecore_Task_Cb func; /*@ The callback function to call when the timer goes off */
@in const void *data; @in const void *data; /*@ A pointer to pass to the callback function as its data pointer */
} }
} }
constructor { constructor {
/*@ Contructor. */ /*@ Create a timer to call in a given time from when the mainloop woke up from sleep */
params { params {
@in double in; @in double in; /*@ The time, in seconds, from when the main loop woke up, to go off */
@in Ecore_Task_Cb func; @in Ecore_Task_Cb func; /*@ The callback function to call when the timer goes off */
@in const void *data; @in const void *data; /*@ A pointer to pass to the callback function as its data pointer */
} }
} }
} }
properties { properties {
interval { interval {
set { set {
/*@ Change the interval the timer ticks of. */ /*@ Change the interval the timer ticks off. */
} }
get { get {
/*@ Get the interval the timer ticks on. */ /*@ Get the interval the timer ticks on. */
} }
values { values {
double in; double in; /*@ The new interval in seconds */
} }
} }
pending { pending {
@ -40,12 +40,13 @@ class Ecore_Timer (Eo_Base)
} }
methods { methods {
reset { 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 { delay {
/*@ Add some delay for the next occurrence of a timer. */ /*@ Add some delay for the next occurrence of a timer. */
params { params {
@in double add; @in double add; /*@ The amount of time to delay the timer by in seconds */
} }
} }
} }