X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fvisuals%2Fimage-visual-properties.h;h=29b940974da7ad38e7b5648c732e366c1575ce7b;hp=6a8649c493907d5b728e2e62361e404613c46964;hb=ba1c6fea08ea39ca92356ae4b39a952919398e7e;hpb=6c3063e269a7f2d370c0ad45efde3eeb38dac3a1

diff --git a/dali-toolkit/public-api/visuals/image-visual-properties.h b/dali-toolkit/public-api/visuals/image-visual-properties.h
index 6a8649c..29b9409 100644
--- a/dali-toolkit/public-api/visuals/image-visual-properties.h
+++ b/dali-toolkit/public-api/visuals/image-visual-properties.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_IMAGE_VISUAL_PROPERTIES_H
 
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,10 +23,8 @@
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 /**
  * @addtogroup dali_toolkit_visuals
  * @{
@@ -38,14 +36,12 @@ namespace Toolkit
  */
 namespace ImageVisual
 {
-
 /**
  * @brief ImageVisual Property.
  * @SINCE_1_1.45
  */
 namespace Property
 {
-
 /**
  * @brief Enumeration for the instance of properties belonging to the ImageVisual.
  * @SINCE_1_1.45
@@ -184,19 +180,21 @@ enum
   /**
    * @brief Defines the batch size for pre-loading images in the AnimatedImageVisual
    * @details Name "batchSize", type Property::INTEGER, number of images to pre-load
-   * before starting to play. Default value: 1
+   * before starting to play. Default value: 2
    * @SINCE_1_2.60
    * @note Optional.
+   * @note Minimum supported value is 2.
    */
   BATCH_SIZE,
 
   /**
    * @brief Defines the cache size for loading images in the AnimatedImageVisual
    * @details Name "cacheSize", type Property::INTEGER, number of images to keep
-   * cached ahead during playback. Default value: 1
+   * cached ahead during playback. Default value: 2
    *
    * @SINCE_1_2.60
    * @note Optional.
+   * @note Minimum supported value is 2.
    * @note, cacheSize should be >= batchSize.
    * If it isn't, then the cache will automatically be changed to batchSize.
    * @note, because of the defaults, it is expected that the application developer
@@ -228,12 +226,12 @@ enum
    * @details Name "cropToMask", type Property::BOOLEAN, True if the image should
    * be cropped to match the mask size, or false if the image should remain the same size.
    * @SINCE_1_2.60
-   * @note Optional.
+   * @note Optional, Default true
    * @note If this is false, then the mask is scaled to fit the image before being applied.
    */
   CROP_TO_MASK,
 
-/**
+  /**
    * @brief The policy to determine when an image should be loaded.
    * @details Name "loadPolicy",  Type LoadPolicy::Type (Property::INTEGER)or Property::STRING.
    * @SINCE_1_3_5
@@ -250,7 +248,6 @@ enum
    * @note Default ReleasePolicy::DESTROYED
    * @see ReleasePolicy::Type
    */
-
   RELEASE_POLICY,
 
   /**
@@ -259,7 +256,6 @@ enum
    * @SINCE_1_3_5
    * @note Default true
    */
-
   ORIENTATION_CORRECTION,
 
 };
@@ -272,15 +268,14 @@ enum
  */
 namespace LoadPolicy
 {
-
 /**
  * @brief The available named elements that define the LoadPolicy.
  * @SINCE_1_3_5
  */
 enum Type
 {
-  IMMEDIATE = 0,  ///< The image is loaded when the ImageVisual is created.
-  ATTACHED        ///< The image is loaded when the ImageVisual is attached to the stage.
+  IMMEDIATE = 0, ///< The image is loaded when the ImageVisual is created.
+  ATTACHED       ///< The image is loaded when the ImageVisual is attached to the stage.
 };
 
 } // namespace LoadPolicy
@@ -292,19 +287,18 @@ enum Type
  */
 namespace ReleasePolicy
 {
-
 /**
  * @brief The available named elements that define the ReleasePolicy.
  * @SINCE_1_3_5
  */
 enum Type
 {
-  DETACHED = 0,  ///<  Image deleted from cache when ImageVisual detached from stage.
-  DESTROYED,     ///<  Image deleted from cache when ImageVisual destroyed.
-  NEVER          ///<  Image is never deleted, will survive the lifetime of the application.
+  DETACHED = 0, ///<  Image deleted from cache when ImageVisual detached from stage.
+  DESTROYED,    ///<  Image deleted from cache when ImageVisual destroyed.
+  NEVER         ///<  Image is never deleted, will survive the lifetime of the application.
 };
 
-} // namespace ReleasePolicy;
+} // namespace ReleasePolicy
 
 } // namespace ImageVisual