docs: add class and method parameter descriptions to ecore_idler class
authorStefan Schmidt <stefan@osg.samsung.com>
Thu, 14 Apr 2016 15:10:05 +0000 (17:10 +0200)
committerStefan Schmidt <stefan@osg.samsung.com>
Thu, 14 Apr 2016 16:27:42 +0000 (18:27 +0200)
src/lib/ecore/ecore_idler.eo

index 1197baa..bf25d4a 100644 (file)
@@ -2,14 +2,19 @@ import ecore_types;
 
 class Ecore.Idler (Eo.Base)
 {
+   [[Setup callbacks to be called when the program is in idle state.
+
+   Once the mainloop has called all enterer handlers it calls the registered
+   idler callbacks.
+   ]]
    eo_prefix: ecore_idler;
    methods {
       constructor {
          [[Constructor.]]
          legacy: null;
          params {
-            @in func: Ecore_Task_Cb;
-            @in data: const(void)*;
+            @in func: Ecore_Task_Cb; [[Idler callback function.]]
+            @in data: const(void)*; [[Private data passed to callback functions.]]
          }
       }
    }