summaryrefslogtreecommitdiff
path: root/src/lib/ector
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-11-15 15:55:09 +0100
committerStefan Schmidt <stefan@osg.samsung.com>2016-11-15 17:45:32 +0100
commitdbe01dd2b9b2a1d21a940a0f87c659cc88a30af2 (patch)
tree83fcf1a15f7697c612b16f7526e129b7280a72ba /src/lib/ector
parent9638a114f0e87d271a16dd83b0fc867068b5cbf6 (diff)
docs: ector: fill gaps in ector eo file documentation
Diffstat (limited to 'src/lib/ector')
-rw-r--r--src/lib/ector/ector_renderer.eo30
-rw-r--r--src/lib/ector/ector_renderer_buffer.eo2
-rw-r--r--src/lib/ector/ector_renderer_shape.eo9
-rw-r--r--src/lib/ector/ector_surface.eo4
4 files changed, 26 insertions, 19 deletions
diff --git a/src/lib/ector/ector_renderer.eo b/src/lib/ector/ector_renderer.eo
index e14f9633a3..d742be1c98 100644
--- a/src/lib/ector/ector_renderer.eo
+++ b/src/lib/ector/ector_renderer.eo
@@ -28,22 +28,24 @@ abstract Ector.Renderer (Efl.Object)
28 } 28 }
29 } 29 }
30 @property transformation { 30 @property transformation {
31 [[Transformation property]]
31 set { 32 set {
32 } 33 }
33 get { 34 get {
34 } 35 }
35 values { 36 values {
36 m: ptr(const(Eina.Matrix3)); 37 m: ptr(const(Eina.Matrix3)); [[Transformation matrix]]
37 } 38 }
38 } 39 }
39 @property origin { 40 @property origin {
41 [[Renderer origin]]
40 set { 42 set {
41 } 43 }
42 get { 44 get {
43 } 45 }
44 values { 46 values {
45 x: double; 47 x: double; [[X coordinate]]
46 y: double; 48 y: double; [[Y coordinate]]
47 } 49 }
48 } 50 }
49 @property visibility { 51 @property visibility {
@@ -53,7 +55,7 @@ abstract Ector.Renderer (Efl.Object)
53 get { 55 get {
54 } 56 }
55 values { 57 values {
56 v: bool; [[true if to make the object visible, false otherwise]] 58 v: bool; [[$true if to make the object visible, $false otherwise]]
57 } 59 }
58 } 60 }
59 @property color { 61 @property color {
@@ -80,12 +82,13 @@ abstract Ector.Renderer (Efl.Object)
80 } 82 }
81 } 83 }
82 @property mask { 84 @property mask {
85 [[Rendering mask]]
83 set { 86 set {
84 } 87 }
85 get { 88 get {
86 } 89 }
87 values { 90 values {
88 r: Ector.Renderer; 91 r: Ector.Renderer; [[Rendering mask]]
89 } 92 }
90 } 93 }
91 @property quality { 94 @property quality {
@@ -111,20 +114,21 @@ abstract Ector.Renderer (Efl.Object)
111 } 114 }
112 } 115 }
113 draw @virtual_pure { 116 draw @virtual_pure {
114 return: bool; 117 [[Actual draw operation]]
118 return: bool; [[$true on success, $false otherwise]]
115 params { 119 params {
116 @in op: Efl.Gfx.Render_Op; 120 @in op: Efl.Gfx.Render_Op; [[Renderer operation]]
117 @in clips: array<ptr(Eina.Rectangle)>; [[array of @Eina.Rectangle clip]] 121 @in clips: array<ptr(Eina.Rectangle)>; [[Array of @Eina.Rectangle clip]]
118 @in mul_col: uint; 122 @in mul_col: uint; [[Premultiplied color]]
119 } 123 }
120 } 124 }
121 prepare { 125 prepare {
122 return: bool; 126 [[Prepare for rendering]]
123 params { 127 return: bool; [[$true on success, $false otherwise]]
124 }
125 } 128 }
126 done @virtual_pure { 129 done @virtual_pure {
127 return: bool; 130 [[Done with rendering]]
131 return: bool; [[$true on success, $false otherwise]]
128 } 132 }
129 } 133 }
130 implements { 134 implements {
diff --git a/src/lib/ector/ector_renderer_buffer.eo b/src/lib/ector/ector_renderer_buffer.eo
index 27e1eb5c5c..58bd90282b 100644
--- a/src/lib/ector/ector_renderer_buffer.eo
+++ b/src/lib/ector/ector_renderer_buffer.eo
@@ -7,7 +7,7 @@ mixin Ector.Renderer.Buffer (Efl.Interface, Ector.Renderer, Efl.Gfx.Fill)
7 set { [[Sets the source buffer for this renderer, adds a ref]] } 7 set { [[Sets the source buffer for this renderer, adds a ref]] }
8 get { [[Return the current source, no ref change]] } 8 get { [[Return the current source, no ref change]] }
9 values { 9 values {
10 buf: Ector.Buffer; 10 buf: Ector.Buffer; [[Buffer]]
11 } 11 }
12 } 12 }
13 } 13 }
diff --git a/src/lib/ector/ector_renderer_shape.eo b/src/lib/ector/ector_renderer_shape.eo
index c030c3f98e..73d1676c9c 100644
--- a/src/lib/ector/ector_renderer_shape.eo
+++ b/src/lib/ector/ector_renderer_shape.eo
@@ -6,30 +6,33 @@ mixin Ector.Renderer.Shape (Efl.Gfx.Shape)
6 eo_prefix: ector_renderer_shape; 6 eo_prefix: ector_renderer_shape;
7 methods { 7 methods {
8 @property fill { 8 @property fill {
9 [[Fill property]]
9 set { 10 set {
10 } 11 }
11 get { 12 get {
12 } 13 }
13 values { 14 values {
14 r: const(Ector.Renderer); 15 r: const(Ector.Renderer); [[Ector fill renderer]]
15 } 16 }
16 } 17 }
17 @property stroke_fill { 18 @property stroke_fill {
19 [[Stroke fill property]]
18 set { 20 set {
19 } 21 }
20 get { 22 get {
21 } 23 }
22 values { 24 values {
23 r: const(Ector.Renderer); 25 r: const(Ector.Renderer); [[Ector stroke fill renderer]]
24 } 26 }
25 } 27 }
26 @property stroke_marker { 28 @property stroke_marker {
29 [[Stroke marker property]]
27 set { 30 set {
28 } 31 }
29 get { 32 get {
30 } 33 }
31 values { 34 values {
32 r: const(Ector.Renderer); 35 r: const(Ector.Renderer); [[Ector stroke marker renderer]]
33 } 36 }
34 } 37 }
35 } 38 }
diff --git a/src/lib/ector/ector_surface.eo b/src/lib/ector/ector_surface.eo
index da4eea44bd..228a2d130b 100644
--- a/src/lib/ector/ector_surface.eo
+++ b/src/lib/ector/ector_surface.eo
@@ -16,9 +16,9 @@ mixin Ector.Surface (Ector.Buffer)
16 } 16 }
17 renderer_factory_new @virtual_pure { 17 renderer_factory_new @virtual_pure {
18 [[Create a new renderer factory for the given type]] 18 [[Create a new renderer factory for the given type]]
19 return: Efl.Object; /* FIXME: Should be a more restricted type, only here for cyclic. */ 19 return: Efl.Object; [[Renderer factory object]] /* FIXME: Should be a more restricted type, only here for cyclic. */
20 params { 20 params {
21 @in type: const(Efl.Class) @nonull; /* FIXME: Should probably be a more restricted type */ 21 @in type: const(Efl.Class) @nonull; [[Efl class]] /* FIXME: Should probably be a more restricted type */
22 } 22 }
23 } 23 }
24 } 24 }