From: Mike McCormack <mj.mccormack@samsung.com>
Date: Fri, 4 Nov 2011 04:26:14 +0000 (+0900)
Subject: [Elementary.h] Update documentation for photo widget
X-Git-Tag: REBUILDD-ARMEL-67367~81
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=915602dd66e4b1bdb30ac363192335e72b61bb69;p=framework%2Fuifw%2Felementary.git

[Elementary.h] Update documentation for photo widget
---

diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in
index ca48cd8..4d504d6 100644
--- a/src/lib/Elementary.h.in
+++ b/src/lib/Elementary.h.in
@@ -12292,16 +12292,77 @@ extern "C" {
     * @}
     */
 
-   /* photo */
+   /**
+    * @defgroup Photo Photo
+    *
+    * For displaying the photo of a person (contact). Simple, yet
+    * with a very specific purpose.
+    *
+    * Signals that you can add callbacks for are:
+    *
+    * "clicked" - This is called when a user has clicked the photo
+    * "drag,start" - Someone started dragging the image out of the object
+    * "drag,end" - Dragged item was dropped (somewhere)
+    *
+    * @{
+    */
+
+   /**
+    * Add a new photo to the parent
+    *
+    * @param parent The parent object
+    * @return The new object or NULL if it cannot be created
+    *
+    * @ingroup Photo
+    */
    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
+   /**
+    * Set the file that will be used as photo
+    *
+    * @param obj The photo object
+    * @param file The path to file that will be used as photo
+    *
+    * @return (1 = success, 0 = error)
+    *
+    * @ingroup Photo
+    */
    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
+
+   /**
+    * Set the size that will be used on the photo
+    *
+    * @param obj The photo object
+    * @param size The size that the photo will be
+    *
+    * @ingroup Photo
+    */
    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
+
+   /**
+    * Set if the photo should be completely visible or not.
+    *
+    * @param obj The photo object
+    * @param fill if true the photo will be completely visible
+    *
+    * @ingroup Photo
+    */
    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
+
+   /**
+    * Set editability of the photo.
+    *
+    * An editable photo can be dragged to or from, and can be cut or
+    * pasted too.  Note that pasting an image or dropping an item on
+    * the image will delete the existing content.
+    *
+    * @param obj The photo object.
+    * @param set To set of clear editablity.
+    */
    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
-   /* smart callbacks called:
-    * "clicked" - the user clicked the icon
-    * "drag,start" - Someone started dragging the image out of the object
-    * "drag,end" - Dragged item was dropped (somewhere)
+
+   /**
+    * @}
     */
 
    /* gesture layer */