summaryrefslogtreecommitdiff
path: root/src/lib/ecore/ecore_timer.eo
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-08 17:36:23 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-08 17:36:32 +0100
commitd8a56d03a913d7f58e459e20da68a8ed0aa3d80d (patch)
tree5cf7c2051e149c39376852a5e5e53356e84477e0 /src/lib/ecore/ecore_timer.eo
parent1a317196ae12fa483fba57e8cfc5cb5108b54d06 (diff)
ecore: move eo docs to new format
Diffstat (limited to '')
-rw-r--r--src/lib/ecore/ecore_timer.eo69
1 files changed, 40 insertions, 29 deletions
diff --git a/src/lib/ecore/ecore_timer.eo b/src/lib/ecore/ecore_timer.eo
index ff39697637..b1cfee19b9 100644
--- a/src/lib/ecore/ecore_timer.eo
+++ b/src/lib/ecore/ecore_timer.eo
@@ -1,67 +1,78 @@
1class Ecore.Timer (Eo.Base) 1class Ecore.Timer (Eo.Base)
2{ 2{
3 /*@ Timers are objects that will call a given callback at some point 3 [[Timers are objects that will call a given callback at some point
4 * in the future. They may also optionall repeat themselves if the 4 in the future.
5 * timer callback returns true. If it does not they will be 5
6 * automatically deleted and never called again. Timers require the 6 They may also optionall repeat themselves if the timer callback returns
7 * ecore mainloop to be running and functioning properly. They do not 7 true. If it does not they will be automatically deleted and never called
8 * guarantee exact timing, but try to work on a "best effort basis. 8 again. Timers require the ecore mainloop to be running and functioning
9 */ 9 properly. They do not guarantee exact timing, but try to work on a "best
10 effort basis.
11 ]]
10 eo_prefix: ecore_obj_timer; 12 eo_prefix: ecore_obj_timer;
11 methods { 13 methods {
12 @property interval { 14 @property interval {
13 set { 15 set {
14 /*@ Change the interval the timer ticks off. If set during 16 [[Change the interval the timer ticks off. If set during
15 * a timer call, this will affect the next interval. 17 a timer call, this will affect the next interval.
16 */ 18 ]]
17 } 19 }
18 get { 20 get {
19 /*@ Get the interval the timer ticks on. */ 21 [[Get the interval the timer ticks on.]]
20 } 22 }
21 values { 23 values {
22 in: double(-1); /*@ The new interval in seconds */ 24 in: double(-1); [[The new interval in seconds]]
23 } 25 }
24 } 26 }
25 @property pending { 27 @property pending {
26 get { 28 get {
27 /*@ Get the pending time regarding a timer. */ 29 [[Get the pending time regarding a timer.]]
28 return: double; 30 return: double;
29 } 31 }
30 } 32 }
31 loop_constructor { 33 loop_constructor {
32 /*@ Create a timer to call in a given time from now */ 34 [[Create a timer to call in a given time from now]]
33 legacy: null; 35 legacy: null;
34 params { 36 params {
35 @in in: double; /*@ The time, in seconds, from now when to go off */ 37 @in in: double; [[The time, in seconds, from now when to go off]]
36 @in func: Ecore_Task_Cb; /*@ The callback function to call when the timer goes off */ 38 @in func: Ecore_Task_Cb; [[The callback function to call when the
37 @in data: const(void)*; /*@ A pointer to pass to the callback function as its data pointer */ 39 timer goes off]]
40 @in data: const(void)*; [[A pointer to pass to the callback function
41 as its data pointer]]
38 } 42 }
39 } 43 }
40 constructor { 44 constructor {
41 /*@ Create a timer to call in a given time from when the mainloop woke up from sleep */ 45 [[Create a timer to call in a given time from when the mainloop woke
46 up from sleep]]
42 legacy: null; 47 legacy: null;
43 params { 48 params {
44 @in in: double; /*@ The time, in seconds, from when the main loop woke up, to go off */ 49 @in in: double; [[The time, in seconds, from when the main loop
45 @in func: Ecore_Task_Cb; /*@ The callback function to call when the timer goes off */ 50 woke up, to go off]]
46 @in data: const(void)*; /*@ A pointer to pass to the callback function as its data pointer */ 51 @in func: Ecore_Task_Cb; [[The callback function to call when the
52 timer goes off]]
53 @in data: const(void)*; [[A pointer to pass to the callback
54 function as its data pointer]]
47 } 55 }
48 } 56 }
49 reset { 57 reset {
50 /*@ Reset a timer to its full interval. This effectively makes 58 /* FIXME-doc:
51 * the timer start ticking off from zero now. 59 * @note This is equivalent to (but faster than)
52 * @note This is equivalent to (but faster than)
53 * @code 60 * @code
54 * ecore_timer_delay(timer, ecore_timer_interval_get(timer) - ecore_timer_pending_get(timer)); 61 * ecore_timer_delay(timer, ecore_timer_interval_get(timer) - ecore_timer_pending_get(timer));
55 * @endcode 62 * @endcode
56 * @since 1.2
57 */ 63 */
64 [[Reset a timer to its full interval. This effectively makes the
65 timer start ticking off from zero now.
66
67 @since 1.2
68 ]]
58 } 69 }
59 delay { 70 delay {
60 /*@ Add some delay for the next occurrence of a timer. 71 [[Add some delay for the next occurrence of a timer.
61 * This doesn't affect the interval of a timer. 72 This doesn't affect the interval of a timer.
62 */ 73 ]]
63 params { 74 params {
64 @in add: double; /*@ The amount of time to delay the timer by in seconds */ 75 @in add: double; [[The amount of time to delay the timer by in seconds]]
65 } 76 }
66 } 77 }
67 } 78 }