summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Juyung Seo <seojuyung2@gmail.com>2014-11-20 23:29:17 +0900
committerDaniel Juyung Seo <seojuyung2@gmail.com>2014-11-22 00:38:44 +0900
commit73a59b5812a1b0e8b218c9c0cd4e8fa841a35179 (patch)
tree8239aa06f4918d5d582e464471db90f199149a02
parentc13754ff9a047f94560f6c4aea5488fa9e3ccf15 (diff)
box, bubble, calendar: Fix and clean up doxygen documentation.
-rw-r--r--src/lib/elm_box_common.h16
-rw-r--r--src/lib/elm_bubble_common.h9
-rw-r--r--src/lib/elm_calendar_common.h92
3 files changed, 54 insertions, 63 deletions
diff --git a/src/lib/elm_box_common.h b/src/lib/elm_box_common.h
index b0899b0a1..2aefa3796 100644
--- a/src/lib/elm_box_common.h
+++ b/src/lib/elm_box_common.h
@@ -1,4 +1,10 @@
1/** 1/**
2 * @addtogroup Box
3 *
4 * @{
5 */
6
7/**
2 * @typedef Elm_Box_Transition 8 * @typedef Elm_Box_Transition
3 * 9 *
4 * Opaque handler containing the parameters to perform an animated 10 * Opaque handler containing the parameters to perform an animated
@@ -41,8 +47,6 @@ typedef struct _Elm_Box_Transition Elm_Box_Transition;
41 * @see elm_box_transition_new 47 * @see elm_box_transition_new
42 * @see elm_box_transition_free 48 * @see elm_box_transition_free
43 * @see elm_box_layout_set 49 * @see elm_box_layout_set
44 *
45 * @ingroup Box
46 */ 50 */
47EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data); 51EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
48 52
@@ -76,8 +80,6 @@ EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object
76 * 80 *
77 * @see elm_box_transition_new 81 * @see elm_box_transition_new
78 * @see elm_box_layout_transition 82 * @see elm_box_layout_transition
79 *
80 * @ingroup Box
81 */ 83 */
82EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, Ecore_Cb start_layout_free_data, Evas_Object_Box_Layout end_layout, void *end_layout_data, Ecore_Cb end_layout_free_data, Ecore_Cb transition_end_cb, void *transition_end_data); 84EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, Ecore_Cb start_layout_free_data, Evas_Object_Box_Layout end_layout, void *end_layout_data, Ecore_Cb end_layout_free_data, Ecore_Cb transition_end_cb, void *transition_end_data);
83 85
@@ -91,7 +93,9 @@ EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Obje
91 * 93 *
92 * @see elm_box_transition_new 94 * @see elm_box_transition_new
93 * @see elm_box_layout_transition 95 * @see elm_box_layout_transition
94 *
95 * @ingroup Box
96 */ 96 */
97EAPI void elm_box_transition_free(void *data); 97EAPI void elm_box_transition_free(void *data);
98
99/**
100 * @}
101 */
diff --git a/src/lib/elm_bubble_common.h b/src/lib/elm_bubble_common.h
index 12e832fca..0e3c94e23 100644
--- a/src/lib/elm_bubble_common.h
+++ b/src/lib/elm_bubble_common.h
@@ -1,4 +1,10 @@
1/** 1/**
2 * @addtogroup Bubble
3 *
4 * @{
5 */
6
7/**
2 * Defines the corner values for a bubble. 8 * Defines the corner values for a bubble.
3 * 9 *
4 * The corner will be used to determine where the arrow of the 10 * The corner will be used to determine where the arrow of the
@@ -13,3 +19,6 @@ typedef enum
13 ELM_BUBBLE_POS_BOTTOM_RIGHT, /**< the arrow of the bubble points to the bottom right corner. */ 19 ELM_BUBBLE_POS_BOTTOM_RIGHT, /**< the arrow of the bubble points to the bottom right corner. */
14} Elm_Bubble_Pos; 20} Elm_Bubble_Pos;
15 21
22/**
23 * @}
24 */
diff --git a/src/lib/elm_calendar_common.h b/src/lib/elm_calendar_common.h
index 6ce181e86..556a16178 100644
--- a/src/lib/elm_calendar_common.h
+++ b/src/lib/elm_calendar_common.h
@@ -1,17 +1,10 @@
1typedef enum
2{
3 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
4 ELM_CALENDAR_DAILY, /**< Marks will be displayed every day after event day (inclusive). */
5 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
6 ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
7 ELM_CALENDAR_ANNUALLY, /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
8 ELM_CALENDAR_LAST_DAY_OF_MONTH /**< Marks will be displayed every last day of month after event day (inclusive). @since 1.7 */
9} _Elm_Calendar_Mark_Repeat_Type;
10
11/** 1/**
12 * @enum _Elm_Calendar_Mark_Repeat_Type 2 * @addtogroup Calendar
13 * @typedef Elm_Calendar_Mark_Repeat_Type
14 * 3 *
4 * @{
5 */
6/**
7 * @enum Elm_Calendar_Mark_Repeat_Type
15 * Event periodicity, used to define if a mark should be repeated 8 * Event periodicity, used to define if a mark should be repeated
16 * @b beyond event's day. It's set when a mark is added. 9 * @b beyond event's day. It's set when a mark is added.
17 * 10 *
@@ -22,11 +15,23 @@ typedef enum
22 * Values don't work as bitmask, only one can be chosen. 15 * Values don't work as bitmask, only one can be chosen.
23 * 16 *
24 * @see elm_calendar_mark_add() 17 * @see elm_calendar_mark_add()
25 *
26 * @ingroup Calendar
27 */ 18 */
28typedef _Elm_Calendar_Mark_Repeat_Type Elm_Calendar_Mark_Repeat_Type; 19typedef enum
20{
21 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
22 ELM_CALENDAR_DAILY, /**< Marks will be displayed every day after event day (inclusive). */
23 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24 ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
25 ELM_CALENDAR_ANNUALLY, /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
26 ELM_CALENDAR_LAST_DAY_OF_MONTH /**< Marks will be displayed every last day of month after event day (inclusive). @since 1.7 */
27} Elm_Calendar_Mark_Repeat_Type;
29 28
29/**
30 * @enum Elm_Calendar_Weekday
31 * A weekday
32 *
33 * @see elm_calendar_first_day_of_week_set()
34 */
30typedef enum 35typedef enum
31{ 36{
32 ELM_DAY_SUNDAY, 37 ELM_DAY_SUNDAY,
@@ -37,68 +42,44 @@ typedef enum
37 ELM_DAY_FRIDAY, 42 ELM_DAY_FRIDAY,
38 ELM_DAY_SATURDAY, 43 ELM_DAY_SATURDAY,
39 ELM_DAY_LAST 44 ELM_DAY_LAST
40} _Elm_Calendar_Weekday; 45} Elm_Calendar_Weekday;
41 46
42/** 47/**
43 * @enum _Elm_Calendar_Weekday 48 * @enum Elm_Calendar_Select_Mode
44 * @typedef Elm_Calendar_Weekday
45 * 49 *
46 * a weekday 50 * The mode, who determine how user could select a day
47 * 51 *
48 * @see elm_calendar_first_day_of_week_set() 52 * @see elm_calendar_select_mode_set()
49 *
50 * @ingroup Calendar
51 */ 53 */
52typedef _Elm_Calendar_Weekday Elm_Calendar_Weekday;
53
54
55typedef enum 54typedef enum
56{ 55{
57 ELM_CALENDAR_SELECT_MODE_DEFAULT = 0, /**< Default value. a day is always selected. */ 56 ELM_CALENDAR_SELECT_MODE_DEFAULT = 0, /**< Default value. a day is always selected. */
58 ELM_CALENDAR_SELECT_MODE_ALWAYS, /**< a day is always selected. */ 57 ELM_CALENDAR_SELECT_MODE_ALWAYS, /**< a day is always selected. */
59 ELM_CALENDAR_SELECT_MODE_NONE, /**< None of the days can be selected. */ 58 ELM_CALENDAR_SELECT_MODE_NONE, /**< None of the days can be selected. */
60 ELM_CALENDAR_SELECT_MODE_ONDEMAND /**< User may have selected a day or not. */ 59 ELM_CALENDAR_SELECT_MODE_ONDEMAND /**< User may have selected a day or not. */
61} _Elm_Calendar_Select_Mode; 60} Elm_Calendar_Select_Mode;
62 61
63/** 62/**
64 * @enum _Elm_Calendar_Select_Mode 63 * @Elm_Calendar_Selectable
65 * @typedef Elm_Calendar_Select_Mode
66 * 64 *
67 * the mode, who determine how user could select a day 65 * A bitmask used to define which fields of a @b tm struct will be taken into
68 * 66 * account, when elm_calendar_selected_time_set() is invoked.
69 * @see elm_calendar_select_mode_set()
70 * 67 *
71 * @ingroup Calendar 68 * @see elm_calendar_selectable_set()
69 * @see elm_calendar_selected_time_set()
70 * @since 1.8
72 */ 71 */
73typedef _Elm_Calendar_Select_Mode Elm_Calendar_Select_Mode;
74
75typedef enum 72typedef enum
76{ 73{
77 ELM_CALENDAR_SELECTABLE_NONE = 0, 74 ELM_CALENDAR_SELECTABLE_NONE = 0,
78 ELM_CALENDAR_SELECTABLE_YEAR = (1 << 0), 75 ELM_CALENDAR_SELECTABLE_YEAR = (1 << 0),
79 ELM_CALENDAR_SELECTABLE_MONTH = (1 << 1), 76 ELM_CALENDAR_SELECTABLE_MONTH = (1 << 1),
80 ELM_CALENDAR_SELECTABLE_DAY = (1 << 2) 77 ELM_CALENDAR_SELECTABLE_DAY = (1 << 2)
81} _Elm_Calendar_Selectable; 78} Elm_Calendar_Selectable;
82
83/**
84 * @enum _Elm_Calendar_Selectable
85 * @typedef Elm_Calendar_Selectable
86 *
87 * A bitmask used to define which fields of a @b tm struct will be taken into
88 * account, when elm_calendar_selected_time_set() is invoked.
89 *
90 * @ingroup Calendar
91 * @see elm_calendar_selectable_set()
92 * @see elm_calendar_selected_time_set()
93 * @since 1.8
94 */
95typedef _Elm_Calendar_Selectable Elm_Calendar_Selectable;
96 79
97typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del(). */ 80typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del(). */
98 81
99/** 82/**
100 * @typedef Elm_Calendar_Format_Cb
101 *
102 * This callback type is used to format the string that will be used 83 * This callback type is used to format the string that will be used
103 * to display month and year. 84 * to display month and year.
104 * 85 *
@@ -106,8 +87,6 @@ typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a c
106 * @return String representing time that will be set to calendar's text. 87 * @return String representing time that will be set to calendar's text.
107 * 88 *
108 * @see elm_calendar_format_function_set() 89 * @see elm_calendar_format_function_set()
109 *
110 * @ingroup Calendar
111 */ 90 */
112typedef char * (*Elm_Calendar_Format_Cb)(struct tm *stime); 91typedef char * (*Elm_Calendar_Format_Cb)(struct tm *stime);
113 92
@@ -137,8 +116,6 @@ typedef char * (*Elm_Calendar_Format_Cb)(struct tm *stime);
137 * @see elm_calendar_weekdays_name_get() 116 * @see elm_calendar_weekdays_name_get()
138 * 117 *
139 * @ref calendar_example_02 118 * @ref calendar_example_02
140 *
141 * @ingroup Calendar
142 */ 119 */
143EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]); 120EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]);
144 121
@@ -153,8 +130,9 @@ EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, cons
153 * @see elm_calendar_mark_add() 130 * @see elm_calendar_mark_add()
154 * 131 *
155 * @ref calendar_example_06 132 * @ref calendar_example_06
156 *
157 * @ingroup Calendar
158 */ 133 */
159EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark); 134EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark);
160 135
136/**
137 * @}
138 */