widgets: Apply default return value according to description in .eo or add descriptio...
authorYoungbok Shin <youngb.shin@samsung.com>
Mon, 9 Feb 2015 04:09:05 +0000 (13:09 +0900)
committerDaniel Juyung Seo <seojuyung2@gmail.com>
Mon, 9 Feb 2015 04:09:05 +0000 (13:09 +0900)
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
src/lib/elm_entry.eo
src/lib/elm_gengrid_item.eo
src/lib/elm_icon.eo
src/lib/elm_list.eo
src/lib/elm_map.eo
src/lib/elm_panel.eo
src/lib/elm_toolbar.eo
src/lib/elm_win.eo

index 8bcad0181236fa82be63e726d6305ec85ea2cf9c..45ef2b2b670ac421222d42348aa362ba420b0844 100644 (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 {
index 7d2f07a3fb1e3a66af7d6bac828c47e308d0fed9..1a444be45381dfea7ffc4da5af696efaec6f4fcc 100644 (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 {
          /*@
index 4eceead2c3359af83a1f07787694ad2e5a53fe34..85486965f88f30432ff215f5407d278044eca287 100644 (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 */
                 }
            }
       }
index 7ba7c3f9901e2b37a8c39be17b657e77f11c6600..a613f29e0ee69cafcf548777cb5fec65b526c409 100644 (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) */
          }
index 401a250dfa1a46507409e4124085b28d0ded390a..5c08e7d3f1be483dee81a34c4ca8e95ea98e5264 100644 (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 {
index 8d900632bf0be4cd11ef1307ff1e64ca1c62453d..2af68ff80cf4ebaf333a38991737d9e622c0bf9a 100644 (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 {
index 379e32cdb51d23a74f8de72e2b64bbc78544507a..2a315b1e2323d332dd157c22b4a15c86c5da563e 100644 (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 */
index 1b48c2a3f422ae263943029dedc54ea0a83db3c4..fe09f2557f63e732bc72788b6e76b5c4fc098697 100644 (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 {
index 71a5641216a4227c38165e65e4623a541ee1175f..c6cfccf26b1bd0796edeb094a2a8cd7f9dfe8157 100644 (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 {