doc: add API docs in button, container, image, store, general.
authorAdrien Nader <adrien@notk.org>
Mon, 13 Oct 2014 13:59:28 +0000 (15:59 +0200)
committerCedric BAIL <cedric@osg.samsung.com>
Mon, 20 Oct 2014 16:42:21 +0000 (18:42 +0200)
This adds API docs for:

- elm_button_admits_autorepeat_get

- elm_container_content_swallow_list_get
-               content_get
-               content_set
-               content_unset

- elm_image_resize_down_set
-           resize_down_get
-           resize_up_set
-           resize_up_get
-           scale_set
-           scale_get
-           fill_inside_set
-           fill_inside_get
-           sizing_eval

Light documentation for enum Elm_Object_Select_Mode, enum
Elm_Object_Multi_Select_Mode and Elm_Store_Item_Mapping_Type.

src/lib/elm_button.eo
src/lib/elm_container.eo
src/lib/elm_general.h
src/lib/elm_image.eo
src/lib/elm_store.h

index d0651f4..5d3027f 100644 (file)
@@ -88,7 +88,7 @@ class Elm_Button (Elm_Layout, Evas.Clickable_Interface,
       }
       admits_autorepeat {
          get {
-            /*@ No description supplied by the EAPI. */
+            /*@ Get whether the button supports autorepeat. */
             legacy: null;
          }
          values {
index b306f7e..899068c 100644 (file)
@@ -6,7 +6,7 @@ class Elm_Container (Elm_Widget)
    properties {
       content_swallow_list {
          get {
-            /*@ No description supplied by the EAPI. */
+            /*@ Get the list of swallow parts in the object. */
          }
          values {
             list *ret; /*@ list */
@@ -15,22 +15,22 @@ class Elm_Container (Elm_Widget)
    }
    methods {
       content_set {
-         /*@ No description supplied by the EAPI. */
+         /*@ Swallow the given object into the given part of the container. */
          params {
-            @in const(char)* name;
-            @in Evas_Object *content;
+            @in const(char)* name; /*@ the part in which to swallow the object */
+            @in Evas_Object *content; /*@ the object to swallow */
          }
          return: bool;
       }
       content_get {
-         /*@ No description supplied by the EAPI. */
+         /*@ Get the object swallowed in the given part of the container. */
          params {
-            @in const(char)* name;
+            @in const(char)* name; /*@ the part in which the object is swallowed */
          }
          return: Evas_Object *;
       }
       content_unset {
-         /*@ No description supplied by the EAPI. */
+         /*@ Unswallow the object in the given part of the container and return it. */
          params {
             @in const(char)* name;
          }
index 88d9ff1..a800f24 100644 (file)
@@ -134,20 +134,28 @@ typedef enum
    ELM_POLICY_THROTTLE_NEVER /**< never throttle when windows are all hidden, regardless of config settings */
 } Elm_Policy_Throttle;
 
+/**
+ * Possible values for the #ELM_OBJECT_SELECT_MODE policy.
+ * @since 1.7
+ */
 typedef enum
 {
    ELM_OBJECT_SELECT_MODE_DEFAULT = 0, /**< default select mode. Once an item is selected, it would stay highlighted and not going to call selected callback again even it was clicked. Items can get focus. */
    ELM_OBJECT_SELECT_MODE_ALWAYS, /**< always select mode. Item selected callbacks will be called every time for click events, even after the item was already selected. Items can get focus. */
    ELM_OBJECT_SELECT_MODE_NONE, /**< no select mode. Items will never be highlighted and selected but the size will be adjusted by the finger size configuration. Items can't get focus. */
    ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY, /**< no select mode with no finger size rule. Items will never be highlighted and selected and ignore the finger size. So the item size can be reduced below than the finger size configuration. Items can't get focus. */
-   ELM_OBJECT_SELECT_MODE_MAX
+   ELM_OBJECT_SELECT_MODE_MAX /**< canary value: any value greater or equal to ELM_OBJECT_SELECT_MODE_MAX is forbidden. */
 } Elm_Object_Select_Mode;
 
+/**
+ * Possible values for the #ELM_OBJECT_MULTI_SELECT_MODE policy.
+ * @since 1.8
+ */
 typedef enum
 {
    ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT = 0, /**< default multiple select mode */
    ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL, /**< disallow mutiple selection when clicked without control key pressed */
-   ELM_OBJECT_MULTI_SELECT_MODE_MAX
+   ELM_OBJECT_MULTI_SELECT_MODE_MAX /**< canary value: any value greater or equal to ELM_OBJECT_MULTI_SELECT_MODE_MAX is forbidden. */
 } Elm_Object_Multi_Select_Mode;
 
 typedef Eina_Bool             (*Elm_Event_Cb)(void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
index 0f14c19..dc77b55 100644 (file)
@@ -30,15 +30,25 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
       }
       resize_down {
          set {
-            /*@ No description supplied by the EAPI. */
+            /*@
+              Set whether the object's image can be resized to a size smaller than the original one.
+
+              @ingroup Image
+              @since 1.7
+             */
             legacy: null;
          }
          get {
-            /*@ No description supplied by the EAPI. */
+            /*@
+              Get whether the object's image can be resized to a size smaller than the original one.
+
+              @ingroup Image
+              @since 1.7
+             */
             legacy: null;
          }
          values {
-            bool resize_down;
+            bool resize_down; /*@ whether resizing down is allowed */
          }
       }
       animated_play {
@@ -87,15 +97,25 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
       }
       resize_up {
          set {
-            /*@ No description supplied by the EAPI. */
+            /*@
+              Set whether the object's image can be resized to a size larget than the original one.
+
+              @ingroup Image
+              @since 1.7
+             */
             legacy: null;
          }
          get {
-            /*@ No description supplied by the EAPI. */
+            /*@
+              Get whether the object's image can be resized to a size larget than the original one.
+
+              @ingroup Image
+              @since 1.7
+             */
             legacy: null;
          }
          values {
-            bool resize_up;
+            bool resize_up; /*@ whether resizing up is allowed */
          }
       }
       smooth {
@@ -198,28 +218,62 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
       }
       scale {
          set {
-            /*@ No description supplied by the EAPI. */
+            /*@
+              Set the scale of the object's image.
+
+              @ingroup Image
+              @since 1.7
+             */
             legacy: null;
          }
          get {
-            /*@ No description supplied by the EAPI. */
+            /*@
+              Get the scale of the object's image.
+
+              @ingroup Image
+              @since 1.7
+             */
             legacy: null;
          }
          values {
-            double scale;
+            double scale; /*@ Object's image scale. */
          }
       }
       fill_inside {
          set {
-            /*@ No description supplied by the EAPI. */
+            /*@
+              Set the resize method for the object's internal image when maintaining a given aspect ratio.
+
+              If @p fill_inside is true, image does not overflow the widget and
+              blank spaces are added to fill the space that is still free. If it
+              is false, the image overflows the image will fill all space and
+              overflow in its larger dimension.
+
+              You can think of it as "fill: inside" or "fill: outside" and not as
+              "fill the inside".
+
+              @see elm_image_fill_inside_get()
+              @see elm_image_fill_outside_get()
+              @see elm_image_fill_outside_set()
+              @ingroup Image
+              @since 1.7
+             */
             legacy: null;
          }
          get {
-            /*@ No description supplied by the EAPI. */
+            /*@
+              Set the resize method for the object's internal image when maintaining a given aspect ratio.
+
+              @see elm_image_fill_inside_set()
+              @see elm_image_fill_outside_get()
+              @see elm_image_fill_outside_set()
+              @ingroup Image
+              @since 1.7
+             */
             legacy: null;
          }
          values {
-            bool fill_inside;
+            bool fill_inside; /*@ Resize method for the object's internal image. */
          }
       }
       aspect_fixed {
@@ -293,6 +347,8 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
             @note This option will have no effect if
             elm_image_aspect_fixed_set() is set to @c EINA_FALSE.
 
+            @see elm_image_fill_inside_get()
+            @see elm_image_fill_inside_set()
             @see elm_image_fill_outside_get()
             @see elm_image_aspect_fixed_set()
 
@@ -304,6 +360,8 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
 
             @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
 
+            @see elm_image_fill_inside_get()
+            @see elm_image_fill_inside_set()
             @see elm_image_fill_outside_set()
 
             @ingroup Image */
@@ -466,7 +524,11 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
    }
    methods {
       sizing_eval {
-         /*@ No description supplied by the EAPI. */
+         /*@
+           Re-evaluate the object's final geometry.
+
+           @ingroup Image
+           @since 1.7 */
          legacy: null;
       }
    }
index 3db9ece..2705328 100644 (file)
@@ -70,6 +70,10 @@ typedef void                                 (*Elm_Store_Item_Fetch_Cb)(void *da
 typedef void                                 (*Elm_Store_Item_Unfetch_Cb)(void *data, Elm_Store_Item *sti); /**< Function to cal lto un-fetch (free) an item */
 typedef void                                *(*Elm_Store_Item_Mapping_Cb)(void *data, Elm_Store_Item *sti, const char *part); /**< Custom mapping function to call */
 
+/**
+ * Possible mappings types.
+ * @since 1.7
+ */
 typedef enum
 {
    ELM_STORE_ITEM_MAPPING_NONE = 0,
@@ -78,7 +82,7 @@ typedef enum
    ELM_STORE_ITEM_MAPPING_ICON, /**< char * -> icon path */
    ELM_STORE_ITEM_MAPPING_PHOTO, /**< char * -> photo path */
    ELM_STORE_ITEM_MAPPING_CUSTOM, /**< item->custom(it->data, it, part) -> void * (-> any) */
-   ELM_STORE_ITEM_MAPPING_LAST
+   ELM_STORE_ITEM_MAPPING_LAST, /** canary value: any value greater or equal to ELM_STORE_ITEM_MAPPING_LAST is forbidden. */
 } Elm_Store_Item_Mapping_Type;
 
 struct _Elm_Store_Item_Mapping_Icon