docs: emotion: add missing docs for efl canvas video events
authorStefan Schmidt <stefan@osg.samsung.com>
Mon, 24 Oct 2016 15:02:23 +0000 (17:02 +0200)
committerStefan Schmidt <stefan@osg.samsung.com>
Mon, 24 Oct 2016 15:02:23 +0000 (17:02 +0200)
Also make use of $true keyword while being there.

src/lib/emotion/efl_canvas_video.eo

index 9715347..b7be070 100644 (file)
@@ -40,8 +40,8 @@ class Efl.Canvas.Video (Efl.Canvas.Group, Efl.File, Efl.Player, Efl.Image, Efl.I
                     \@ref emotion_object_file_set.
                   ]]
                   legacy: emotion_object_init;
-                  return: bool; [[true if the specified module was successfully
-                                  initialized for this object, false otherwise.]]
+                  return: bool; [[$true if the specified module was successfully
+                                  initialized for this object, $false otherwise.]]
              }
              values {
                   module_filename: string; [[The name of the module to be
@@ -77,24 +77,24 @@ class Efl.Canvas.Video (Efl.Canvas.Group, Efl.File, Efl.Player, Efl.Image, Efl.I
         Efl.Image.smooth_scale.get;
    }
    events {
-        frame,decode;
-        position,change;
-        length,change;
-        frame,resize;
-        playback,start;
-        playback,stop;
-        volume,change;
-        channels,change;
-        title,change;
-        progress,change;
-        ref,change;
-        button,num,change;
-        button,change;
-        open,done;
-        position,save,done;
-        position,save,fail;
-        position,load,done;
-        position,load,fail;
+        frame,decode; [[Called when the frame was decoded]]
+        position,change; [[Called when the position changed]]
+        length,change; [[Called when the length changed]]
+        frame,resize; [[Called when the frame was resized]]
+        playback,start; [[Called when playback started]]
+        playback,stop; [[Called when playback stopped]]
+        volume,change; [[Called when volume changed]]
+        channels,change; [[Called when the channels changed]]
+        title,change; [[Called when the title changed]]
+        progress,change; [[Called when the progress changed]]
+        ref,change; [[Called when ref changed]]
+        button,num,change; [[Called when button number changed]]
+        button,change; [[Called when button changed]]
+        open,done; [[Called when the files was opened]]
+        position,save,done; [[Called when the position was saved]]
+        position,save,fail; [[Called when saving the position failed]]
+        position,load,done; [[Called when the position loaded]]
+        position,load,fail; [[Called when loading the position failed]]
    }
 }