From: WooHyun Jung <woohyun0705@gmail.com>
Date: Wed, 15 Feb 2012 12:33:17 +0000 (+0000)
Subject: elm_image : reviewed API + documentation
X-Git-Tag: v1.0.0~987
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5c1268e222ab321cbfcea98de5d223af5ebdccbd;p=platform%2Fupstream%2Felementary.git

elm_image : reviewed API + documentation


SVN revision: 67983
---

diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in
index bb9b0e0..b751792 100644
--- a/src/lib/Elementary.h.in
+++ b/src/lib/Elementary.h.in
@@ -209,7 +209,7 @@ EAPI extern Elm_Version *elm_version;
 
 // Woohyun Jung
 #include <elm_hover.h> // OK
-#include <elm_image.h>
+#include <elm_image.h> // OK
 #include <elm_index.h>
 #include <elm_label.h>
 #include <elm_layout.h>
diff --git a/src/lib/elm_image.h b/src/lib/elm_image.h
index 40fc348..537c7fe 100644
--- a/src/lib/elm_image.h
+++ b/src/lib/elm_image.h
@@ -134,8 +134,6 @@ EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj);
  *
  * This is the real size of the image, not the size of the object.
  *
- * On error, neither w and h will be filled with 0.
- *
  * @ingroup Image
  */
 EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h);
@@ -189,6 +187,7 @@ EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj);
  *
  * @ingroup Image
  */
+//XXX: elm_image_scale_up_set + elm_image_scale_down_set may be better. how do you think ? 
 EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down);
 
 /**
@@ -202,6 +201,7 @@ EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up,
  *
  * @ingroup Image
  */
+//XXX: elm_image_scale_up_get + elm_image_scale_down_get may be better. how do you think ? 
 EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down);
 
 /**
@@ -318,7 +318,7 @@ EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj);
 EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set);
 
 /**
- * Check if the image 'editable'.
+ * Check if the image is 'editable'.
  *
  * @param obj Image object.
  * @return Editability.
@@ -331,7 +331,7 @@ EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set);
 EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj);
 
 /**
- * Get the basic Evas_Image object from this object (widget).
+ * Get the inlined image object of the image widget.
  *
  * @param obj The image object to get the inlined image from
  * @return The inlined image object, or NULL if none exists