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
This commit is contained in:
Youngbok Shin 2015-02-09 13:09:05 +09:00 committed by Daniel Juyung Seo
parent 2d7cb99e9b
commit b48ab5e101
9 changed files with 20 additions and 15 deletions

View File

@ -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 {

View File

@ -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 {
/*@

View File

@ -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 */
}
}
}

View File

@ -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) */
}

View File

@ -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 {

View File

@ -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 {

View File

@ -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 */

View File

@ -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 {

View File

@ -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 {