xartigas pushed a commit to branch master.

http://git.enlightenment.org/core/efl.git/commit/?id=04df2327bd9febf0a3218d1eb5da1cd9705e344d

commit 04df2327bd9febf0a3218d1eb5da1cd9705e344d
Author: Woochanlee <[email protected]>
Date:   Wed Sep 18 12:51:40 2019 +0200

    docs: Fill-in docs for Efl.Threadio, Efl.Appthread
    
    Reviewers: myoungwoon, segfaultxavi
    
    Subscribers: stefan_schmidt, cedric, #reviewers, #committers
    
    Tags: #efl
    
    Differential Revision: https://phab.enlightenment.org/D10000
---
 src/lib/ecore/efl_appthread.eo |  4 +++-
 src/lib/ecore/efl_threadio.eo  | 35 ++++++++++++++++++++++++-----------
 2 files changed, 27 insertions(+), 12 deletions(-)

diff --git a/src/lib/ecore/efl_appthread.eo b/src/lib/ecore/efl_appthread.eo
index b293b4aa07..87f10d0183 100644
--- a/src/lib/ecore/efl_appthread.eo
+++ b/src/lib/ecore/efl_appthread.eo
@@ -1,7 +1,9 @@
 class @beta Efl.Appthread extends Efl.Loop
                           implements Efl.ThreadIO, Efl.Io.Reader, 
Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line
 {
-   [[ ]]
+   [[@Efl.Appthread object created to house the thread and run the loop.
+     @Efl.Appthread also Inherits from @Efl.Loop, @Efl.Io and @Efl.Task
+     So it works almost the same as Efl.App but misses some of the 
process-global controls from @Efl.App.]]
    methods {
    }
    events {
diff --git a/src/lib/ecore/efl_threadio.eo b/src/lib/ecore/efl_threadio.eo
index 1bafb92a43..4da455bb43 100644
--- a/src/lib/ecore/efl_threadio.eo
+++ b/src/lib/ecore/efl_threadio.eo
@@ -1,48 +1,61 @@
 import efl_object;
 
 function @beta EflThreadIOCall {
-   [[ A Function to call on the "other end" of a thread obvject ]]
+   [[ A Function to call on the "other end" of a thread object ]]
    params {
-      @in event: const(event); [[ ]]
+      @in event: const(event); [[Event struct with an EFL_LOOP_HANDLER_CLASS 
as info]]
    }
 };
 
 function @beta EflThreadIOCallSync {
-   [[ A Function to call on the "other end" of a thread obvject ]]
+   [[ A Function to call on the "other end" of a thread object ]]
    params {
-      @in event: const(event); [[ ]]
+      @in event: const(event); [[Event struct with an EFL_LOOP_HANDLER_CLASS 
as info]]
    }
-   return: void_ptr; [[ ]]
+   return: void_ptr; [[The "other end" of a thread object's data]]
 };
 
 mixin @beta Efl.ThreadIO
 {
-   [[ ]]
+   [[This adds a simple indata and outdata void ptr to begin that you can
+     set on @Efl.Thread objects (set the indata) and get the outdata too to
+     get results. then on the efl.appthread side the indata is set on the
+     @Efl.Appthread before it runs and on quit the thread can set the
+     outdata on the appthread, and this appears back on the @Efl.Thread
+     object in the parent thread.
+
+     So you can basically share pointers to anything in and out this way on
+     start/exit in addition to string args etc.
+   ]]
    methods {
       @property indata {
+         [[Sets/gets on Efl.Thread object's indata.]]
          set { }
          get { }
          values {
-            data: void_ptr; [[ ]]
+            data: void_ptr; [[Pointer data set to indata.]]
          }
       }
       @property outdata {
+         [[Sets/gets on Efl.Thread object's outdata.]]
          set { }
          get { }
          values {
-            data: void_ptr; [[ ]]
+            data: void_ptr; [[Pointer data set to outdata.]]
          }
       }
       call {
+         [[Write a command as async.]]
          params {
-            func: EflThreadIOCall; [[ ]]
+            func: EflThreadIOCall; [[A Function to call on the "other end" of 
a thread object]]
          }
       }
       call_sync {
+         [[Write a command as sync.]]
          params {
-            func: EflThreadIOCallSync; [[ ]]
+            func: EflThreadIOCallSync; [[A Function to call on the "other end" 
of a thread object]]
          }
-         return: void_ptr; [[ ]]
+         return: void_ptr; [[The "other end" of a thread object's data]]
       }
    }
    events {

-- 


Reply via email to