summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_model.eo
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/interfaces/efl_model.eo
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 '')
-rw-r--r--src/lib/efl/interfaces/efl_model.eo20
1 files changed, 10 insertions, 10 deletions
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