kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ecore: move eo docs to new format

This commit is contained in:
Daniel Kolesa 2015-06-08 17:36:23 +01:00
parent 1a317196ae
commit d8a56d03a9
7 changed files with 58 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/lib/ecore/ecore_animator.eo
View File

@ -3,7 +3,7 @@ class Ecore.Animator (Eo.Base)
eo_prefix: ecore_animator;
methods {
timeline_constructor {
/*@ Constructor. */
[[Constructor.]]
legacy: null;
params {
@in runtime: double;
@ -12,7 +12,7 @@ class Ecore.Animator (Eo.Base)
}
}
constructor {
/*@ Constructor. */
[[Constructor.]]
legacy: null;
params {
@in func: Ecore_Task_Cb;

6
src/lib/ecore/ecore_exe.eo
View File

@ -3,7 +3,7 @@ class Ecore.Exe (Eo.Base, Efl.Control)
eo_prefix: ecore_obj_exe;
methods {
@property command {
/*@ Control the command that's executed. FIXME: May need a split/rename. */
[[Control the command that's executed. FIXME: May need a split/rename.]]
set {
legacy: null;
}
@ -11,8 +11,8 @@ class Ecore.Exe (Eo.Base, Efl.Control)
legacy: null;
}
values {
exe_cmd: const(char) *; /*@ The command to execute. */
flags: Ecore_Exe_Flags; /*@ The execution flags. */
exe_cmd: const(char) *; [[The command to execute.]]
flags: Ecore_Exe_Flags; [[The execution flags.]]
}
}
}

4
src/lib/ecore/ecore_idle_enterer.eo
View File

@ -3,7 +3,7 @@ class Ecore.Idle.Enterer (Eo.Base)
eo_prefix: ecore_idle_enterer;
methods {
before_constructor {
/*@ Contructor. Will insert the handler at the beginning of the list. */
[[Contructor. Will insert the handler at the beginning of the list.]]
legacy: null;
params {
@in func: Ecore_Task_Cb;
@ -11,7 +11,7 @@ class Ecore.Idle.Enterer (Eo.Base)
}
}
after_constructor {
/*@ Contructor. Will insert the handler at the end of the list. */
[[Contructor. Will insert the handler at the end of the list.]]
legacy: null;
params {
@in func: Ecore_Task_Cb;

2
src/lib/ecore/ecore_idler.eo
View File

@ -3,7 +3,7 @@ class Ecore.Idler (Eo.Base)
eo_prefix: ecore_idler;
methods {
constructor {
/*@ Constructor. */
[[Constructor.]]
legacy: null;
params {
@in func: Ecore_Task_Cb;

2
src/lib/ecore/ecore_job.eo
View File

@ -3,7 +3,7 @@ class Ecore.Job (Eo.Base)
eo_prefix: ecore_job;
methods {
constructor {
/*@ Constructor. */
[[Constructor.]]
legacy: null;
params {
@in func: Ecore_Cb;

22
src/lib/ecore/ecore_poller.eo
View File

@ -2,7 +2,7 @@ class Ecore.Poller (Eo.Base)
{
methods {
constructor {
/*@ Constructor with parameters for Ecore Poller. */
[[Constructor with parameters for Ecore Poller.]]
legacy: null;
params {
@in type: Ecore_Poller_Type;
@ -13,25 +13,21 @@ class Ecore.Poller (Eo.Base)
}
@property interval {
set {
/*@
@brief Changes the polling interval rate of @p poller.
@return Returns true on success, false on failure.
[[Changes the polling interval rate of the poller.
This allows the changing of a poller's polling interval. It is useful when
you want to alter a poll rate without deleting and re-creating a poller. */
This allows the changing of a poller's polling interval. It is
useful when you want to alter a poll rate without deleting and
re-creating a poller.
]]
legacy: ecore_poller_poller_interval_set;
return: bool;
return: bool; [[true on success, false on failure.]]
}
get {
/*@
@brief Gets the polling interval rate of @p poller.
@return Returns the interval, in ticks, that @p poller polls at.
This returns a poller's polling interval, or 0 on error. */
[[Gets the polling interval rate of the poller.]]
legacy: ecore_poller_poller_interval_get;
}
values {
interval: int; /*@ The tick interval to set; must be a power of 2 and <= 32768. */
interval: int; [[The tick interval; must be a power of 2 and <= 32768.]]
}
}
}

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

@ -1,67 +1,78 @@
class Ecore.Timer (Eo.Base)
{
/*@ Timers are objects that will call a given callback at some point
* in the future. They may also optionall repeat themselves if the
* timer callback returns true. If it does not they will be
* automatically deleted and never called again. Timers require the
* ecore mainloop to be running and functioning properly. They do not
* guarantee exact timing, but try to work on a "best effort basis.
*/
[[Timers are objects that will call a given callback at some point
in the future.
They may also optionall repeat themselves if the timer callback returns
true. If it does not they will be automatically deleted and never called
again. Timers require the ecore mainloop to be running and functioning
properly. They do not guarantee exact timing, but try to work on a "best
effort basis.
]]
eo_prefix: ecore_obj_timer;
methods {
@property interval {
set {
/*@ Change the interval the timer ticks off. If set during
* a timer call, this will affect the next interval.
*/
[[Change the interval the timer ticks off. If set during
a timer call, this will affect the next interval.
]]
}
get {
/*@ Get the interval the timer ticks on. */
[[Get the interval the timer ticks on.]]
}
values {
in: double(-1); /*@ The new interval in seconds */
in: double(-1); [[The new interval in seconds]]
}
}
@property pending {
get {
/*@ Get the pending time regarding a timer. */
[[Get the pending time regarding a timer.]]
return: double;
}
}
loop_constructor {
/*@ Create a timer to call in a given time from now */
[[Create a timer to call in a given time from now]]
legacy: null;
params {
@in in: double; /*@ The time, in seconds, from now when to go off */
@in func: Ecore_Task_Cb; /*@ The callback function to call when the timer goes off */
@in data: const(void)*; /*@ A pointer to pass to the callback function as its data pointer */
@in in: double; [[The time, in seconds, from now when to go off]]
@in func: Ecore_Task_Cb; [[The callback function to call when the
timer goes off]]
@in data: const(void)*; [[A pointer to pass to the callback function
as its data pointer]]
}
}
constructor {
/*@ Create a timer to call in a given time from when the mainloop woke up from sleep */
[[Create a timer to call in a given time from when the mainloop woke
up from sleep]]
legacy: null;
params {
@in in: double; /*@ The time, in seconds, from when the main loop woke up, to go off */
@in func: Ecore_Task_Cb; /*@ The callback function to call when the timer goes off */
@in data: const(void)*; /*@ A pointer to pass to the callback function as its data pointer */
@in in: double; [[The time, in seconds, from when the main loop
woke up, to go off]]
@in func: Ecore_Task_Cb; [[The callback function to call when the
timer goes off]]
@in data: const(void)*; [[A pointer to pass to the callback
function as its data pointer]]
}
}
reset {
/*@ Reset a timer to its full interval. This effectively makes
* the timer start ticking off from zero now.
* @note This is equivalent to (but faster than)
/* FIXME-doc:
* @note This is equivalent to (but faster than)
* @code
* ecore_timer_delay(timer, ecore_timer_interval_get(timer) - ecore_timer_pending_get(timer));
* @endcode
* @since 1.2
*/
[[Reset a timer to its full interval. This effectively makes the
timer start ticking off from zero now.
@since 1.2
]]
}
delay {
/*@ Add some delay for the next occurrence of a timer.
* This doesn't affect the interval of a timer.
*/
[[Add some delay for the next occurrence of a timer.
This doesn't affect the interval of a timer.
]]
params {
@in add: double; /*@ The amount of time to delay the timer by in seconds */
@in add: double; [[The amount of time to delay the timer by in seconds]]
}
}
}