summaryrefslogtreecommitdiff
path: root/src/lib/efl
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2018-11-28 13:33:46 +0100
committerDaniel Kolesa <d.kolesa@samsung.com>2018-11-28 13:33:46 +0100
commit05682eed7d572874928424af82fba819790c4228 (patch)
treee95f5777ba237b378c2ceb166ce6657a6214e2fd /src/lib/efl
parentc602c075cada6eb56158d398c27f57b522bafdc7 (diff)
eo-docs: Remove Doxygen tags from efl*.eo files
Summary: - Replace '\@ref name' with '@name' - Remove unused \@internal tag This tag affects text AFTER it, and there is no text after it. - Remove \@note tag Replaced with a simple NOTE: text, since eolian does not have an equivalent tag. - Remove spurious \@Efl... tags They should really be @Efl... - Remove \@p tags There is no eolian equivalent, and a simpler $ suffices in this case. Fixes T7482 Reviewers: q66 Reviewed By: q66 Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T7482 Differential Revision: https://phab.enlightenment.org/D7372
Diffstat (limited to 'src/lib/efl')
-rw-r--r--src/lib/efl/interfaces/efl_gfx_color.eo2
-rw-r--r--src/lib/efl/interfaces/efl_gfx_color_class.eo4
-rw-r--r--src/lib/efl/interfaces/efl_gfx_image.eo1
-rw-r--r--src/lib/efl/interfaces/efl_gfx_path.eo2
-rw-r--r--src/lib/efl/interfaces/efl_gfx_shape.eo16
-rw-r--r--src/lib/efl/interfaces/efl_gfx_size_hint.eo2
-rw-r--r--src/lib/efl/interfaces/efl_model.eo20
7 files changed, 22 insertions, 25 deletions
diff --git a/src/lib/efl/interfaces/efl_gfx_color.eo b/src/lib/efl/interfaces/efl_gfx_color.eo
index 21f18d144e..6e1aa2b260 100644
--- a/src/lib/efl/interfaces/efl_gfx_color.eo
+++ b/src/lib/efl/interfaces/efl_gfx_color.eo
@@ -34,8 +34,6 @@ mixin Efl.Gfx.Color
34 34
35 Use null pointers on the components you're not interested 35 Use null pointers on the components you're not interested
36 in: they'll be ignored by the function. 36 in: they'll be ignored by the function.
37
38 See the full \@ref Example_Evas_Object_Manipulation "example".
39 ]] 37 ]]
40 } 38 }
41 values { 39 values {
diff --git a/src/lib/efl/interfaces/efl_gfx_color_class.eo b/src/lib/efl/interfaces/efl_gfx_color_class.eo
index 116e2c9964..f0d4dcb866 100644
--- a/src/lib/efl/interfaces/efl_gfx_color_class.eo
+++ b/src/lib/efl/interfaces/efl_gfx_color_class.eo
@@ -19,7 +19,7 @@ interface Efl.Gfx.Color_Class
19 Setting color emits a signal "color_class,set" with source being 19 Setting color emits a signal "color_class,set" with source being
20 the given color. 20 the given color.
21 21
22 Note: These color values are expected to be premultiplied by \@p a.]] 22 Note: These color values are expected to be premultiplied by $a.]]
23 return: bool; [[$true if setting the color succeeded, $false otherwise]] 23 return: bool; [[$true if setting the color succeeded, $false otherwise]]
24 } 24 }
25 get { 25 get {
@@ -32,7 +32,7 @@ interface Efl.Gfx.Color_Class
32 the third is the text shadow. (Note that the second two only apply 32 the third is the text shadow. (Note that the second two only apply
33 to text parts). 33 to text parts).
34 34
35 Note: These color values are expected to be premultiplied by \@p a.]] 35 Note: These color values are expected to be premultiplied by $a.]]
36 return: bool; [[$true if getting the color succeeded, $false otherwise]] 36 return: bool; [[$true if getting the color succeeded, $false otherwise]]
37 } 37 }
38 keys { 38 keys {
diff --git a/src/lib/efl/interfaces/efl_gfx_image.eo b/src/lib/efl/interfaces/efl_gfx_image.eo
index 1dd77f3058..8a6e284786 100644
--- a/src/lib/efl/interfaces/efl_gfx_image.eo
+++ b/src/lib/efl/interfaces/efl_gfx_image.eo
@@ -1,4 +1,5 @@
1import efl_gfx_types; 1import efl_gfx_types;
2import eina_types;
2 3
3enum Efl.Gfx.Image_Content_Hint 4enum Efl.Gfx.Image_Content_Hint
4{ 5{
diff --git a/src/lib/efl/interfaces/efl_gfx_path.eo b/src/lib/efl/interfaces/efl_gfx_path.eo
index bef075afe4..1efb7fc95e 100644
--- a/src/lib/efl/interfaces/efl_gfx_path.eo
+++ b/src/lib/efl/interfaces/efl_gfx_path.eo
@@ -9,8 +9,6 @@ mixin Efl.Gfx.Path
9 [[Set the list of commands and points to be used to create the 9 [[Set the list of commands and points to be used to create the
10 content of path. 10 content of path.
11 11
12 See \@ref efl_gfx_path interface for how to create a command list.
13
14 @since 1.18 12 @since 1.18
15 ]] 13 ]]
16 set { 14 set {
diff --git a/src/lib/efl/interfaces/efl_gfx_shape.eo b/src/lib/efl/interfaces/efl_gfx_shape.eo
index 54dcfe8b5f..10f55a0eef 100644
--- a/src/lib/efl/interfaces/efl_gfx_shape.eo
+++ b/src/lib/efl/interfaces/efl_gfx_shape.eo
@@ -59,10 +59,10 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
59 } 59 }
60 @property stroke_dash { 60 @property stroke_dash {
61 [[Set stroke dash pattern. A dash pattern is specified by dashes, 61 [[Set stroke dash pattern. A dash pattern is specified by dashes,
62 an array of Efl_Gfx_Dash. Efl_Gfx_Dash values(length, gap) 62 an array of @Efl.Gfx.Dash. @Efl.Gfx.Dash values(length, gap)
63 must be positive. 63 must be positive.
64 64
65 See also \@ref Efl_Gfx_Dash 65 See also @Efl.Gfx.Dash
66 ]] 66 ]]
67 set { 67 set {
68 } 68 }
@@ -78,7 +78,7 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
78 The cap will be used for capping the end point of a 78 The cap will be used for capping the end point of a
79 open subpath. 79 open subpath.
80 80
81 See also \@ref Efl_Gfx_Cap. 81 See also @Efl.Gfx.Cap.
82 82
83 @since 1.14 83 @since 1.14
84 ]] 84 ]]
@@ -87,7 +87,7 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
87 get { 87 get {
88 } 88 }
89 values { 89 values {
90 c: Efl.Gfx.Cap; [[Cap style to use, default is EFL_GFX_CAP_BUTT]] 90 c: Efl.Gfx.Cap; [[Cap style to use, default is @Efl.Gfx.Cap.butt]]
91 } 91 }
92 } 92 }
93 @property stroke_join { 93 @property stroke_join {
@@ -95,7 +95,7 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
95 The join style will be used for joining the two line segment 95 The join style will be used for joining the two line segment
96 while stroking the path. 96 while stroking the path.
97 97
98 See also \@ref Efl_Gfx_Join. 98 See also @Efl.Gfx.Join.
99 99
100 @since 1.14 100 @since 1.14
101 ]] 101 ]]
@@ -104,12 +104,12 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
104 get { 104 get {
105 } 105 }
106 values { 106 values {
107 j: Efl.Gfx.Join; [[Join style to use, default is EFL_GFX_JOIN_MITER]] 107 j: Efl.Gfx.Join; [[Join style to use, default is @Efl.Gfx.Join.miter]]
108 } 108 }
109 } 109 }
110 @property fill_rule { 110 @property fill_rule {
111 [[The fill rule of the given shape object. 111 [[The fill rule of the given shape object.
112 $EFL_GFX_FILL_RULE_WINDING, or $EFL_GFX_FILL_RULE_ODD_EVEN. 112 @Efl.Gfx.Fill_Rule.winding or @Efl.Gfx.Fill_Rule.odd_even.
113 113
114 @since 1.14 114 @since 1.14
115 ]] 115 ]]
@@ -119,7 +119,7 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
119 } 119 }
120 values { 120 values {
121 fill_rule: Efl.Gfx.Fill_Rule; [[The current fill rule of the shape object. 121 fill_rule: Efl.Gfx.Fill_Rule; [[The current fill rule of the shape object.
122 One of $EFL_GFX_FILL_RULE_WINDING, $EFL_GFX_FILL_RULE_ODD_EVEN]] 122 One of @Efl.Gfx.Fill_Rule.winding or @Efl.Gfx.Fill_Rule.odd_even]]
123 } 123 }
124 } 124 }
125 } 125 }
diff --git a/src/lib/efl/interfaces/efl_gfx_size_hint.eo b/src/lib/efl/interfaces/efl_gfx_size_hint.eo
index 3186d7b9ed..4fa45eefc4 100644
--- a/src/lib/efl/interfaces/efl_gfx_size_hint.eo
+++ b/src/lib/efl/interfaces/efl_gfx_size_hint.eo
@@ -211,7 +211,7 @@ interface Efl.Gfx.Size_Hint
211 scene composition. 211 scene composition.
212 212
213 See documentation of possible users: in Evas, they are the 213 See documentation of possible users: in Evas, they are the
214 \@ref Evas_Object_Box "box" and \@ref Evas_Object_Table "table" 214 @Efl.Ui.Box "box" and @Efl.Ui.Table "table"
215 smart objects. 215 smart objects.
216 216
217 For the horizontal component, 0.0 means to the left, 1.0 217 For the horizontal component, 0.0 means to the left, 1.0
diff --git a/src/lib/efl/interfaces/efl_model.eo b/src/lib/efl/interfaces/efl_model.eo
index ff06a321a8..a92a0650c2 100644
--- a/src/lib/efl/interfaces/efl_model.eo
+++ b/src/lib/efl/interfaces/efl_model.eo
@@ -5,7 +5,7 @@ struct Efl.Model_Property_Event {
5} 5}
6 6
7struct Efl.Model_Children_Event { 7struct Efl.Model_Children_Event {
8 [[Every time a child is added the event EFL_MODEL_EVENT_CHILD_ADDED is dispatched 8 [[Every time a child is added the event @[Efl.Model.child,added] is dispatched
9 passing along this structure.]] 9 passing along this structure.]]
10 index: uint; [[index is a hint and is intended to provide a way for applications 10 index: uint; [[index is a hint and is intended to provide a way for applications
11 to control/know children relative positions through listings.]] 11 to control/know children relative positions through listings.]]
@@ -24,10 +24,10 @@ interface Efl.Model ()
24 24
25 properties_get is due to provide callers a way the fetch the 25 properties_get is due to provide callers a way the fetch the
26 current properties implemented/used by the model. The event 26 current properties implemented/used by the model. The event
27 EFL_MODEL_EVENT_PROPERTIES_CHANGED will be raised to notify 27 @[Efl.Model.properties,changed] will be raised to notify
28 listeners of any modifications in the properties. 28 listeners of any modifications in the properties.
29 29
30 See also \@ref EFL_MODEL_EVENT_PROPERTIES_CHANGED. 30 See also @[Efl.Model.properties,changed].
31 31
32 @since 1.14 32 @since 1.14
33 ]] 33 ]]
@@ -44,14 +44,14 @@ interface Efl.Model ()
44 before being able to see/set properties. This function sets 44 before being able to see/set properties. This function sets
45 a new property value into given property name. Once the 45 a new property value into given property name. Once the
46 operation is completed the concrete implementation should 46 operation is completed the concrete implementation should
47 raise EFL_MODEL_EVENT_PROPERTIES_CHANGED event in order to 47 raise @[Efl.Model.properties,changed] event in order to
48 notify listeners of the new value of the property. 48 notify listeners of the new value of the property.
49 49
50 If the model doesn't have the property then there are two 50 If the model doesn't have the property then there are two
51 possibilities, either raise an error or create the new 51 possibilities, either raise an error or create the new
52 property in model 52 property in model
53 53
54 See @.property.get, \@ref EFL_MODEL_EVENT_PROPERTIES_CHANGED 54 See @.property.get, @[Efl.Model.properties,changed]
55 55
56 @since 1.14 56 @since 1.14
57 ]] 57 ]]
@@ -61,10 +61,10 @@ interface Efl.Model ()
61 [[Retrieve the value of a given property name. 61 [[Retrieve the value of a given property name.
62 62
63 At this point the caller is free to get values from properties. 63 At this point the caller is free to get values from properties.
64 The event EFL_MODEL_EVENT_PROPERTIES_CHANGED may be raised to 64 The event @[Efl.Model.properties,changed] may be raised to
65 notify listeners of the property/value. 65 notify listeners of the property/value.
66 66
67 See @.properties.get, \@ref EFL_MODEL_EVENT_PROPERTIES_CHANGED 67 See @.properties.get, @[Efl.Model.properties,changed]
68 68
69 @since 1.14 69 @since 1.14
70 ]] 70 ]]
@@ -134,7 +134,7 @@ interface Efl.Model ()
134 When efl_model_load is completed efl_model_coildren_count_get 134 When efl_model_load is completed efl_model_coildren_count_get
135 can be used to get the number of children. children_count_get 135 can be used to get the number of children. children_count_get
136 can also be used before calling children_slice_get so a valid 136 can also be used before calling children_slice_get so a valid
137 range is known. Event EFL_MODEL_CHILDREN_COUNT_CHANGED is 137 range is known. Event @[Efl.Model.children,count,changed] is
138 emitted when count is finished. 138 emitted when count is finished.
139 139
140 See also @.children_slice_get. 140 See also @.children_slice_get.
@@ -151,7 +151,7 @@ interface Efl.Model ()
151 151
152 Add a new child, possibly dummy, depending on the implementation, 152 Add a new child, possibly dummy, depending on the implementation,
153 of a internal keeping. When the child is effectively 153 of a internal keeping. When the child is effectively
154 added the event \@ref EFL_MODEL_EVENT_CHILD_ADDED is then raised 154 added the event @[Efl.Model.child,added] is then raised
155 and the new child is kept along with other children. 155 and the new child is kept along with other children.
156 156
157 @since 1.14 157 @since 1.14
@@ -162,7 +162,7 @@ interface Efl.Model ()
162 [[Remove a child. 162 [[Remove a child.
163 163
164 Remove a child of a internal keeping. When the child is effectively 164 Remove a child of a internal keeping. When the child is effectively
165 removed the event \@ref EFL_MODEL_EVENT_CHILD_REMOVED is then 165 removed the event @[Efl.Model.child,removed] is then
166 raised to give a chance for listeners to perform any cleanup 166 raised to give a chance for listeners to perform any cleanup
167 and/or update references. 167 and/or update references.
168 168