summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-11 16:14:37 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-11 16:14:37 +0100
commitadbe4dcc0632499c48eff00f127c7c75b75ab08a (patch)
tree3a9953b4757828030f63b7ecaa299a9425b9d22f /src
parent4bdf82908e27b0eccdce91fbb38ca2983fa9227e (diff)
edje,evas: convert type docs to new format
Diffstat (limited to 'src')
-rw-r--r--src/lib/edje/edje_types.eot14
-rw-r--r--src/lib/evas/canvas/evas_types.eot159
2 files changed, 88 insertions, 85 deletions
diff --git a/src/lib/edje/edje_types.eot b/src/lib/edje/edje_types.eot
index d17a3d4ffc..c44bd53147 100644
--- a/src/lib/edje/edje_types.eot
+++ b/src/lib/edje/edje_types.eot
@@ -85,13 +85,13 @@ enum Edje.Input_Panel.Layout {
85enum Edje.External.Param_Type { 85enum Edje.External.Param_Type {
86 [[The possible types the parameters of an EXTERNAL part can be.]] 86 [[The possible types the parameters of an EXTERNAL part can be.]]
87 87
88 int, /**< Parameter value is an integer. */ 88 int, [[Parameter value is an integer.]]
89 double, /**< Parameter value is a double. */ 89 double, [[Parameter value is a double.]]
90 string, /**< Parameter value is a string. */ 90 string, [[Parameter value is a string.]]
91 bool, /**< Parameter value is boolean. */ 91 bool, [[Parameter value is boolean.]]
92 choice, /**< Parameter value is one of a set of 92 choice, [[Parameter value is one of a set of
93 predefined string choices. */ 93 predefined string choices.]]
94 max /**< Sentinel. Don't use. */ 94 max [[Sentinel. Don't use.]]
95} 95}
96 96
97struct Edje.External.Param { 97struct Edje.External.Param {
diff --git a/src/lib/evas/canvas/evas_types.eot b/src/lib/evas/canvas/evas_types.eot
index 262f7cdedb..3128bd0707 100644
--- a/src/lib/evas/canvas/evas_types.eot
+++ b/src/lib/evas/canvas/evas_types.eot
@@ -1,61 +1,69 @@
1type Evas.Modifier_Mask: ullong; /*@ An Evas modifier mask type */ 1type Evas.Modifier_Mask: ullong; [[An Evas modifier mask type]]
2type Evas.Coord: int; /*@ A type for coordinates */ 2type Evas.Coord: int; [[A type for coordinates]]
3enum Evas.Aspect_Control { 3enum Evas.Aspect_Control {
4 /**< Aspect types/policies for scaling size hints, used for evas_object_size_hint_aspect_set() */ 4 [[Aspect types/policies for scaling size hints, used for
5 none = 0, /**< Preference on scaling unset */ 5 evas_object_size_hint_aspect_set()]]
6 neither = 1, /**< Same effect as unset preference on scaling */ 6 none = 0, [[Preference on scaling unset]]
7 horizontal = 2, /**< Use all horizontal container space to place an object, using the given aspect */ 7 neither = 1, [[Same effect as unset preference on scaling]]
8 vertical = 3, /**< Use all vertical container space to place an object, using the given aspect */ 8 horizontal = 2, [[Use all horizontal container space to place an object,
9 both = 4 /**< Use all horizontal @b and vertical container spaces to place an object (never growing it out of those bounds), using the given aspect */ 9 using the given aspect]]
10 vertical = 3, [[Use all vertical container space to place an object, using
11 the given aspect]]
12 both = 4 [[Use all horizontal @b and vertical container spaces to place an
13 object (never growing it out of those bounds), using the given
14 aspect]]
10} 15}
11 16
12enum Evas.Render_Op { 17enum Evas.Render_Op {
13 /*@ 18 [[How the object should be rendered to output.]]
14 * How the object should be rendered to output.
15 * @ingroup Evas_Object_Group_Extras
16 */
17 legacy: Evas_Render; 19 legacy: Evas_Render;
18 20
19 blend = 0, /**< default op: d = d*(1-sa) + s */ 21 blend = 0, [[default op: d = d*(1-sa) + s]]
20 blend_rel = 1, /**< d = d*(1 - sa) + s*da */ 22 blend_rel = 1, [[d = d*(1 - sa) + s*da]]
21 copy = 2, /**< d = s */ 23 copy = 2, [[d = s]]
22 copy_rel = 3, /**< d = s*da */ 24 copy_rel = 3, [[d = s*da]]
23 add = 4, /* d = d + s */ 25 add = 4, [[d = d + s]]
24 add_rel = 5, /**< d = d + s*da */ 26 add_rel = 5, [[d = d + s*da]]
25 sub = 6, /**< d = d - s */ 27 sub = 6, [[d = d - s]]
26 sub_rel = 7, /* d = d - s*da */ 28 sub_rel = 7, [[d = d - s*da]]
27 tint = 8, /**< d = d*s + d*(1 - sa) + s*(1 - da) */ 29 tint = 8, [[d = d*s + d*(1 - sa) + s*(1 - da)]]
28 tint_rel = 9, /**< d = d*(1 - sa + s) */ 30 tint_rel = 9, [[d = d*(1 - sa + s)]]
29 mask = 10, /**< d = d*sa */ 31 mask = 10, [[d = d*sa]]
30 mul = 11 /**< d = d*s */ 32 mul = 11 [[d = d*s]]
31} 33}
32 34
33enum Evas.Object_Pointer_Mode { 35enum Evas.Object_Pointer_Mode {
34 /** 36 [[How the mouse pointer should be handled by Evas.
35 * How the mouse pointer should be handled by Evas. 37
36 * 38 In the mode #EVAS_OBJECT_POINTER_MODE_AUTOGRAB, when a mouse button
37 * In the mode #EVAS_OBJECT_POINTER_MODE_AUTOGRAB, when a mouse button 39 is pressed down over an object and held, with the mouse pointer
38 * is pressed down over an object and held, with the mouse pointer 40 being moved outside of it, the pointer still behaves as being bound
39 * being moved outside of it, the pointer still behaves as being bound 41 to that object, albeit out of its drawing region. When the button
40 * to that object, albeit out of its drawing region. When the button 42 is released, the event will be fed to the object, that may check if
41 * is released, the event will be fed to the object, that may check if 43 the final position is over it or not and do something about it.
42 * the final position is over it or not and do something about it. 44
43 * 45 In the mode #EVAS_OBJECT_POINTER_MODE_NOGRAB, the pointer will
44 * In the mode #EVAS_OBJECT_POINTER_MODE_NOGRAB, the pointer will 46 always be bound to the object right below it.
45 * always be bound to the object right below it. 47 ]]
46 * 48 autograb, [[default, X11-like]]
47 * @ingroup Evas_Object_Group_Extras 49 nograb, [[pointer always bound to the object right below it]]
48 */ 50 nograb_no_repeat_updown [[useful on object with "repeat events" enabled,
49 autograb, /**< default, X11-like */ 51 where mouse/touch up and down events WONT be
50 nograb, /**< pointer always bound to the object right below it */ 52 repeated to objects and these objects wont be
51 nograb_no_repeat_updown /**< useful on object with "repeat events" enabled, where mouse/touch up and down events WONT be repeated to objects and these objects wont be auto-grabbed. @since 1.2 */ 53 auto-grabbed.
54
55 @since 1.2
56 ]]
52} 57}
53 58
54enum Evas.Display_Mode { 59enum Evas.Display_Mode {
55 none = 0, /**<Default mode */ 60 none = 0, [[Default mode]]
56 compress = 1, /**< Use this mode when you want to give compress display mode hint to an object */ 61 compress = 1, [[Use this mode when you want to give compress display mode
57 expand = 2, /**< Use this mode when you want to give expand display mode hint to an object */ 62 hint to an object]]
58 dont_change = 3 /**< Use this mode when an object should not change its display mode */ 63 expand = 2, [[Use this mode when you want to give expand display mode hint
64 to an object]]
65 dont_change = 3 [[Use this mode when an object should not change its display
66 mode]]
59} 67}
60 68
61enum Evas.BiDi_Direction { 69enum Evas.BiDi_Direction {
@@ -68,36 +76,35 @@ enum Evas.BiDi_Direction {
68} 76}
69 77
70enum Evas.Text_Style_Type { 78enum Evas.Text_Style_Type {
71 /*@ 79 [[Types of styles to be applied on text objects. The
72 * Types of styles to be applied on text objects. The @c 80 EVAS_TEXT_STYLE_SHADOW_DIRECTION_* ones are to be ORed together with
73 * EVAS_TEXT_STYLE_SHADOW_DIRECTION_* ones are to be ORed together with others 81 others imposing shadow, to change shadow's direction
74 * imposing shadow, to change shadow's direction 82 ]]
75 */
76 legacy: Evas_Text_Style; 83 legacy: Evas_Text_Style;
77 84
78 plain, /**< plain, standard text */ 85 plain, [[plain, standard text]]
79 shadow, /**< text with shadow underneath */ 86 shadow, [[text with shadow underneath]]
80 outline, /**< text with an outline */ 87 outline, [[text with an outline]]
81 soft_outline, /**< text with a soft outline */ 88 soft_outline, [[text with a soft outline]]
82 glow, /**< text with a glow effect */ 89 glow, [[text with a glow effect]]
83 outline_shadow, /**< text with both outline and shadow effects */ 90 outline_shadow, [[text with both outline and shadow effects]]
84 far_shadow, /**< text with (far) shadow underneath */ 91 far_shadow, [[text with (far) shadow underneath]]
85 outline_soft_shadow, /**< text with outline and soft shadow effects combined */ 92 outline_soft_shadow, [[text with outline and soft shadow effects combined]]
86 soft_shadow, /**< text with (soft) shadow underneath */ 93 soft_shadow, [[text with (soft) shadow underneath]]
87 far_soft_shadow, /**< text with (far soft) shadow underneath */ 94 far_soft_shadow, [[text with (far soft) shadow underneath]]
88 95
89 /* OR these to modify shadow direction (3 bits needed) */ 96 /* OR these to modify shadow direction (3 bits needed) */
90 shadow_direction_bottom_right = (0x0 << 4), /**< shadow growing to bottom right */ 97 shadow_direction_bottom_right = (0x0 << 4), [[shadow growing to bottom right]]
91 shadow_direction_bottom = (0x1 << 4), /**< shadow growing to the bottom */ 98 shadow_direction_bottom = (0x1 << 4), [[shadow growing to the bottom]]
92 shadow_direction_bottom_left = (0x2 << 4), /**< shadow growing to bottom left */ 99 shadow_direction_bottom_left = (0x2 << 4), [[shadow growing to bottom left]]
93 shadow_direction_left = (0x3 << 4), /**< shadow growing to the left */ 100 shadow_direction_left = (0x3 << 4), [[shadow growing to the left]]
94 shadow_direction_top_left = (0x4 << 4), /**< shadow growing to top left */ 101 shadow_direction_top_left = (0x4 << 4), [[shadow growing to top left]]
95 shadow_direction_top = (0x5 << 4), /**< shadow growing to the top */ 102 shadow_direction_top = (0x5 << 4), [[shadow growing to the top]]
96 shadow_direction_top_right = (0x6 << 4), /**< shadow growing to top right */ 103 shadow_direction_top_right = (0x6 << 4), [[shadow growing to top right]]
97 shadow_direction_right = (0x7 << 4) /**< shadow growing to the right */ 104 shadow_direction_right = (0x7 << 4) [[shadow growing to the right]]
98} 105}
99 106
100type Evas.Font.Size: int; /**< A type for font size */ 107type Evas.Font.Size: int; [[A type for font size]]
101 108
102enum Evas.Font.Hinting_Flags { 109enum Evas.Font.Hinting_Flags {
103 [[Flags for Font Hinting]] 110 [[Flags for Font Hinting]]
@@ -108,14 +115,10 @@ enum Evas.Font.Hinting_Flags {
108 bytecode [[Bytecode font hinting]] 115 bytecode [[Bytecode font hinting]]
109} 116}
110 117
111struct Evas.Map; /*@ An opaque handle to map points 118struct Evas.Map; [[An opaque handle to map points
112 * 119
113 * @see evas_map_new() 120 See @evas_map_new, @evas_map_free, @evas_map_dup.
114 * @see evas_map_free() 121 ]]
115 * @see evas_map_dup()
116 *
117 * @ingroup Evas_Object_Group_Map
118 */
119 122
120enum Evas.Button_Flags { 123enum Evas.Button_Flags {
121 [[Flags for Mouse Button events]] 124 [[Flags for Mouse Button events]]