docs: evas_canvas: fill gaps in evas canvas eo file documentation

10 files changed, 61 insertions, 52 deletions

diff --git a/src/lib/evas/canvas/efl_canvas_filter_internal.eo b/src/lib/evas/canvas/efl_canvas_filter_internal.eo
index d9ef560e58..0d03ebc17d 100644
--- a/src/lib/evas/canvas/efl_canvas_filter_internal.eo
+++ b/src/lib/evas/canvas/efl_canvas_filter_internal.eo
@@ -11,7 +11,7 @@ mixin Efl.Canvas.Filter.Internal (Efl.Gfx.Filter, Efl.Object)
             [[Marks this filter as changed.]]
          }
          values {
-            val: bool;
+            val: bool; [[$true if filter changed, $false otherwise]]
          }
       }
       @property filter_invalid @protected {
@@ -19,12 +19,12 @@ mixin Efl.Canvas.Filter.Internal (Efl.Gfx.Filter, Efl.Object)
             [[Marks this filter as invalid.]]
          }
          values {
-            val: bool;
+            val: bool; [[$true if filter is invalid, $false otherwise]]
          }
       }
       filter_input_alpha @protected @virtual_pure {
          [[Called by Efl.Canvas.Filter.Internal to determine whether the input is alpha or rgba.]]
-         return: bool;
+         return: bool; [[$true on success, $false otherwise]]
       }
       filter_input_render @protected @virtual_pure {
          [[Called by Efl.Canvas.Filter.Internal when the parent class must render the input.
@@ -33,12 +33,12 @@ mixin Efl.Canvas.Filter.Internal (Efl.Gfx.Filter, Efl.Object)
          return: bool; [[Indicates success from the object render function.]]
          params {
             filter: void_ptr; [[Evas_Filter_Context]]
-            drawctx: void_ptr;
-            l: int;
-            r: int;
-            t: int;
-            b: int;
-            do_async: bool;
+            drawctx: void_ptr; [[Draw context]]
+            l: int; [[Left]]
+            r: int; [[Right]]
+            t: int; [[Top]]
+            b: int; [[Bottom]]
+            do_async: bool; [[$true when the operation should be done asynchronous, $false otherwise]]
          }
       }
       filter_dirty @protected @virtual_pure {
@@ -55,7 +55,7 @@ mixin Efl.Canvas.Filter.Internal (Efl.Gfx.Filter, Efl.Object)
             ]]
          }
          values {
-            buffer: void_ptr;
+            buffer: void_ptr; [[Output buffer]]
          }
       }
    }
diff --git a/src/lib/evas/canvas/efl_canvas_group.eo b/src/lib/evas/canvas/efl_canvas_group.eo
index cf59d7d97b..d1db29297c 100644
--- a/src/lib/evas/canvas/efl_canvas_group.eo
+++ b/src/lib/evas/canvas/efl_canvas_group.eo
@@ -33,7 +33,7 @@ class Efl.Canvas.Group (Efl.Canvas.Object)
             legacy: evas_object_smart_need_recalculate_get;
          }
          values {
-            value: bool;
+            value: bool; [[$true if the group layout needs to be recalculated, $false otherwise]]
          }
       }
       group_change {
@@ -60,7 +60,7 @@ class Efl.Canvas.Group (Efl.Canvas.Object)
            from both the $Efl.Object children list as well as the $Efl.Container
            content list.
          ]]
-         return: free(own(iterator<Efl.Canvas.Object>), eina_iterator_free);
+         return: free(own(iterator<Efl.Canvas.Object>), eina_iterator_free); [[Iterator to object children]]
          legacy: evas_object_smart_iterator_new;
       }
       group_member_add {
@@ -92,7 +92,7 @@ class Efl.Canvas.Group (Efl.Canvas.Object)
            See also @.group_member_add for more details.
          ]]
          params {
-            @in sub_obj: Efl.Canvas.Object; [[the member object.]]
+            @in sub_obj: Efl.Canvas.Object; [[The member object.]]
          }
          legacy: null;
       }
diff --git a/src/lib/evas/canvas/efl_canvas_image_internal.eo b/src/lib/evas/canvas/efl_canvas_image_internal.eo
index 18ed92ede7..0eadebc0e5 100644
--- a/src/lib/evas/canvas/efl_canvas_image_internal.eo
+++ b/src/lib/evas/canvas/efl_canvas_image_internal.eo
@@ -4,6 +4,7 @@ abstract Efl.Canvas.Image.Internal (Efl.Canvas.Object, Efl.Canvas.Filter.Interna
                                     Efl.Orientation, Efl.Flipable,
                                     Efl.File)
 {
+   [[Efl canvas internal image class]]
    data: Evas_Image_Data;
    implements {
       Efl.Object.constructor;
diff --git a/src/lib/evas/canvas/efl_canvas_object.eo b/src/lib/evas/canvas/efl_canvas_object.eo
index 69121114fc..8d2cb4109c 100644
--- a/src/lib/evas/canvas/efl_canvas_object.eo
+++ b/src/lib/evas/canvas/efl_canvas_object.eo
@@ -5,6 +5,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Stack, Efl.Animator,
                             Efl.Input.Interface, Efl.Gfx.Size.Hint,
                             Efl.Gfx.Map)
 {
+   [[Efl canvas object abstract class]]
    legacy_prefix: evas_object;
    data: Evas_Object_Protected_Data;
    methods {
@@ -38,7 +39,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Stack, Efl.Animator,
            The default value is @Efl.Input.Object_Pointer_Mode.auto_grab.
          ]]
          values {
-            pointer_mode: Efl.Input.Object_Pointer_Mode;
+            pointer_mode: Efl.Input.Object_Pointer_Mode; [[Input pointer mode]]
          }
       }
       @property render_op {
@@ -272,6 +273,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Stack, Efl.Animator,
          return: bool; [[$true if the seat was removed from the focus list or $false otherwise.]]
       }
       @property is_frame_object {
+      	 [[Property to identify if an object is a frame]]
          set {
             [[@since 1.2]]
          }
@@ -279,7 +281,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Stack, Efl.Animator,
             [[@since 1.2]]
          }
          values {
-            is_frame: bool;
+            is_frame: bool; [[$true if the object is a frame, $false otherwise]]
          }
       }
       @property precise_is_inside {
@@ -448,7 +450,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Stack, Efl.Animator,
 
            @since 1.8
          ]]
-         return: bool @warn_unused;
+         return: bool @warn_unused; [[$true if any object is clipped by $obj, $false otherwise]]
       }
       key_grab {
          [[Requests $keyname key events be directed to $obj.
@@ -518,7 +520,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Stack, Efl.Animator,
          See the full example @ref Example_Evas_Events "here".
          */
          params {
-            @in keyname: string @nonull; [[he key the grab is set for.]]
+            @in keyname: string @nonull; [[The key the grab is set for.]]
             @in modifiers: Evas.Modifier_Mask; [[A mask of modifiers that must be
                                                  present to trigger the event.]]
             @in not_modifiers: Evas.Modifier_Mask; [[A mask of modifiers that mus
diff --git a/src/lib/evas/canvas/efl_canvas_output.eo b/src/lib/evas/canvas/efl_canvas_output.eo
index f6c8e24a1a..168f72e95c 100644
--- a/src/lib/evas/canvas/efl_canvas_output.eo
+++ b/src/lib/evas/canvas/efl_canvas_output.eo
@@ -2,6 +2,7 @@ import evas_types;
 
 class Efl.Canvas.Output (Efl.Object, Efl.Gfx.Buffer)
 {
+   [[Efl canvas output class]]
    methods {
       @property view {
          set {
@@ -15,24 +16,24 @@ class Efl.Canvas.Output (Efl.Object, Efl.Gfx.Buffer)
             [[Gets the viewport region of the canvas that the output displays.]]
          }
          values {
-            x: Evas.Coord;
-            y: Evas.Coord;
-            w: Evas.Coord;
-            h: Evas.Coord;
+            x: Evas.Coord; [[X coordinate viewport]]
+            y: Evas.Coord; [[Y coordinate viewport]] 
+            w: Evas.Coord; [[Viewport width]]
+            h: Evas.Coord; [[Viewport height]]
          }
       }
       lock {
-         [[Lock this output and will prevent rendering any buffer associated to it.]]
-         return: bool;
+         [[Lock this output and prevent rendering any buffer associated to it.]]
+         return: bool; [[$true on success, $false otherwise]]
       }
       unlock {
          [[Unlock this output and will rendering of this buffer during next call to evas_render.]]
-         return: bool;
+         return: bool; [[$true on success, $false otherwise]]
       }
       @property engine_info {
          set {
             [[Sets the engine specific output parameters for a given output.]]
-            return: bool;
+            return: bool; [[$true on success, $false otherwise]]
          }
          get {
             [[Gets the engine specific output parameters for a given output.]]
@@ -49,6 +50,6 @@ class Efl.Canvas.Output (Efl.Object, Efl.Gfx.Buffer)
       Efl.Object.finalize;
    }
    events {
-      pixels,ready;
+      pixels,ready; [[Called when pixels in output are ready to be used]]
    }
 }
diff --git a/src/lib/evas/canvas/efl_canvas_rectangle.eo b/src/lib/evas/canvas/efl_canvas_rectangle.eo
index a6899d8883..0430a53dab 100644
--- a/src/lib/evas/canvas/efl_canvas_rectangle.eo
+++ b/src/lib/evas/canvas/efl_canvas_rectangle.eo
@@ -1,5 +1,6 @@
 class Efl.Canvas.Rectangle (Efl.Canvas.Object)
 {
+   [[Evas canvas rectangle class]]
    implements {
       Efl.Object.constructor;
    }
diff --git a/src/lib/evas/canvas/efl_canvas_surface.eo b/src/lib/evas/canvas/efl_canvas_surface.eo
index d05bd6bbcf..4cb2685cd7 100644
--- a/src/lib/evas/canvas/efl_canvas_surface.eo
+++ b/src/lib/evas/canvas/efl_canvas_surface.eo
@@ -19,7 +19,7 @@ mixin Efl.Canvas.Surface (Efl.Interface, Efl.Canvas.Image.Internal)
              [[Set the buffer. If this fails, this function returns $false,
                and the surface is left without any attached buffer.
              ]]
-             return: bool @warn_unused;
+             return: bool @warn_unused; [[$true on success, $false otherwise]]
           }
           values {
              buffer: void_ptr; [[The external buffer, depends on its type.]]
diff --git a/src/lib/evas/canvas/efl_canvas_surface_x11.eo b/src/lib/evas/canvas/efl_canvas_surface_x11.eo
index 892a3c5615..d7fc2f0663 100644
--- a/src/lib/evas/canvas/efl_canvas_surface_x11.eo
+++ b/src/lib/evas/canvas/efl_canvas_surface_x11.eo
@@ -13,7 +13,9 @@ class Efl.Canvas.Surface.X11 (Efl.Object, Efl.Canvas.Surface)
       @property pixmap {
          [[This is a helper for @Efl.Canvas.Surface.native_buffer.]]
          get {}
-         set { return: bool; }
+         set {
+            return: bool; [[$true on success, $false otherwise]]
+         }
          values {
             visual: void_ptr; [[X11 Visual for this Pixmap.]]
             pixmap: ulong;  [[X11 Pixmap ID.]]
diff --git a/src/lib/evas/canvas/efl_canvas_text.eo b/src/lib/evas/canvas/efl_canvas_text.eo
index d860be032c..44d23358fa 100644
--- a/src/lib/evas/canvas/efl_canvas_text.eo
+++ b/src/lib/evas/canvas/efl_canvas_text.eo
@@ -2,6 +2,7 @@ struct Efl.Canvas.Text.Style; [[EFL text style data structure]]
 
 class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
 {
+   [[Efl canvas text class]]
    legacy_prefix: evas_object_textblock;
    methods {
       @property bidi_delimiters {
@@ -19,7 +20,7 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
          }
       }
       @property legacy_newline {
-         [[When true, newline character will behave as a paragraph separator.
+         [[When $true, newline character will behave as a paragraph separator.
 
            @since 1.18
          ]]
@@ -87,7 +88,7 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
            @since 1.18
          ]]
          get {
-            return: Efl.Canvas.Text.Cursor;
+            return: Efl.Canvas.Text.Cursor; [[Text cursor object]]
          }
       }
       @property size_native {
@@ -140,7 +141,7 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
             legacy: null;
          }
          values {
-            is_empty: bool; [[$true if empty]]
+            is_empty: bool; [[$true if empty, $false otherwise]]
          }
       }
       obstacle_add {
@@ -153,7 +154,7 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
            @since 1.18
          ]]
          params {
-            @in eo_obs: Efl.Canvas.Object;
+            @in eo_obs: Efl.Canvas.Object; [[Obstacle object]]
          }
          return: bool; [[$true on success, $false otherwise.]]
       }
@@ -163,7 +164,7 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
            @since 1.18
          ]]
          params {
-            @in eo_obs: Efl.Canvas.Object;
+            @in eo_obs: Efl.Canvas.Object; [[Obstacle object]]
          }
          return: bool; [[$true on success, $false otherwise.]]
       }
@@ -232,7 +233,7 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
          params {
               @in start: Efl.Canvas.Text.Cursor; [[Start of range]]
               @in end:   Efl.Canvas.Text.Cursor; [[End of range]]
-              @in format: string;
+              @in format: string; [[Annotation format]]
          }
          return: ptr(Efl.Canvas.Text.Annotation); [[Handle of inserted annotation]]
       }
@@ -334,17 +335,17 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
          legacy: null;
          params {
             @in an: ptr(const(Efl.Canvas.Text.Annotation)); [[Given annotation to query]]
-            @out x: Evas.Coord; [[x coordinate of the annotation]]
-            @out y: Evas.Coord; [[y coordinate of the annotation]]
-            @out w: Evas.Coord; [[w coordinate of the annotation]]
-            @out h: Evas.Coord; [[h coordinate of the annotation]]
+            @out x: Evas.Coord; [[X coordinate of the annotation]]
+            @out y: Evas.Coord; [[Y coordinate of the annotation]]
+            @out w: Evas.Coord; [[Width of the annotation]]
+            @out h: Evas.Coord; [[Height of the annotation]]
          }
          return: bool; [[$true if given annotation is an object item, $false otherwise]]
       }
       annotation_positions_get {
          [[Sets given cursors to the start and end positions of the annotation.
 
-           The cursors $start and $end will be set to the the start and end
+           The cursors $start and $end will be set to the start and end
            positions of the given annotation $annotation.
 
            @since 1.18
@@ -370,6 +371,6 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
       Efl.Text.text.get;
    }
    events {
-      changed; [[The content (text or annotations) have changed.]]
+      changed; [[Called when the content (text or annotations) changed.]]
    }
 }
diff --git a/src/lib/evas/canvas/efl_canvas_text_cursor.eo b/src/lib/evas/canvas/efl_canvas_text_cursor.eo
index 47d22e1959..0b6e61473f 100644
--- a/src/lib/evas/canvas/efl_canvas_text_cursor.eo
+++ b/src/lib/evas/canvas/efl_canvas_text_cursor.eo
@@ -7,6 +7,7 @@ enum Efl.Canvas.Text.Cursor.Type
 
 class Efl.Canvas.Text.Cursor (Efl.Object)
 {
+   [[Efl canvas text cursor class]]
    legacy_prefix: evas_textblock_cursor;
    methods {
       @property text_object {
@@ -47,17 +48,17 @@ class Efl.Canvas.Text.Cursor (Efl.Object)
             return: bool; [[ $true if split cursor, $false otherwise.]]
          }
          keys {
-            ctype: Efl.Canvas.Text.Cursor.Type; [[ the type of the cursor.]]
+            ctype: Efl.Canvas.Text.Cursor.Type; [[The type of the cursor.]]
          }
          values {
-            cx: Evas.Coord; [[the x of the cursor (or upper cursor)]]
-            cy: Evas.Coord; [[the y of the cursor (or upper cursor)]]
-            cw: Evas.Coord; [[the width of the cursor (or upper cursor)]]
-            ch: Evas.Coord; [[the height of the cursor (or upper cursor)]]
-            cx2: Evas.Coord; [[ the x of the lower cursor]]
-            cy2: Evas.Coord; [[ the y of the lower cursor]]
-            cw2: Evas.Coord; [[ the width of the lower cursor]]
-            ch2: Evas.Coord; [[ the height of the lower cursor]]
+            cx: Evas.Coord; [[The x of the cursor (or upper cursor)]]
+            cy: Evas.Coord; [[The y of the cursor (or upper cursor)]]
+            cw: Evas.Coord; [[The width of the cursor (or upper cursor)]]
+            ch: Evas.Coord; [[The height of the cursor (or upper cursor)]]
+            cx2: Evas.Coord; [[The x of the lower cursor]]
+            cy2: Evas.Coord; [[The y of the lower cursor]]
+            cw2: Evas.Coord; [[The width of the lower cursor]]
+            ch2: Evas.Coord; [[The height of the lower cursor]]
          }
       }
       copy {
@@ -173,8 +174,8 @@ class Efl.Canvas.Text.Cursor (Efl.Object)
          [[Sets the position of the cursor according to the X and Y coordinates.]]
          legacy: null;
          params {
-            @in x: Evas.Coord; [[x coord to set by.]]
-            @in y: Evas.Coord; [[y coord to set by.]]
+            @in x: Evas.Coord; [[X coord to set by.]]
+            @in y: Evas.Coord; [[Y coord to set by.]]
          }
       }
       @property object_item_annotation {
@@ -183,7 +184,7 @@ class Efl.Canvas.Text.Cursor (Efl.Object)
             legacy: null;
          }
          values {
-            annotation: ptr(Efl.Canvas.Text.Annotation);
+            annotation: ptr(Efl.Canvas.Text.Annotation); [[Annotation]]
          }
       }
       object_item_insert {