seoz pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=bfa5fdf7de3ead3306c68538e4bf3be983de7276
commit bfa5fdf7de3ead3306c68538e4bf3be983de7276 Author: Youngbok Shin <[email protected]> Date: Mon Feb 9 13:09:05 2015 +0900 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 --- src/lib/elm_ctxpopup.eo | 3 ++- src/lib/elm_entry.eo | 4 ++-- src/lib/elm_gengrid_item.eo | 2 +- src/lib/elm_icon.eo | 3 ++- src/lib/elm_list.eo | 2 +- src/lib/elm_map.eo | 6 ++++-- src/lib/elm_panel.eo | 2 +- src/lib/elm_toolbar.eo | 5 +++-- src/lib/elm_win.eo | 8 ++++---- 9 files changed, 20 insertions(+), 15 deletions(-) diff --git a/src/lib/elm_ctxpopup.eo b/src/lib/elm_ctxpopup.eo index 8bcad01..45ef2b2 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) @brief Get the current direction of a ctxpopup. @return current direction of a ctxpopup + (If getting the current direction is failed, it returns #ELM_CTXPOPUP_DIRECTION_UNKNOWN) @warning Once the ctxpopup showed up, the direction would be determined @ingroup Ctxpopup */ - return: Elm_Ctxpopup_Direction; + return: Elm_Ctxpopup_Direction(4); } } items { diff --git a/src/lib/elm_entry.eo b/src/lib/elm_entry.eo index 7d2f07a..1a444be 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, tag for which no provider finds anything, and no text is displayed, this function still returns EINA_FALSE. - @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise. + @return @c EINA_TRUE if the entry text is empty or @p entry is NULL, @c EINA_FALSE otherwise. @ingroup Entry */ - return: bool; + return: bool(true); } markup_filter_remove { /*@ diff --git a/src/lib/elm_gengrid_item.eo b/src/lib/elm_gengrid_item.eo index 4eceead..8548696 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) */ } values { - Elm_Object_Select_Mode mode; /*@ The selected mode */ + Elm_Object_Select_Mode mode(4); /*@ The selected mode */ } } } diff --git a/src/lib/elm_icon.eo b/src/lib/elm_icon.eo index 7ba7c3f..a613f29 100644 --- a/src/lib/elm_icon.eo +++ b/src/lib/elm_icon.eo @@ -17,6 +17,7 @@ class Elm_Icon (Elm_Image) Get the icon lookup order. @return The icon lookup order + (If getting the icon order loopup is failed, it returns #ELM_ICON_LOOKUP_THEME_FDO) @see elm_icon_order_lookup_set() @see Elm_Icon_Lookup_Order @@ -24,7 +25,7 @@ class Elm_Icon (Elm_Image) @ingroup Icon */ } values { - Elm_Icon_Lookup_Order order; /*@ The icon lookup order (can be one of + Elm_Icon_Lookup_Order order(1); /*@ The icon lookup order (can be one of #ELM_ICON_LOOKUP_FDO_THEME, #ELM_ICON_LOOKUP_THEME_FDO, #ELM_ICON_LOOKUP_FDO or #ELM_ICON_LOOKUP_THEME) */ } diff --git a/src/lib/elm_list.eo b/src/lib/elm_list.eo index 401a250..5c08e7d 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, @ingroup List */ } values { - Elm_Object_Select_Mode mode; /*@ The select mode */ + Elm_Object_Select_Mode mode(4); /*@ The select mode */ } } focus_on_selection { diff --git a/src/lib/elm_map.eo b/src/lib/elm_map.eo index 8d90063..2af68ff 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, Get the minimum zoom of the source. @return Returns the minimum zoom of the source. + (If getting the minimum zoom fails, it returns -1) @see elm_map_zoom_min_set() for details. @ingroup Map */ } values { - int zoom; /*@ New minimum zoom value to be used. */ + int zoom(-1); /*@ New minimum zoom value to be used. */ } } rotate { @@ -198,13 +199,14 @@ class Elm_Map (Elm_Widget, Elm_Interface_Scrollable, Get the maximum zoom of the source. @return Returns the maximum zoom of the source. + (If getting the maximum zoom fails, it returns -1) @see elm_map_zoom_max_set() for details. @ingroup Map */ } values { - int zoom; /*@ New maximum zoom value to be used. */ + int zoom(-1); /*@ New maximum zoom value to be used. */ } } zoom_mode { diff --git a/src/lib/elm_panel.eo b/src/lib/elm_panel.eo index 379e32c..2a315b1 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, @ingroup Panel */ } values { - Elm_Panel_Orient orient; /*@ The panel orientation. Can be one of the following: + Elm_Panel_Orient orient(2); /*@ The panel orientation. Can be one of the following: @li #ELM_PANEL_ORIENT_TOP @li #ELM_PANEL_ORIENT_LEFT @li #ELM_PANEL_ORIENT_RIGHT */ diff --git a/src/lib/elm_toolbar.eo b/src/lib/elm_toolbar.eo index 1b48c2a..fe09f25 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, @ingroup Toolbar */ } values { - Elm_Object_Select_Mode mode; /*@ The select mode */ + Elm_Object_Select_Mode mode(4); /*@ The select mode */ } } icon_size { @@ -154,13 +154,14 @@ class Elm_Toolbar (Elm_Widget, Elm_Interface_Scrollable, Get the icon lookup order. @return The icon lookup order. + (If getting the icon order loopup fails, it returns #ELM_ICON_LOOKUP_THEME_FDO) @see elm_toolbar_icon_order_lookup_set() for details. @ingroup Toolbar */ } values { - Elm_Icon_Lookup_Order order; /*@ The icon lookup order. */ + Elm_Icon_Lookup_Order order(1); /*@ The icon lookup order. */ } } shrink_mode { diff --git a/src/lib/elm_win.eo b/src/lib/elm_win.eo index 71a5641..c6cfccf 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, /*@ Get the minor priority of a quickpanel window - @return The minor priority of this quickpanel + @return The minor priority of this quickpanel. If the object is not window object, return -1. @ingroup Win */ } values { - int priority; /*@ The minor priority for this quickpanel */ + int priority(-1); /*@ The minor priority for this quickpanel */ } } sticky { @@ -656,12 +656,12 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window, /*@ Get the major priority of a quickpanel window - @return The major priority of this quickpanel + @return The major priority of this quickpanel. If the object is not window object, return -1. @ingroup Win */ } values { - int priority; /*@ The major priority for this quickpanel */ + int priority(-1); /*@ The major priority for this quickpanel */ } } indicator_opacity { --
