summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-10 12:26:03 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-10 12:26:03 +0200
commitf78b4861af140bd5b333fb530556e81915acbaab (patch)
treea690d9878ce5c98ff13ec399e20b4848406eb63b
parentbc0eeeb1ecd3e01d9b88b766677d8fa16039ea92 (diff)
efl_task/exe: Further update docs
-rw-r--r--src/lib/ecore/efl_exe.eo23
-rw-r--r--src/lib/ecore/efl_task.eo2
2 files changed, 13 insertions, 12 deletions
diff --git a/src/lib/ecore/efl_exe.eo b/src/lib/ecore/efl_exe.eo
index 30ce703248..23b68935e4 100644
--- a/src/lib/ecore/efl_exe.eo
+++ b/src/lib/ecore/efl_exe.eo
@@ -15,7 +15,7 @@ enum @beta Efl.Exe_Signal {
15} 15}
16 16
17enum @beta Efl.Exe_Flags { 17enum @beta Efl.Exe_Flags {
18 [[Flags to customize task behavior.]] // TODO: This needs more detail. 18 [[Flags to customize process behavior.]]
19 none = 0, [[No special flags.]] 19 none = 0, [[No special flags.]]
20 group_leader = 1, [[Process will be executed in its own session.]] 20 group_leader = 1, [[Process will be executed in its own session.]]
21 hide_io = 4 [[All console IO will be hidden.]] 21 hide_io = 4 [[All console IO will be hidden.]]
@@ -23,20 +23,21 @@ enum @beta Efl.Exe_Flags {
23 23
24class @beta Efl.Exe extends Efl.Task implements Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line 24class @beta Efl.Exe extends Efl.Task implements Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line
25{ 25{
26 [[The Efl.Exe 26 [[This is a specialized @Efl.Task which abstracts an operating system process.
27 27 This class provides a way to start a task by running an executable file (specified using the
28 Efl.Exe is a kind of specialized @Efl.Task which is a abstraction of process(task). 28 @Efl.Core.Command_Line interface) and further customize its execution flags (@.exe_flags) and
29 This class provides a way to execute some commands with certain executing flags under certain environment variables. 29 environment variables (@.env).
30 and also it can provides a way to manage signals to a process that it handles.]] 30 It also allows communicating with the process through signals (@.signal).
31 ]]
31 methods { 32 methods {
32 signal { 33 signal {
33 [[Send a signal to this task.]] 34 [[Send a signal to this process.]]
34 params { 35 params {
35 sig: Efl.Exe_Signal; [[Signal number to send.]] 36 sig: Efl.Exe_Signal; [[Signal number to send.]]
36 } 37 }
37 } 38 }
38 @property exe_flags { 39 @property exe_flags {
39 [[Customize the task's behavior.]] 40 [[Customize the process' behavior.]]
40 set { } 41 set { }
41 get { } 42 get { }
42 values { 43 values {
@@ -44,17 +45,17 @@ class @beta Efl.Exe extends Efl.Task implements Efl.Io.Reader, Efl.Io.Writer, Ef
44 } 45 }
45 } 46 }
46 @property exit_signal { 47 @property exit_signal {
47 [[The final exit signal of this task.]] 48 [[The signal this process emitted upon exiting, if any.]]
48 get { } 49 get { }
49 values { 50 values {
50 sig: int; [[The exit signal, or -1 if no exit signal happened.]] 51 sig: int; [[The exit signal, or -1 if no exit signal happened.]]
51 } 52 }
52 } 53 }
53 @property env { 54 @property env {
54 [[If $env is $null then the process created by this object is 55 [[If $env is $NULL then the process created by this object is
55 going to inherit the environment of this process. 56 going to inherit the environment of this process.
56 57
57 In case $env is not $null then the environment variables declared 58 In case $env is not $NULL then the environment variables declared
58 in this object will represent the environment passed to the new process. 59 in this object will represent the environment passed to the new process.
59 ]] 60 ]]
60 get { 61 get {
diff --git a/src/lib/ecore/efl_task.eo b/src/lib/ecore/efl_task.eo
index baf8ce80b5..6fd162bd90 100644
--- a/src/lib/ecore/efl_task.eo
+++ b/src/lib/ecore/efl_task.eo
@@ -58,7 +58,7 @@ abstract Efl.Task extends Efl.Loop_Consumer
58 } 58 }
59 end @pure_virtual { 59 end @pure_virtual {
60 [[Request the task end (may send a signal or interrupt 60 [[Request the task end (may send a signal or interrupt
61 signal resulting in a terminate event being tiggered in the 61 signal resulting in a terminate event being triggered in the
62 target task loop).]] 62 target task loop).]]
63 } 63 }
64 } 64 }