docs: evas3d: fill gaps in evas 3D canvas eo file documentations

8 files changed, 33 insertions, 26 deletions

diff --git a/src/lib/evas/canvas/evas_canvas3d_camera.eo b/src/lib/evas/canvas/evas_canvas3d_camera.eo
index 1950549254..7ed400f015 100644
--- a/src/lib/evas/canvas/evas_canvas3d_camera.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_camera.eo
@@ -2,6 +2,7 @@ import evas_types;
 
 class Evas.Canvas3D.Camera (Evas.Canvas3D.Object)
 {
+   [[Evas 3D canvas camera class]]
    data: Evas_Canvas3D_Camera_Data;
    methods {
       projection_matrix_set {
@@ -71,7 +72,7 @@ class Evas.Canvas3D.Camera (Evas.Canvas3D.Object)
          params {
             @in camera_node: Evas.Canvas3D.Node; [[The given camera node.]]
             @in node: Evas.Canvas3D.Node; [[The given node.]]
-            @in key: Evas.Canvas3D.Frustum_Mode;
+            @in key: Evas.Canvas3D.Frustum_Mode; [[The given key]]
          }
       }
    }
diff --git a/src/lib/evas/canvas/evas_canvas3d_light.eo b/src/lib/evas/canvas/evas_canvas3d_light.eo
index cb4780503e..ecd5770c2f 100644
--- a/src/lib/evas/canvas/evas_canvas3d_light.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_light.eo
@@ -2,6 +2,8 @@ import evas_types;
 
 class Evas.Canvas3D.Light (Evas.Canvas3D.Object)
 {
+   [[Evas 3D canvas light class]]
+
    data: Evas_Canvas3D_Light_Data;
 
    methods {
diff --git a/src/lib/evas/canvas/evas_canvas3d_material.eo b/src/lib/evas/canvas/evas_canvas3d_material.eo
index 68cd4927a2..b2d209099d 100644
--- a/src/lib/evas/canvas/evas_canvas3d_material.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_material.eo
@@ -1,5 +1,6 @@
 class Evas.Canvas3D.Material (Evas.Canvas3D.Object)
 {
+   [[Evas 3D canvas material class]]
    data: Evas_Canvas3D_Material_Data;
    methods {
       color_set {
diff --git a/src/lib/evas/canvas/evas_canvas3d_mesh.eo b/src/lib/evas/canvas/evas_canvas3d_mesh.eo
index 957b795be0..fd4d9b6021 100644
--- a/src/lib/evas/canvas/evas_canvas3d_mesh.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_mesh.eo
@@ -3,6 +3,7 @@ import evas_types;
 
 class Evas.Canvas3D.Mesh (Evas.Canvas3D.Object, Efl.File)
 {
+   [[Evas 3D canvas mesh class]]
    data: Evas_Canvas3D_Mesh_Data;
 
    methods {
@@ -104,8 +105,8 @@ class Evas.Canvas3D.Mesh (Evas.Canvas3D.Object, Efl.File)
          ]]
          params {
             @in frame: int; [[ The number of the key frame.]]
-            @in vertex: ptr(Eina.Inarray);
-            @in index: ptr(Eina.Inarray);
+            @in vertex: ptr(Eina.Inarray); [[Vertex data pointer]]
+            @in index: ptr(Eina.Inarray); [[Index data pointer]]
          }
       }
 
@@ -166,11 +167,11 @@ class Evas.Canvas3D.Mesh (Evas.Canvas3D.Object, Efl.File)
       }
 
       frame_exist {
-         [[Returns EINA_TRUE if frame was added and EINA_FALSE in other case.]]
+         [[Returns $true if frame was added and $false in other case.]]
          params {
             @in frame: int; [[Frame number.]]
          }
-         return: bool;
+         return: bool; [[$true ifr frame was added, $false otherwise]]
       }
 
       frame_add {
@@ -222,10 +223,10 @@ class Evas.Canvas3D.Mesh (Evas.Canvas3D.Object, Efl.File)
          }
       }
       blending_func_get {
-         [[Get blending blending function for given mesh.]]
+         [[Get blending function for given mesh.]]
          params {
-            @out sfactor: Evas.Canvas3D.Blend_Func; [[Pointer to receive source blendin factors key.]]
-            @out dfactor: Evas.Canvas3D.Blend_Func; [[Pointer to receive destination blendin factors key.]]
+            @out sfactor: Evas.Canvas3D.Blend_Func; [[Pointer to receive source blending factors key.]]
+            @out dfactor: Evas.Canvas3D.Blend_Func; [[Pointer to receive destination blending factors key.]]
          }
       }
       from_primitive_set {
@@ -251,13 +252,13 @@ class Evas.Canvas3D.Mesh (Evas.Canvas3D.Object, Efl.File)
       }
       @property color_pick_enable {
         set {
-            [[Set posibility color picking.]]
+            [[Set possibility color picking.]]
          }
          get {
             [[Get status of color picking of the mesh.]]
          }
          values {
-            enabled: bool; [[Posibility flag.]]
+            enabled: bool; [[Possibility flag.]]
          }
       }
       @property vertex_count {
@@ -414,8 +415,8 @@ class Evas.Canvas3D.Mesh (Evas.Canvas3D.Object, Efl.File)
               See also @Evas.Canvas3D.Mesh.lod_boundary.set.]]
          }
          values {
-            near_lod: Evas.Real; [[up boundary]]
-            far_lod: Evas.Real; [[down boundary]]
+            near_lod: Evas.Real; [[Up boundary]]
+            far_lod: Evas.Real; [[Down boundary]]
          }
       }
    }
diff --git a/src/lib/evas/canvas/evas_canvas3d_node.eo b/src/lib/evas/canvas/evas_canvas3d_node.eo
index 541d97a6d1..0b361e4174 100644
--- a/src/lib/evas/canvas/evas_canvas3d_node.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_node.eo
@@ -2,13 +2,14 @@ import evas_types;
 
 class Evas.Canvas3D.Node (Evas.Canvas3D.Object)
 {
+   [[Evas 3D canvas node class]]
    data: Evas_Canvas3D_Node_Data;
    methods {
       constructor {
          [[Constructor.]]
          legacy: null;
          params {
-            @in type: Evas.Canvas3D.Node_Type;
+            @in type: Evas.Canvas3D.Node_Type; [[Node type]]
          }
       }
       type_get @const {
diff --git a/src/lib/evas/canvas/evas_canvas3d_primitive.eo b/src/lib/evas/canvas/evas_canvas3d_primitive.eo
index 97134c7b29..f7f86112d3 100644
--- a/src/lib/evas/canvas/evas_canvas3d_primitive.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_primitive.eo
@@ -2,6 +2,7 @@ import evas_types;
 
 class Evas.Canvas3D.Primitive (Evas.Canvas3D.Object)
 {
+   [[Evas 3D canvas primitive class]]
    data: Evas_Canvas3D_Primitive_Data;
 
    methods {
@@ -116,7 +117,7 @@ class Evas.Canvas3D.Primitive (Evas.Canvas3D.Object)
              [[Set the texture scale of the given primitive.
 
                Texture scale uses in all non tabulated primitives
-               and defines scale of texture coords or primitives.
+               and defines scale of texture coordinates or primitives.
 
                It uses to create periodical textured meshes.
 
@@ -128,8 +129,8 @@ class Evas.Canvas3D.Primitive (Evas.Canvas3D.Object)
                See also @.tex_scale.set.]]
          }
          values {
-            tex_scale_x: Evas.Real;
-            tex_scale_y: Evas.Real;
+            tex_scale_x: Evas.Real; [[Texture scale X coordinate]]
+            tex_scale_y: Evas.Real; [[Texture scale Y coordinate]]
          }
       }
    }
diff --git a/src/lib/evas/canvas/evas_canvas3d_scene.eo b/src/lib/evas/canvas/evas_canvas3d_scene.eo
index 1bc01f2fed..6323f6d069 100644
--- a/src/lib/evas/canvas/evas_canvas3d_scene.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_scene.eo
@@ -2,6 +2,7 @@ import evas_types;
 
 class Evas.Canvas3D.Scene (Evas.Canvas3D.Object)
 {
+   [[Efl 3D canvas scene class]]
    data: Evas_Canvas3D_Scene_Data;
    methods {
       size_set {
@@ -62,7 +63,7 @@ class Evas.Canvas3D.Scene (Evas.Canvas3D.Object)
            the size of the scene. The texture coordinate is useful when
            using proxy texture source.
          ]]
-         return: bool;
+         return: bool; [[$true on success, $false otherwise]]
          params {
             @in x: Evas.Real;              [[X coordinate of the picking position.]]
             @in y: Evas.Real;              [[Y coordinate of the picking position.]]
@@ -75,7 +76,7 @@ class Evas.Canvas3D.Scene (Evas.Canvas3D.Object)
 
       exist @const {
          [[Search given node in the given position.]]
-         return: Evas.Canvas3D.Node;
+         return: Evas.Canvas3D.Node; [[Node at the given position]]
          params {
             @in x: Evas.Real; [[X coordinate of the picking position.]]
             @in y: Evas.Real; [[Y coordinate of the picking position.]]
@@ -85,7 +86,7 @@ class Evas.Canvas3D.Scene (Evas.Canvas3D.Object)
 
       pick_member_list_get @const {
          [[Get list of the all root members from scene in the given position.]]
-         return: list<Evas.Canvas3D.Node>;
+         return: list<Evas.Canvas3D.Node>; [[List of all root members from scene]]
          params {
             @in x: Evas.Real; [[X coordinate of the picking position.]]
             @in y: Evas.Real; [[Y coordinate of the picking position.]]
@@ -109,13 +110,13 @@ class Evas.Canvas3D.Scene (Evas.Canvas3D.Object)
       }
       color_pick_enable_get @const {
          [[Get status of color picking of the scene.]]
-         return: bool;
+         return: bool; [[The pick enabled status]]
       }
       color_pick_enable_set {
-         [[Set posibility color picking.]]
-         return: bool;
+         [[Set possibility color picking.]]
+         return: bool; [[$true on success, $false otherwise]]
          params {
-            @in color_pick: bool; [[Posibility flag]]
+            @in color_pick: bool; [[Possibility flag]]
          }
       }
 
@@ -165,5 +166,4 @@ class Evas.Canvas3D.Scene (Evas.Canvas3D.Object)
       Evas.Canvas3D.Object.update_notify;
       Evas.Canvas3D.Object.change_notify;
    }
-
 }
diff --git a/src/lib/evas/canvas/evas_canvas3d_texture.eo b/src/lib/evas/canvas/evas_canvas3d_texture.eo
index 277c3e116d..67cf5dcaba 100644
--- a/src/lib/evas/canvas/evas_canvas3d_texture.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_texture.eo
@@ -2,6 +2,7 @@ type @extern Evas_Colorspace: int; [[Evas colorspace type]] /* FIXME: Need to ge
 
 class Evas.Canvas3D.Texture (Evas.Canvas3D.Object)
 {
+   [[Evas 3d canvas texture class]]
    data : Evas_Canvas3D_Texture_Data;
    methods {
       @property source_visible {
@@ -90,7 +91,7 @@ class Evas.Canvas3D.Texture (Evas.Canvas3D.Object)
 
            See also @.data_set, @.file_set, @.source_set.
          ]]
-         return: Evas_Colorspace;
+         return: Evas_Colorspace; [[Color format of the given texture]]
       }
 
       size_get @const {
@@ -164,5 +165,4 @@ class Evas.Canvas3D.Texture (Evas.Canvas3D.Object)
       Evas.Canvas3D.Object.update_notify;
       Evas.Canvas3D.Object.change_notify;
    }
-
 }