summaryrefslogtreecommitdiff
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
parent1a317196ae12fa483fba57e8cfc5cb5108b54d06 (diff)
ecore: move eo docs to new format
-rw-r--r--src/lib/ecore/ecore_animator.eo4
-rw-r--r--src/lib/ecore/ecore_exe.eo6
-rw-r--r--src/lib/ecore/ecore_idle_enterer.eo4
-rw-r--r--src/lib/ecore/ecore_idler.eo2
-rw-r--r--src/lib/ecore/ecore_job.eo2
-rw-r--r--src/lib/ecore/ecore_poller.eo22
-rw-r--r--src/lib/ecore/ecore_timer.eo69
7 files changed, 58 insertions, 51 deletions
diff --git a/src/lib/ecore/ecore_animator.eo b/src/lib/ecore/ecore_animator.eo
index ff1e21db32..eb0e183134 100644
--- a/src/lib/ecore/ecore_animator.eo
+++ b/src/lib/ecore/ecore_animator.eo
@@ -3,7 +3,7 @@ class Ecore.Animator (Eo.Base)
3 eo_prefix: ecore_animator; 3 eo_prefix: ecore_animator;
4 methods { 4 methods {
5 timeline_constructor { 5 timeline_constructor {
6 /*@ Constructor. */ 6 [[Constructor.]]
7 legacy: null; 7 legacy: null;
8 params { 8 params {
9 @in runtime: double; 9 @in runtime: double;
@@ -12,7 +12,7 @@ class Ecore.Animator (Eo.Base)
12 } 12 }
13 } 13 }
14 constructor { 14 constructor {
15 /*@ Constructor. */ 15 [[Constructor.]]
16 legacy: null; 16 legacy: null;
17 params { 17 params {
18 @in func: Ecore_Task_Cb; 18 @in func: Ecore_Task_Cb;
diff --git a/src/lib/ecore/ecore_exe.eo b/src/lib/ecore/ecore_exe.eo
index a1aeb52b9d..d8b630a94a 100644
--- a/src/lib/ecore/ecore_exe.eo
+++ b/src/lib/ecore/ecore_exe.eo
@@ -3,7 +3,7 @@ class Ecore.Exe (Eo.Base, Efl.Control)
3 eo_prefix: ecore_obj_exe; 3 eo_prefix: ecore_obj_exe;
4 methods { 4 methods {
5 @property command { 5 @property command {
6 /*@ Control the command that's executed. FIXME: May need a split/rename. */ 6 [[Control the command that's executed. FIXME: May need a split/rename.]]
7 set { 7 set {
8 legacy: null; 8 legacy: null;
9 } 9 }
@@ -11,8 +11,8 @@ class Ecore.Exe (Eo.Base, Efl.Control)
11 legacy: null; 11 legacy: null;
12 } 12 }
13 values { 13 values {
14 exe_cmd: const(char) *; /*@ The command to execute. */ 14 exe_cmd: const(char) *; [[The command to execute.]]
15 flags: Ecore_Exe_Flags; /*@ The execution flags. */ 15 flags: Ecore_Exe_Flags; [[The execution flags.]]
16 } 16 }
17 } 17 }
18 } 18 }
diff --git a/src/lib/ecore/ecore_idle_enterer.eo b/src/lib/ecore/ecore_idle_enterer.eo
index f3cb6899ea..4f975ed08a 100644
--- a/src/lib/ecore/ecore_idle_enterer.eo
+++ b/src/lib/ecore/ecore_idle_enterer.eo
@@ -3,7 +3,7 @@ class Ecore.Idle.Enterer (Eo.Base)
3 eo_prefix: ecore_idle_enterer; 3 eo_prefix: ecore_idle_enterer;
4 methods { 4 methods {
5 before_constructor { 5 before_constructor {
6 /*@ Contructor. Will insert the handler at the beginning of the list. */ 6 [[Contructor. Will insert the handler at the beginning of the list.]]
7 legacy: null; 7 legacy: null;
8 params { 8 params {
9 @in func: Ecore_Task_Cb; 9 @in func: Ecore_Task_Cb;
@@ -11,7 +11,7 @@ class Ecore.Idle.Enterer (Eo.Base)
11 } 11 }
12 } 12 }
13 after_constructor { 13 after_constructor {
14 /*@ Contructor. Will insert the handler at the end of the list. */ 14 [[Contructor. Will insert the handler at the end of the list.]]
15 legacy: null; 15 legacy: null;
16 params { 16 params {
17 @in func: Ecore_Task_Cb; 17 @in func: Ecore_Task_Cb;
diff --git a/src/lib/ecore/ecore_idler.eo b/src/lib/ecore/ecore_idler.eo
index ed6debbe74..56ae81199c 100644
--- a/src/lib/ecore/ecore_idler.eo
+++ b/src/lib/ecore/ecore_idler.eo
@@ -3,7 +3,7 @@ class Ecore.Idler (Eo.Base)
3 eo_prefix: ecore_idler; 3 eo_prefix: ecore_idler;
4 methods { 4 methods {
5 constructor { 5 constructor {
6 /*@ Constructor. */ 6 [[Constructor.]]
7 legacy: null; 7 legacy: null;
8 params { 8 params {
9 @in func: Ecore_Task_Cb; 9 @in func: Ecore_Task_Cb;
diff --git a/src/lib/ecore/ecore_job.eo b/src/lib/ecore/ecore_job.eo
index 3f7082e235..e9c4cd89b7 100644
--- a/src/lib/ecore/ecore_job.eo
+++ b/src/lib/ecore/ecore_job.eo
@@ -3,7 +3,7 @@ class Ecore.Job (Eo.Base)
3 eo_prefix: ecore_job; 3 eo_prefix: ecore_job;
4 methods { 4 methods {
5 constructor { 5 constructor {
6 /*@ Constructor. */ 6 [[Constructor.]]
7 legacy: null; 7 legacy: null;
8 params { 8 params {
9 @in func: Ecore_Cb; 9 @in func: Ecore_Cb;
diff --git a/src/lib/ecore/ecore_poller.eo b/src/lib/ecore/ecore_poller.eo
index b427d47028..92fb30f96c 100644
--- a/src/lib/ecore/ecore_poller.eo
+++ b/src/lib/ecore/ecore_poller.eo
@@ -2,7 +2,7 @@ class Ecore.Poller (Eo.Base)
2{ 2{
3 methods { 3 methods {
4 constructor { 4 constructor {
5 /*@ Constructor with parameters for Ecore Poller. */ 5 [[Constructor with parameters for Ecore Poller.]]
6 legacy: null; 6 legacy: null;
7 params { 7 params {
8 @in type: Ecore_Poller_Type; 8 @in type: Ecore_Poller_Type;
@@ -13,25 +13,21 @@ class Ecore.Poller (Eo.Base)
13 } 13 }
14 @property interval { 14 @property interval {
15 set { 15 set {
16 /*@ 16 [[Changes the polling interval rate of the poller.
17 @brief Changes the polling interval rate of @p poller.
18 @return Returns true on success, false on failure.
19 17
20 This allows the changing of a poller's polling interval. It is useful when 18 This allows the changing of a poller's polling interval. It is
21 you want to alter a poll rate without deleting and re-creating a poller. */ 19 useful when you want to alter a poll rate without deleting and
20 re-creating a poller.
21 ]]
22 legacy: ecore_poller_poller_interval_set; 22 legacy: ecore_poller_poller_interval_set;
23 return: bool; 23 return: bool; [[true on success, false on failure.]]
24 } 24 }
25 get { 25 get {
26 /*@ 26 [[Gets the polling interval rate of the poller.]]
27 @brief Gets the polling interval rate of @p poller.
28 @return Returns the interval, in ticks, that @p poller polls at.
29
30 This returns a poller's polling interval, or 0 on error. */
31 legacy: ecore_poller_poller_interval_get; 27 legacy: ecore_poller_poller_interval_get;
32 } 28 }
33 values { 29 values {
34 interval: int; /*@ The tick interval to set; must be a power of 2 and <= 32768. */ 30 interval: int; [[The tick interval; must be a power of 2 and <= 32768.]]
35 } 31 }
36 } 32 }
37 } 33 }
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 }