Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / images / image.h

diff --git a/dali/public-api/images/image.h b/dali/public-api/images/image.h
index dc87c69..bdd869c 100644 (file)
--- a/dali/public-api/images/image.h
+++ b/dali/public-api/images/image.h
@@ -42,24 +42,12 @@ class Image;
  *
  * Image objects can be shared between ImageViews. This is practical if you have a visual element on screen
  * which is repeatedly used. An example would be a button background image.
- * The image resource is discarded when all ImageViews using the Image object are discarded or in case they
- * were created with ReleasePolicy::Unused, taken off stage.
- * Note: if a resource was shared between Image objects it exists until its last reference is gone.
+ * The image resource is discarded when all ImageViews using the Image object are discarded.
+ * @since_tizen 2.4
+ * @note if a resource was shared between Image objects it exists until its last reference is gone.
  *
  * Image objects are responsible for the underlying resource's lifetime.
  *
- * <i>ReleasePolicies</i>
- * - Unused: release resource once ImageView using it is taken off stage.
- * - Never: keep resource alive until Image object is thrown away.
- *
- * <i>Resolution of conflicting policies</i>
- * If the same image is created more than once with conflicting policies, ReleasePolicy "Never" overrides "Unused".
- *
- * Signals
- * | %Signal Name           | Method                       |
- * |------------------------|------------------------------|
- * | uploaded               | @ref UploadedSignal()        |
- * @since_tizen 2.4
  */
 class DALI_IMPORT_API Image : public BaseHandle
 {
@@ -71,11 +59,13 @@ public:
   /**
    * @brief ReleasePolicy controls the way images are deleted from memory.
    * @since_tizen 2.4
+   * @remarks This is an experimental feature and might not be supported in the next release.
+   * We do recommend not to use it.
    */
   enum ReleasePolicy
   {
-    UNUSED, ///< release resource once image is not in use anymore (eg. all actors using it become offstage). Reload when resource is required again.
-    NEVER   ///< keep image data for the lifetime of the object. (default)
+    UNUSED, ///< release resource once image is not in use anymore (eg. all actors using it become offstage). Reload when resource is required again. @since_tizen 2.4
+    NEVER   ///< keep image data for the lifetime of the object. (default) @since_tizen 2.4
   };
 
   /**
@@ -89,7 +79,7 @@ public:
   /**
    * @brief Constructor which creates an empty Image handle.
    *
-   * Use Image::New(...) to create an initialised handle.
+   * Use @ref Image::New to create an initialised handle.
    * @since_tizen 2.4
    */
   Image();
@@ -120,13 +110,13 @@ public:
   Image& operator=(const Image& rhs);
 
   /**
-   * @brief Downcast an Object handle to Image handle.
+   * @brief Downcast a handle to Image handle.
    *
    * If handle points to a Image object the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
    * @since_tizen 2.4
-   * @param[in] handle to An object
-   * @return handle to a Image object or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a Image object or an uninitialized handle
    */
   static Image DownCast( BaseHandle handle );
 
@@ -134,7 +124,9 @@ public:
    * @brief Return resource release policy.
    *
    * @since_tizen 2.4
-   * @return resource release policy
+   * @remarks This is an experimental feature and might not be supported in the next release.
+   * We do recommend not to use it.
+   * @return Resource release policy
    */
   ReleasePolicy GetReleasePolicy() const;
 
@@ -144,7 +136,7 @@ public:
    * Returns either the requested width or the actual loaded width if no specific size was requested.
    *
    * @since_tizen 2.4
-   * @return width of the image in pixels.
+   * @return Width of the image in pixels.
    */
   unsigned int GetWidth() const;
 
@@ -154,7 +146,7 @@ public:
    * Returns either the requested height or the actual loaded height if no specific size was requested.
    *
    * @since_tizen 2.4
-   * @return height of the image in pixels.
+   * @return Height of the image in pixels.
    */
   unsigned int GetHeight() const;