summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYoungbok Shin <youngb.shin@samsung.com>2015-02-09 13:09:05 +0900
committerDaniel Juyung Seo <seojuyung2@gmail.com>2015-02-09 13:09:05 +0900
commitbfa5fdf7de3ead3306c68538e4bf3be983de7276 (patch)
treebc74867496acfd1db65a9619b0a9697d2ac4f4a2
parent99c430e596382ca83b52a0724cde84ba5d7b658d (diff)
widgets: Apply default return value according to description in .eo or add description too.
Summary: 1) According to description in .eo file, some APIs return not 0 when the given object is NULL or not proper object. But, several APIs are not implemented as those description. Now, they will return a value as description. 2) If there is no description about the return value when the API fail, put description according to pair API or old version of elementary. @fix Reviewers: woohyun, Hermet, seoz Differential Revision: https://phab.enlightenment.org/D1933
-rw-r--r--src/lib/elm_ctxpopup.eo3
-rw-r--r--src/lib/elm_entry.eo4
-rw-r--r--src/lib/elm_gengrid_item.eo2
-rw-r--r--src/lib/elm_icon.eo3
-rw-r--r--src/lib/elm_list.eo2
-rw-r--r--src/lib/elm_map.eo6
-rw-r--r--src/lib/elm_panel.eo2
-rw-r--r--src/lib/elm_toolbar.eo5
-rw-r--r--src/lib/elm_win.eo8
9 files changed, 20 insertions, 15 deletions
diff --git a/src/lib/elm_ctxpopup.eo b/src/lib/elm_ctxpopup.eo
index 8bcad0181..45ef2b2b6 100644
--- a/src/lib/elm_ctxpopup.eo
+++ b/src/lib/elm_ctxpopup.eo
@@ -117,11 +117,12 @@ class Elm_Ctxpopup (Elm_Layout, Elm_Interface_Atspi_Widget_Action)
117 @brief Get the current direction of a ctxpopup. 117 @brief Get the current direction of a ctxpopup.
118 118
119 @return current direction of a ctxpopup 119 @return current direction of a ctxpopup
120 (If getting the current direction is failed, it returns #ELM_CTXPOPUP_DIRECTION_UNKNOWN)
120 121
121 @warning Once the ctxpopup showed up, the direction would be determined 122 @warning Once the ctxpopup showed up, the direction would be determined
122 123
123 @ingroup Ctxpopup */ 124 @ingroup Ctxpopup */
124 return: Elm_Ctxpopup_Direction; 125 return: Elm_Ctxpopup_Direction(4);
125 } 126 }
126 } 127 }
127 items { 128 items {
diff --git a/src/lib/elm_entry.eo b/src/lib/elm_entry.eo
index 7d2f07a3f..1a444be45 100644
--- a/src/lib/elm_entry.eo
+++ b/src/lib/elm_entry.eo
@@ -1057,10 +1057,10 @@ class Elm_Entry (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
1057 tag for which no provider finds anything, and no text is displayed, this 1057 tag for which no provider finds anything, and no text is displayed, this
1058 function still returns EINA_FALSE. 1058 function still returns EINA_FALSE.
1059 1059
1060 @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise. 1060 @return @c EINA_TRUE if the entry text is empty or @p entry is NULL, @c EINA_FALSE otherwise.
1061 1061
1062 @ingroup Entry */ 1062 @ingroup Entry */
1063 return: bool; 1063 return: bool(true);
1064 } 1064 }
1065 markup_filter_remove { 1065 markup_filter_remove {
1066 /*@ 1066 /*@
diff --git a/src/lib/elm_gengrid_item.eo b/src/lib/elm_gengrid_item.eo
index 4eceead2c..85486965f 100644
--- a/src/lib/elm_gengrid_item.eo
+++ b/src/lib/elm_gengrid_item.eo
@@ -152,7 +152,7 @@ class Elm_Gengrid_Item(Elm_Widget_Item)
152 */ 152 */
153 } 153 }
154 values { 154 values {
155 Elm_Object_Select_Mode mode; /*@ The selected mode */ 155 Elm_Object_Select_Mode mode(4); /*@ The selected mode */
156 } 156 }
157 } 157 }
158 } 158 }
diff --git a/src/lib/elm_icon.eo b/src/lib/elm_icon.eo
index 7ba7c3f99..a613f29e0 100644
--- a/src/lib/elm_icon.eo
+++ b/src/lib/elm_icon.eo
@@ -17,6 +17,7 @@ class Elm_Icon (Elm_Image)
17 Get the icon lookup order. 17 Get the icon lookup order.
18 18
19 @return The icon lookup order 19 @return The icon lookup order
20 (If getting the icon order loopup is failed, it returns #ELM_ICON_LOOKUP_THEME_FDO)
20 21
21 @see elm_icon_order_lookup_set() 22 @see elm_icon_order_lookup_set()
22 @see Elm_Icon_Lookup_Order 23 @see Elm_Icon_Lookup_Order
@@ -24,7 +25,7 @@ class Elm_Icon (Elm_Image)
24 @ingroup Icon */ 25 @ingroup Icon */
25 } 26 }
26 values { 27 values {
27 Elm_Icon_Lookup_Order order; /*@ The icon lookup order (can be one of 28 Elm_Icon_Lookup_Order order(1); /*@ The icon lookup order (can be one of
28 #ELM_ICON_LOOKUP_FDO_THEME, #ELM_ICON_LOOKUP_THEME_FDO, #ELM_ICON_LOOKUP_FDO 29 #ELM_ICON_LOOKUP_FDO_THEME, #ELM_ICON_LOOKUP_THEME_FDO, #ELM_ICON_LOOKUP_FDO
29 or #ELM_ICON_LOOKUP_THEME) */ 30 or #ELM_ICON_LOOKUP_THEME) */
30 } 31 }
diff --git a/src/lib/elm_list.eo b/src/lib/elm_list.eo
index 401a250df..5c08e7d3f 100644
--- a/src/lib/elm_list.eo
+++ b/src/lib/elm_list.eo
@@ -67,7 +67,7 @@ class Elm_List (Elm_Layout, Elm_Interface_Scrollable,
67 @ingroup List */ 67 @ingroup List */
68 } 68 }
69 values { 69 values {
70 Elm_Object_Select_Mode mode; /*@ The select mode */ 70 Elm_Object_Select_Mode mode(4); /*@ The select mode */
71 } 71 }
72 } 72 }
73 focus_on_selection { 73 focus_on_selection {
diff --git a/src/lib/elm_map.eo b/src/lib/elm_map.eo
index 8d900632b..2af68ff80 100644
--- a/src/lib/elm_map.eo
+++ b/src/lib/elm_map.eo
@@ -123,13 +123,14 @@ class Elm_Map (Elm_Widget, Elm_Interface_Scrollable,
123 Get the minimum zoom of the source. 123 Get the minimum zoom of the source.
124 124
125 @return Returns the minimum zoom of the source. 125 @return Returns the minimum zoom of the source.
126 (If getting the minimum zoom fails, it returns -1)
126 127
127 @see elm_map_zoom_min_set() for details. 128 @see elm_map_zoom_min_set() for details.
128 129
129 @ingroup Map */ 130 @ingroup Map */
130 } 131 }
131 values { 132 values {
132 int zoom; /*@ New minimum zoom value to be used. */ 133 int zoom(-1); /*@ New minimum zoom value to be used. */
133 } 134 }
134 } 135 }
135 rotate { 136 rotate {
@@ -198,13 +199,14 @@ class Elm_Map (Elm_Widget, Elm_Interface_Scrollable,
198 Get the maximum zoom of the source. 199 Get the maximum zoom of the source.
199 200
200 @return Returns the maximum zoom of the source. 201 @return Returns the maximum zoom of the source.
202 (If getting the maximum zoom fails, it returns -1)
201 203
202 @see elm_map_zoom_max_set() for details. 204 @see elm_map_zoom_max_set() for details.
203 205
204 @ingroup Map */ 206 @ingroup Map */
205 } 207 }
206 values { 208 values {
207 int zoom; /*@ New maximum zoom value to be used. */ 209 int zoom(-1); /*@ New maximum zoom value to be used. */
208 } 210 }
209 } 211 }
210 zoom_mode { 212 zoom_mode {
diff --git a/src/lib/elm_panel.eo b/src/lib/elm_panel.eo
index 379e32cdb..2a315b1e2 100644
--- a/src/lib/elm_panel.eo
+++ b/src/lib/elm_panel.eo
@@ -21,7 +21,7 @@ class Elm_Panel (Elm_Layout, Elm_Interface_Scrollable,
21 @ingroup Panel */ 21 @ingroup Panel */
22 } 22 }
23 values { 23 values {
24 Elm_Panel_Orient orient; /*@ The panel orientation. Can be one of the following: 24 Elm_Panel_Orient orient(2); /*@ The panel orientation. Can be one of the following:
25 @li #ELM_PANEL_ORIENT_TOP 25 @li #ELM_PANEL_ORIENT_TOP
26 @li #ELM_PANEL_ORIENT_LEFT 26 @li #ELM_PANEL_ORIENT_LEFT
27 @li #ELM_PANEL_ORIENT_RIGHT */ 27 @li #ELM_PANEL_ORIENT_RIGHT */
diff --git a/src/lib/elm_toolbar.eo b/src/lib/elm_toolbar.eo
index 1b48c2a3f..fe09f2557 100644
--- a/src/lib/elm_toolbar.eo
+++ b/src/lib/elm_toolbar.eo
@@ -91,7 +91,7 @@ class Elm_Toolbar (Elm_Widget, Elm_Interface_Scrollable,
91 @ingroup Toolbar */ 91 @ingroup Toolbar */
92 } 92 }
93 values { 93 values {
94 Elm_Object_Select_Mode mode; /*@ The select mode */ 94 Elm_Object_Select_Mode mode(4); /*@ The select mode */
95 } 95 }
96 } 96 }
97 icon_size { 97 icon_size {
@@ -154,13 +154,14 @@ class Elm_Toolbar (Elm_Widget, Elm_Interface_Scrollable,
154 Get the icon lookup order. 154 Get the icon lookup order.
155 155
156 @return The icon lookup order. 156 @return The icon lookup order.
157 (If getting the icon order loopup fails, it returns #ELM_ICON_LOOKUP_THEME_FDO)
157 158
158 @see elm_toolbar_icon_order_lookup_set() for details. 159 @see elm_toolbar_icon_order_lookup_set() for details.
159 160
160 @ingroup Toolbar */ 161 @ingroup Toolbar */
161 } 162 }
162 values { 163 values {
163 Elm_Icon_Lookup_Order order; /*@ The icon lookup order. */ 164 Elm_Icon_Lookup_Order order(1); /*@ The icon lookup order. */
164 } 165 }
165 } 166 }
166 shrink_mode { 167 shrink_mode {
diff --git a/src/lib/elm_win.eo b/src/lib/elm_win.eo
index 71a564121..c6cfccf26 100644
--- a/src/lib/elm_win.eo
+++ b/src/lib/elm_win.eo
@@ -552,12 +552,12 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window,
552 /*@ 552 /*@
553 Get the minor priority of a quickpanel window 553 Get the minor priority of a quickpanel window
554 554
555 @return The minor priority of this quickpanel 555 @return The minor priority of this quickpanel. If the object is not window object, return -1.
556 556
557 @ingroup Win */ 557 @ingroup Win */
558 } 558 }
559 values { 559 values {
560 int priority; /*@ The minor priority for this quickpanel */ 560 int priority(-1); /*@ The minor priority for this quickpanel */
561 } 561 }
562 } 562 }
563 sticky { 563 sticky {
@@ -656,12 +656,12 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window,
656 /*@ 656 /*@
657 Get the major priority of a quickpanel window 657 Get the major priority of a quickpanel window
658 658
659 @return The major priority of this quickpanel 659 @return The major priority of this quickpanel. If the object is not window object, return -1.
660 660
661 @ingroup Win */ 661 @ingroup Win */
662 } 662 }
663 values { 663 values {
664 int priority; /*@ The major priority for this quickpanel */ 664 int priority(-1); /*@ The major priority for this quickpanel */
665 } 665 }
666 } 666 }
667 indicator_opacity { 667 indicator_opacity {