summaryrefslogtreecommitdiff
path: root/src/lib/ecore
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-07-08 16:56:49 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-07-08 17:48:57 +0200
commit10acaa67d9e9fc065127dc09dc3f2f48988f811a (patch)
tree59b7d7099e868db147b8f996b7587be2d7aea1ec /src/lib/ecore
parent25ef604467b083d1f5ff2c7f9a1a82e660e04443 (diff)
docs: Fill last missing docs from EO files
Some docs have been filled with placeholder text ("TBD") or with preliminary text (marked with //TODO). Having 0 doc warning we can now enable Warnings as Errors in mono, and in Eolian later on.
Diffstat (limited to 'src/lib/ecore')
-rw-r--r--src/lib/ecore/efl_exe.eo55
-rw-r--r--src/lib/ecore/efl_task.eo48
2 files changed, 54 insertions, 49 deletions
diff --git a/src/lib/ecore/efl_exe.eo b/src/lib/ecore/efl_exe.eo
index cd71af6a0c..823858e4a3 100644
--- a/src/lib/ecore/efl_exe.eo
+++ b/src/lib/ecore/efl_exe.eo
@@ -1,59 +1,62 @@
1enum @beta Efl.Exe_Signal { 1enum @beta Efl.Exe_Signal {
2 [[ ]] 2 [[Signal is a notification, a message sent by either operating system or some application to our program.
3 int, 3 Signals are a mechanism for one-way asynchronous notifications. A signal may be sent from the kernel to
4 quit, 4 a process, from a process to another process, or from a process to itself. Signal typically alert a
5 term, 5 process to some event, such as a segmentation fault, or the user pressing Ctrl-C.]]
6 kill, 6 int, [[Terminal interrupt.]]
7 cont, 7 quit, [[Terminal quit.]]
8 stop, 8 term, [[Termination.]]
9 hup, 9 kill, [[Kill(can't be caught or ignored).]]
10 usr1, 10 cont, [[Continue executing, if stopped.]]
11 usr2 11 stop, [[Stop executing(can't be caught or ignored).]]
12 hup, [[Hangup.]]
13 usr1, [[User defined signal 1.]]
14 usr2 [[User defined signal 2.]]
12} 15}
13 16
14enum @beta Efl.Exe_Flags { 17enum @beta Efl.Exe_Flags {
15 [[ ]] 18 [[Flags to customize task behavior.]] // TODO: This needs more detail.
16 none = 0, 19 none = 0, [[No special flags.]]
17 group_leader = 1, 20 group_leader = 1, [[Process will be executed in its own session.]]
18 exit_with_parent = 2, 21 exit_with_parent = 2, [[Exit process when parent process exits.]]
19 hide_io = 4 22 hide_io = 4 [[All console IO will be hidden.]]
20} 23}
21 24
22class @beta Efl.Exe extends Efl.Task implements Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line 25class @beta Efl.Exe extends Efl.Task implements Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line
23{ 26{
24 [[ ]] 27 [[Further customization of @Efl.Task, including signals and environment control.]] // TODO: This needs more detail
25 methods { 28 methods {
26 signal { 29 signal {
30 [[Send a signal to this task.]]
27 params { 31 params {
28 sig: Efl.Exe_Signal; [[ Send this signal to the task ]] 32 sig: Efl.Exe_Signal; [[Signal number to send.]]
29 } 33 }
30 } 34 }
31 @property exe_flags { 35 @property exe_flags {
36 [[Customize the task's behavior.]]
32 set { } 37 set { }
33 get { } 38 get { }
34 values { 39 values {
35 flags: Efl.Exe_Flags; [[ ]] 40 flags: Efl.Exe_Flags; [[Flags.]]
36 } 41 }
37 } 42 }
38 @property exit_signal { 43 @property exit_signal {
39 [[ The final exit signal of this task. ]] 44 [[The final exit signal of this task.]]
40 get { } 45 get { }
41 values { 46 values {
42 sig: int; [[ The exit signal, or -1 if no exit signal happened ]] 47 sig: int; [[The exit signal, or -1 if no exit signal happened.]]
43 } 48 }
44 } 49 }
45 @property env { 50 @property env {
46 [[ If $env is $null then the process created by this object is 51 [[If $env is $null then the process created by this object is
47 going to inherit the environment of this process. 52 going to inherit the environment of this process.
48 53
49 In case $env is not $null then the environment variables declared 54 In case $env is not $null then the environment variables declared
50 in this object will represent the environment passed to the new process. 55 in this object will represent the environment passed to the new process.
51 ]] 56 ]]
52 get { 57 get {
53 [[ Get the object assosiated with this object ]]
54 } 58 }
55 set { 59 set {
56 [[ Set the object assosiated with this object ]]
57 } 60 }
58 values { 61 values {
59 env : Efl.Core.Env; [[$env will be referenced until this object does not need it anymore.]] 62 env : Efl.Core.Env; [[$env will be referenced until this object does not need it anymore.]]
diff --git a/src/lib/ecore/efl_task.eo b/src/lib/ecore/efl_task.eo
index 9731bebe2f..2d1c7dfe60 100644
--- a/src/lib/ecore/efl_task.eo
+++ b/src/lib/ecore/efl_task.eo
@@ -1,60 +1,62 @@
1enum Efl.Task_Priority { 1enum Efl.Task_Priority {
2 [[ 2 [[How much processor time will this task get compared to other tasks running on
3 the same processor.
3 @since 1.22 4 @since 1.22
4 ]] 5 ]]
5 normal, 6 normal, [[Neither above nor below average priority. This is the default.]]
6 background, 7 background, [[Far below average priority.]]
7 low, 8 low, [[Below average priority.]]
8 high, 9 high, [[Above average priority.]]
9 ultra 10 ultra [[Far above average priority.]]
10} 11}
11 12
12enum Efl.Task_Flags { 13enum Efl.Task_Flags {
13 [[ 14 [[Flags to further customize task's behavior.
14 @since 1.22 15 @since 1.22
15 ]] 16 ]]
16 none = 0, 17 none = 0, [[No special flags.]]
17 use_stdin = 1, 18 use_stdin = 1, [[Task will require console input.]]
18 use_stdout = 2, 19 use_stdout = 2, [[Task will require console output.]]
19 no_exit_code_error = 4, 20 no_exit_code_error = 4, [[Task will not produce an exit code upon termination.]]
20} 21}
21 22
22abstract Efl.Task extends Efl.Loop_Consumer 23abstract Efl.Task extends Efl.Loop_Consumer
23{ 24{
24 [[ 25 [[EFL's abstraction for a task (process).
25 @since 1.22 26 @since 1.22
26 ]] 27 ]] // TODO: This needs more detail.
27 methods { 28 methods {
28 @property priority { 29 @property priority {
29 [[ The priority of this task. ]] 30 [[The priority of this task.]]
30 get { } 31 get { }
31 set { } 32 set { }
32 values { 33 values {
33 priority: Efl.Task_Priority; [[ ]] 34 priority: Efl.Task_Priority; [[Desired priority.]]
34 } 35 }
35 } 36 }
36 @property exit_code { 37 @property exit_code {
37 [[ The final exit code of this task. ]] 38 [[The final exit code of this task. This is the code that will be produced upon task completion.]]
38 get { } 39 get { }
39 values { 40 values {
40 code: int; [[ ]] 41 code: int; [[The exit code.]]
41 } 42 }
42 } 43 }
43 @property flags { 44 @property flags {
45 [[Flags to further customize task's behavior.]]
44 set { } 46 set { }
45 get { } 47 get { }
46 values { 48 values {
47 flags: Efl.Task_Flags; [[ ]] 49 flags: Efl.Task_Flags; [[Desired task flags.]]
48 } 50 }
49 } 51 }
50 run @pure_virtual { 52 run @pure_virtual {
51 [[ Actually run the task ]] 53 [[Actually run the task.]]
52 return: future<void> @owned; [[ A future triggered when task exits and is passed int exit code ]] 54 return: future<void> @owned; [[A future triggered when task exits and is passed int exit code.]]
53 } 55 }
54 end @pure_virtual { 56 end @pure_virtual {
55 [[ Request the task end (may send a signal or interrupt 57 [[Request the task end (may send a signal or interrupt
56 signal resulting in a terminate event being tiggered in the 58 signal resulting in a terminate event being tiggered in the
57 target task loop) ]] 59 target task loop).]]
58 } 60 }
59 } 61 }
60 events { 62 events {