docs: add description for ecore.exe class and events
authorStefan Schmidt <stefan@osg.samsung.com>
Wed, 13 Apr 2016 13:34:11 +0000 (15:34 +0200)
committerStefan Schmidt <stefan@osg.samsung.com>
Wed, 13 Apr 2016 15:01:23 +0000 (17:01 +0200)
src/lib/ecore/ecore_exe.eo

index e85b4d1..32952ee 100644 (file)
@@ -39,6 +39,12 @@ enum Ecore.Exe_Flags
 
 class Ecore.Exe (Eo.Base, Efl.Control)
 {
+   [[Ecore.Exe is responsible for managing portable process spawning.
+
+   With this module you are able to spawn, pause and quit the spawned processes.
+   An interaction between your process and those spawned is possible using pipes or signals.
+   ]]
+
    eo_prefix: ecore_obj_exe;
    methods {
         @property command {
@@ -64,8 +70,8 @@ class Ecore.Exe (Eo.Base, Efl.Control)
       .command;
    }
    events {
-        data,get: Ecore.Exe_Event_Data;
-        data,error: Ecore.Exe_Event_Data;
+        data,get: Ecore.Exe_Event_Data; [[Data received event from the child process]]
+        data,error: Ecore.Exe_Event_Data; [[Error received event from the child process]]
    }
 }