[imageslider] move docs to header
authorMike McCormack <mj.mccormack@samsung.com>
Fri, 25 Nov 2011 09:08:14 +0000 (18:08 +0900)
committerMike McCormack <mj.mccormack@samsung.com>
Fri, 25 Nov 2011 09:40:58 +0000 (18:40 +0900)
src/lib/Elementary.h.in
src/lib/elm_imageslider.c

index f6535ee..5f72e0e 100644 (file)
@@ -29944,24 +29944,131 @@ extern "C" {
    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
 
-   /* Image Slider */
+   /**
+    * @defgroup Imageslider Imageslider
+    * @ingroup Elementary
+    * @addtogroup Imageslider
+    * @{
+    *
+    * By flicking images on the screen,
+    * you can see the images in specific path.
+    */
    typedef struct _Imageslider_Item Elm_Imageslider_Item;
    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
+
+   /**
+    * Add an Image Slider widget
+    *
+    * @param        parent  The parent object
+    * @return       The new Image slider object or NULL if it cannot be created
+    */
    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+   /**
+    * Append an Image Slider item
+    *
+    * @param        obj          The Image Slider object
+    * @param        photo_file   photo file path
+    * @param        func         callback function
+    * @param        data         callback data
+    * @return       The Image Slider item handle or NULL
+    */
    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
+   /**
+    * Insert an Image Slider item into the Image Slider Widget by using the given index.
+    *
+    * @param        obj                     The Image Slider object
+    * @param        photo_file      photo file path
+    * @param        func            callback function
+    * @param        index           required position
+    * @param        data            callback data
+    * @return       The Image Slider item handle or NULL
+    */
    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
+   /**
+    * Prepend Image Slider item
+    *
+    * @param        obj          The Image Slider object
+    * @param        photo_file   photo file path
+    * @param        func         callback function
+    * @param        data         callback data
+    * @return       The imageslider item handle or NULL
+    */
    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
+   /**
+    * Delete the selected Image Slider item
+    *
+    * @param it             The selected Image Slider item handle
+    */
    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
+   /**
+    * Get the selected Image Slider item
+    *
+    * @param obj            The Image Slider object
+    * @return The selected Image Slider item or NULL
+    */
    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+   /**
+    * Get whether an Image Slider item is selected or not
+    *
+    * @param it              the selected Image Slider item
+    * @return EINA_TRUE or EINA_FALSE
+    */
    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
+   /**
+    * Set the selected Image Slider item
+    *
+    * @param it             The Imaga Slider item
+    */
    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
+   /**
+    * Get the photo file path of given Image Slider item
+    *
+    * @param it             The Image Slider item
+    * @return The photo file path or NULL;
+    */
    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
+   /**
+    * Sets the photo file path of given Image Slider item
+    *
+    * @param it         The Image Slider item
+    * @param photo_file The photo file path or NULL;
+    */
    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
+   /**
+    * Get the previous Image Slider item
+    *
+    * @param it             The Image Slider item
+    * @return The previous Image Slider item or NULL
+    */
    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
+   /**
+    * Get the next Image Slider item
+    *
+    * @param it             The Image Slider item
+    * @return The next Image Slider item or NULL
+    */
    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
+   /**
+    * Move to the previous Image Slider item
+    *
+    * @param obj    The Image Slider object
+    */
    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
+   /**
+    * Move to the next Image Slider item
+    *
+    * @param obj The Image Slider object
+    */
    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
+   /**
+    * Updates an Image Slider item
+    *
+    * @param it The Image Slider item
+    */
    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
+   /**
+    * @}
+    */
 #ifdef __cplusplus
 }
 #endif
index 43a5120..3f22bc2 100644 (file)
@@ -1,20 +1,8 @@
-/*
-*
-* vim:ts=8:sw=3:sts=8:noexpandtab:cino=>5n-3f0^-2{2
-*/
 #include <stdio.h>
 #include <math.h>
 #include <Elementary.h>
 #include "elm_priv.h"
 
-/**
-* @defgroup Imageslider Imageslider
-* @ingroup Elementary
-*
-* By flicking images on the screen,
-* you can see the images in specific path.
-*/
-
 typedef struct _Widget_Data Widget_Data;
 
 #define ANI_STEP (14 * elm_scale_get())
@@ -140,7 +128,6 @@ _del_hook(Evas_Object *obj)
      }
 
    if (wd) free(wd);
-
 }
 
 // Whenever require processing theme, Call this function
@@ -178,7 +165,6 @@ _sizing_eval(Evas_Object *obj)
 
    _imageslider_move(obj, e, obj, NULL);
    _imageslider_resize(obj, e, obj, NULL);
-
 }
 
 // Whenever MOVE event occurs, Call this function.
@@ -201,7 +187,6 @@ _imageslider_move(void *data, Evas * e __UNUSED__, Evas_Object *obj, void *event
    wd->y = y;
 
    _imageslider_update_pos(wd, wd->x, wd->y, wd->w);
-
 }
 
 // Whenever RESIZE event occurs, Call this fucntion.
@@ -653,14 +638,6 @@ _imageslider_update(Widget_Data * wd)
    _anim(wd);
 }
 
-/**
-* Add an Image Slider widget
-*
-* @param        parent  The parent object
-* @return       The new Image slider object or NULL if it cannot be created
-*
-* @ingroup Imageslider
-*/
 EAPI Evas_Object *
 elm_imageslider_add(Evas_Object *parent)
 {
@@ -707,17 +684,6 @@ elm_imageslider_add(Evas_Object *parent)
    return obj;
 }
 
-/**
-* Append an Image Slider item
-*
-* @param        obj          The Image Slider object
-* @param        photo_file   photo file path
-* @param        func         callback function
-* @param        data         callback data
-* @return       The Image Slider item handle or NULL
-*
-* @ingroup Imageslider
-*/
 EAPI Elm_Imageslider_Item *
 elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data)
 {
@@ -744,18 +710,6 @@ elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Images
    return it;
 }
 
-/**
-* Insert an Image Slider item into the Image Slider Widget by using the given index.
-*
-* @param        obj                     The Image Slider object
-* @param        photo_file      photo file path
-* @param        func            callback function
-* @param        index           required position
-* @param        data            callback data
-* @return       The Image Slider item handle or NULL
-*
-* @ingroup      Imageslider
-*/
 EAPI Elm_Imageslider_Item *
 elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data)
 {
@@ -787,17 +741,6 @@ elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, E
    return it;
 }
 
-/**
-* Prepend Image Slider item
-*
-* @param        obj          The Image Slider object
-* @param        photo_file   photo file path
-* @param        func         callback function
-* @param        data         callback data
-* @return       The imageslider item handle or NULL
-*
-* @ingroup Imageslider
-*/
 EAPI Elm_Imageslider_Item *
 elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data)
 {
@@ -821,13 +764,6 @@ elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Image
    return it;
 }
 
-/**
-* Delete the selected Image Slider item
-*
-* @param it             The selected Image Slider item handle
-*
-* @ingroup Imageslider
-*/
 EAPI void
 elm_imageslider_item_del(Elm_Imageslider_Item * it)
 {
@@ -855,14 +791,6 @@ elm_imageslider_item_del(Elm_Imageslider_Item * it)
    _imageslider_update(wd);
 }
 
-/**
-* Get the selected Image Slider item
-*
-* @param obj            The Image Slider object
-* @return The selected Image Slider item or NULL
-*
-* @ingroup Imageslider
-*/
 EAPI Elm_Imageslider_Item *
 elm_imageslider_selected_item_get(Evas_Object *obj)
 {
@@ -878,14 +806,6 @@ elm_imageslider_selected_item_get(Evas_Object *obj)
    return eina_list_data_get(wd->cur);
 }
 
-/**
-* Get whether an Image Slider item is selected or not
-*
-* @param it              the selected Image Slider item
-* @return EINA_TRUE or EINA_FALSE
-*
-* @ingroup Imageslider
-*/
 EAPI Eina_Bool
 elm_imageslider_item_selected_get(Elm_Imageslider_Item * it)
 {
@@ -903,13 +823,6 @@ elm_imageslider_item_selected_get(Elm_Imageslider_Item * it)
       return EINA_FALSE;
 }
 
-/**
-* Set the selected Image Slider item
-*
-* @param it             The Imaga Slider item
-*
-* @ingroup Imageslider
-*/
 EAPI void
 elm_imageslider_item_selected_set(Elm_Imageslider_Item * it)
 {
@@ -941,14 +854,6 @@ elm_imageslider_item_selected_set(Elm_Imageslider_Item * it)
    _imageslider_update(wd);
 }
 
-/**
-* Get the photo file path of given Image Slider item
-*
-* @param it             The Image Slider item
-* @return The photo file path or NULL;
-*
-* @ingroup Imageslider
-*/
 EAPI const char *
 elm_imageslider_item_photo_file_get(Elm_Imageslider_Item * it)
 {
@@ -957,14 +862,6 @@ elm_imageslider_item_photo_file_get(Elm_Imageslider_Item * it)
    return it->photo_file;
 }
 
-/**
-* Sets the photo file path of given Image Slider item
-*
-* @param it         The Image Slider item
-* @param photo_file The photo file path or NULL;
-*
-* @ingroup Imageslider
-*/
 EAPI void
 elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file)
 {
@@ -978,14 +875,6 @@ elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_
      }
 }
 
-/**
-* Get the previous Image Slider item
-*
-* @param it             The Image Slider item
-* @return The previous Image Slider item or NULL
-*
-* @ingroup Imageslider
-*/
 EAPI Elm_Imageslider_Item *
 elm_imageslider_item_prev(Elm_Imageslider_Item * it)
 {
@@ -1011,14 +900,6 @@ elm_imageslider_item_prev(Elm_Imageslider_Item * it)
    return NULL;
 }
 
-/**
-* Get the next Image Slider item
-*
-* @param it             The Image Slider item
-* @return The next Image Slider item or NULL
-*
-* @ingroup Imageslider
-*/
 EAPI Elm_Imageslider_Item *
 elm_imageslider_item_next(Elm_Imageslider_Item * it)
 {
@@ -1044,13 +925,6 @@ elm_imageslider_item_next(Elm_Imageslider_Item * it)
    return NULL;
 }
 
-/**
-* Move to the previous Image Slider item
-*
-* @param obj    The Image Slider object
-*
-* @ingroup Imageslider
-*/
 EAPI void
 elm_imageslider_prev(Evas_Object *obj)
 {
@@ -1064,13 +938,6 @@ elm_imageslider_prev(Evas_Object *obj)
    _imageslider_obj_move(wd, -1);
 }
 
-/**
-* Move to the next Image Slider item
-*
-* @param obj The Image Slider object
-*
-* @ingroup Imageslider
-*/
 EAPI void
 elm_imageslider_next(Evas_Object * obj)
 {
@@ -1084,13 +951,6 @@ elm_imageslider_next(Evas_Object * obj)
    _imageslider_obj_move(wd, 1);
 }
 
-/**
-* Updates an Image Slider item
-*
-* @param it The Image Slider item
-*
-* @ingroup Imageslider
-*/
 EAPI void
 elm_imageslider_item_update(Elm_Imageslider_Item *it)
 {