summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Juyung Seo <seojuyung2@gmail.com>2014-11-22 00:36:32 +0900
committerDaniel Juyung Seo <seojuyung2@gmail.com>2014-11-22 00:38:44 +0900
commit4447c4ef303967fc023ddee84b582022c2fd3544 (patch)
treeaf8ce088442ec3a434bf64d9a2ae4c049f184953
parent41047b64fe7b9fc6fb411e730d17c055e45470eb (diff)
panel, prefs, progressbar: Fix and clean up doxygen documentation.
-rw-r--r--src/lib/elm_panel_common.h23
-rw-r--r--src/lib/elm_prefs_common.h111
-rw-r--r--src/lib/elm_progressbar_common.h9
3 files changed, 90 insertions, 53 deletions
diff --git a/src/lib/elm_panel_common.h b/src/lib/elm_panel_common.h
index fee289a33..2bccf6b05 100644
--- a/src/lib/elm_panel_common.h
+++ b/src/lib/elm_panel_common.h
@@ -1,7 +1,11 @@
1/** 1/**
2 * Panel orientation mode 2 * @addtogroup Panel
3 * 3 *
4 * @ingroup Panel 4 * @{
5 */
6
7/**
8 * Panel orientation mode
5 */ 9 */
6typedef enum 10typedef enum
7{ 11{
@@ -15,11 +19,20 @@ typedef enum
15 * Panel scroll information 19 * Panel scroll information
16 * 20 *
17 * @since 1.11 21 * @since 1.11
18 * @ingroup Panel
19 */ 22 */
20typedef struct _Elm_Panel_Scroll_Info 23typedef struct _Elm_Panel_Scroll_Info Elm_Panel_Scroll_Info;
24/**
25 * Panel scroll information
26 *
27 * @since 1.11
28 */
29struct _Elm_Panel_Scroll_Info
21{ 30{
22 double rel_x; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/ 31 double rel_x; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/
23 double rel_y; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/ 32 double rel_y; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/
24 33
25} Elm_Panel_Scroll_Info; 34};
35
36/**
37 * @}
38 */
diff --git a/src/lib/elm_prefs_common.h b/src/lib/elm_prefs_common.h
index 70f063aaa..3ebe9e25c 100644
--- a/src/lib/elm_prefs_common.h
+++ b/src/lib/elm_prefs_common.h
@@ -1,4 +1,10 @@
1/** 1/**
2 * @addtogroup Prefs
3 *
4 * @{
5 */
6
7/**
2 * Modes of resetting a prefs widget. 8 * Modes of resetting a prefs widget.
3 * 9 *
4 * @see elm_prefs_reset() 10 * @see elm_prefs_reset()
@@ -7,8 +13,8 @@
7 */ 13 */
8typedef enum 14typedef enum
9{ 15{
10 ELM_PREFS_RESET_DEFAULTS, /** reset to default values, declared in its @b .epb file */ 16 ELM_PREFS_RESET_DEFAULTS, /**< reset to default values, declared in its @b .epb file */
11 ELM_PREFS_RESET_LAST /** prefs will keep a small history of changes, so this resets back to last batch of changes on the UI elements. it does @b not work on autosave mode */ 17 ELM_PREFS_RESET_LAST /**< prefs will keep a small history of changes, so this resets back to last batch of changes on the UI elements. it does @b not work on autosave mode */
12} Elm_Prefs_Reset_Mode; 18} Elm_Prefs_Reset_Mode;
13 19
14/** 20/**
@@ -21,29 +27,33 @@ typedef enum
21 */ 27 */
22EAPI Evas_Object *elm_prefs_add(Evas_Object *parent); 28EAPI Evas_Object *elm_prefs_add(Evas_Object *parent);
23 29
24
25/* API for prefs interface modules, from now on */ 30/* API for prefs interface modules, from now on */
26 31
27typedef struct _Elm_Prefs_Item_Spec_Void 32typedef struct _Elm_Prefs_Item_Spec_Void Elm_Prefs_Item_Spec_Void;
33struct _Elm_Prefs_Item_Spec_Void
28{ 34{
29} Elm_Prefs_Item_Spec_Void; 35};
30 36
31typedef struct _Elm_Prefs_Item_Spec_Bool 37typedef struct _Elm_Prefs_Item_Spec_Bool Elm_Prefs_Item_Spec_Bool;
38struct _Elm_Prefs_Item_Spec_Bool
32{ 39{
33 Eina_Bool def; 40 Eina_Bool def;
34} Elm_Prefs_Item_Spec_Bool; 41};
35 42
36typedef struct _Elm_Prefs_Item_Spec_Int 43typedef struct _Elm_Prefs_Item_Spec_Int Elm_Prefs_Item_Spec_Int;
44struct _Elm_Prefs_Item_Spec_Int
37{ 45{
38 int def, min, max; 46 int def, min, max;
39} Elm_Prefs_Item_Spec_Int; 47};
40 48
41typedef struct _Elm_Prefs_Item_Spec_Float 49typedef struct _Elm_Prefs_Item_Spec_Float Elm_Prefs_Item_Spec_Float;
50struct _Elm_Prefs_Item_Spec_Float
42{ 51{
43 float def, min, max; 52 float def, min, max;
44} Elm_Prefs_Item_Spec_Float; 53};
45 54
46typedef struct _Elm_Prefs_Item_Spec_String 55typedef struct _Elm_Prefs_Item_Spec_String Elm_Prefs_Item_Spec_String;
56struct _Elm_Prefs_Item_Spec_String
47{ 57{
48 const char *def; 58 const char *def;
49 const char *placeholder; 59 const char *placeholder;
@@ -54,9 +64,10 @@ typedef struct _Elm_Prefs_Item_Spec_String
54 { 64 {
55 int min, max; 65 int min, max;
56 } length; 66 } length;
57} Elm_Prefs_Item_Spec_String; 67};
58 68
59typedef struct _Elm_Prefs_Item_Spec_Date 69typedef struct _Elm_Prefs_Item_Spec_Date Elm_Prefs_Item_Spec_Date;
70struct _Elm_Prefs_Item_Spec_Date
60{ 71{
61 struct 72 struct
62 { 73 {
@@ -78,14 +89,16 @@ typedef struct _Elm_Prefs_Item_Spec_Date
78 unsigned char m; /* month*/ 89 unsigned char m; /* month*/
79 unsigned short y; /* year */ 90 unsigned short y; /* year */
80 } max; 91 } max;
81} Elm_Prefs_Item_Spec_Date; 92};
82 93
83typedef struct _Elm_Prefs_Item_Spec_Page 94typedef struct _Elm_Prefs_Item_Spec_Page Elm_Prefs_Item_Spec_Page;
95struct _Elm_Prefs_Item_Spec_Page
84{ 96{
85 const char *source; 97 const char *source;
86} Elm_Prefs_Item_Spec_Page; 98};
87 99
88typedef union _Elm_Prefs_Item_Spec 100typedef union _Elm_Prefs_Item_Spec Elm_Prefs_Item_Spec;
101union _Elm_Prefs_Item_Spec
89{ 102{
90 Elm_Prefs_Item_Spec_Void v; 103 Elm_Prefs_Item_Spec_Void v;
91 Elm_Prefs_Item_Spec_Bool b; 104 Elm_Prefs_Item_Spec_Bool b;
@@ -94,24 +107,10 @@ typedef union _Elm_Prefs_Item_Spec
94 Elm_Prefs_Item_Spec_String s; 107 Elm_Prefs_Item_Spec_String s;
95 Elm_Prefs_Item_Spec_Date d; 108 Elm_Prefs_Item_Spec_Date d;
96 Elm_Prefs_Item_Spec_Page p; 109 Elm_Prefs_Item_Spec_Page p;
97} Elm_Prefs_Item_Spec; 110};
98 111
99typedef struct _Elm_Prefs_Item_Iface Elm_Prefs_Item_Iface; 112typedef struct _Elm_Prefs_Item_Iface Elm_Prefs_Item_Iface;
100 113
101/**
102 * Convenience struct used to mass-register widgets implementing
103 * prefs @b items interfaces.
104 *
105 * To be used with elm_prefs_item_iface_register() and
106 * elm_prefs_item_iface_unregister().
107 */
108struct _Elm_Prefs_Item_Iface_Info
109{
110 const char *widget_name; /**< The name of the widget implementing the interface, to be exposed on the prefs collections language. */
111 const Elm_Prefs_Item_Iface *info; /**< The type interface's implementation. */
112};
113typedef struct _Elm_Prefs_Item_Iface_Info Elm_Prefs_Item_Iface_Info;
114
115typedef void (*Elm_Prefs_Item_Changed_Cb)(Evas_Object *it_obj); /**< Elementary prefs' item widget changed function signature */ 114typedef void (*Elm_Prefs_Item_Changed_Cb)(Evas_Object *it_obj); /**< Elementary prefs' item widget changed function signature */
116 115
117/** 116/**
@@ -168,6 +167,20 @@ struct _Elm_Prefs_Item_Iface
168 Eina_Bool (*expand_want)(Evas_Object *obj); /**< function to get wether the item implementation needs to be expanded in the page's longitudinal axis or not */ 167 Eina_Bool (*expand_want)(Evas_Object *obj); /**< function to get wether the item implementation needs to be expanded in the page's longitudinal axis or not */
169}; 168};
170 169
170typedef struct _Elm_Prefs_Item_Iface_Info Elm_Prefs_Item_Iface_Info;
171/**
172 * Convenience struct used to mass-register widgets implementing
173 * prefs @b items interfaces.
174 *
175 * To be used with elm_prefs_item_iface_register() and
176 * elm_prefs_item_iface_unregister().
177 */
178struct _Elm_Prefs_Item_Iface_Info
179{
180 const char *widget_name; /**< The name of the widget implementing the interface, to be exposed on the prefs collections language. */
181 const Elm_Prefs_Item_Iface *info; /**< The type interface's implementation. */
182};
183
171/** 184/**
172 * Mass-register widgets implementing prefs @b items interfaces. 185 * Mass-register widgets implementing prefs @b items interfaces.
173 * 186 *
@@ -203,21 +216,6 @@ EAPI Eina_Bool elm_prefs_item_widget_common_add(Evas_Object *prefs,
203 Evas_Object *obj); 216 Evas_Object *obj);
204 217
205typedef struct _Elm_Prefs_Page_Iface Elm_Prefs_Page_Iface; 218typedef struct _Elm_Prefs_Page_Iface Elm_Prefs_Page_Iface;
206
207/**
208 * Convenience struct used to mass-register widgets implementing
209 * prefs @b pages interfaces.
210 *
211 * To be used with elm_prefs_page_iface_register() and
212 * elm_prefs_page_iface_unregister().
213 */
214struct _Elm_Prefs_Page_Iface_Info
215{
216 const char *widget_name; /**< The name of the widget implementing the interface, to be exposed on the prefs collections language. */
217 const Elm_Prefs_Page_Iface *info; /**< The interface's implementation. */
218};
219typedef struct _Elm_Prefs_Page_Iface_Info Elm_Prefs_Page_Iface_Info;
220
221/** 219/**
222 * @struct _Elm_Prefs_Page_Iface 220 * @struct _Elm_Prefs_Page_Iface
223 * 221 *
@@ -283,6 +281,20 @@ struct _Elm_Prefs_Page_Iface
283 const Elm_Prefs_Item_Iface *iface); 281 const Elm_Prefs_Item_Iface *iface);
284}; 282};
285 283
284typedef struct _Elm_Prefs_Page_Iface_Info Elm_Prefs_Page_Iface_Info;
285/**
286 * Convenience struct used to mass-register widgets implementing
287 * prefs @b pages interfaces.
288 *
289 * To be used with elm_prefs_page_iface_register() and
290 * elm_prefs_page_iface_unregister().
291 */
292struct _Elm_Prefs_Page_Iface_Info
293{
294 const char *widget_name; /**< The name of the widget implementing the interface, to be exposed on the prefs collections language. */
295 const Elm_Prefs_Page_Iface *info; /**< The interface's implementation. */
296};
297
286/** 298/**
287 * Mass-register widgets implementing prefs @b pages interfaces. 299 * Mass-register widgets implementing prefs @b pages interfaces.
288 * 300 *
@@ -314,3 +326,6 @@ EAPI void elm_prefs_page_iface_register(const Elm_Prefs_Page_Iface_Info *ar
314 */ 326 */
315EAPI void elm_prefs_page_iface_unregister(const Elm_Prefs_Page_Iface_Info *array); 327EAPI void elm_prefs_page_iface_unregister(const Elm_Prefs_Page_Iface_Info *array);
316 328
329/**
330 * @}
331 */
diff --git a/src/lib/elm_progressbar_common.h b/src/lib/elm_progressbar_common.h
index ccad880df..a4704deb7 100644
--- a/src/lib/elm_progressbar_common.h
+++ b/src/lib/elm_progressbar_common.h
@@ -1,3 +1,12 @@
1/**
2 * @addtogroup Progressbar
3 *
4 * @{
5 */
6
1typedef char *(*progressbar_func_type)(double); 7typedef char *(*progressbar_func_type)(double);
2typedef void (*progressbar_freefunc_type)(char *); 8typedef void (*progressbar_freefunc_type)(char *);
3 9
10/**
11 * @}
12 */