[3.0] (ImageView) Downgrade warning level of Image param APIs to only show with a...

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / image-view / image-view.h

diff --git a/dali-toolkit/public-api/controls/image-view/image-view.h b/dali-toolkit/public-api/controls/image-view/image-view.h
index 14e3427..b9b7443 100644 (file)
--- a/dali-toolkit/public-api/controls/image-view/image-view.h
+++ b/dali-toolkit/public-api/controls/image-view/image-view.h
@@ -2,7 +2,7 @@
 #define __DALI_TOOLKIT_IMAGE_VIEW_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 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.
@@ -70,6 +70,10 @@ public:
    */
   struct Property
   {
+    /**
+     * @brief An enumeration of properties belonging to the ImageView class.
+     * @SINCE_1_0.0
+     */
     enum
     {
       // Event side properties
@@ -94,12 +98,13 @@ public:
        */
       PRE_MULTIPLIED_ALPHA,
 
+
       // Animatable properties
 
       /**
        * @brief name "pixelArea", type Vector4
        * @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
-       * @SINCE_1_0.18
+       * @SINCE_1_1.18
        */
       PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX,
     };
@@ -140,6 +145,8 @@ public:
    * If the string is empty, ImageView will not display anything.
    *
    * @SINCE_1_0.0
+   * @REMARK_INTERNET
+   * @REMARK_STORAGE
    * @param[in] url The url of the image resource to display.
    * @return A handle to a newly allocated ImageView.
    */
@@ -151,6 +158,8 @@ public:
    * If the string is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.10
+   * @REMARK_INTERNET
+   * @REMARK_STORAGE
    * @param[in] url The url of the image resource to display.
    * @param [in] size The width and height to which to fit the loaded image.
    * @return A handle to a newly allocated ImageView.
@@ -213,6 +222,8 @@ public:
    * If the URL is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.4
+   * @REMARK_INTERNET
+   * @REMARK_STORAGE
    * @param[in] url The URL to the image resource to display.
    */
   void SetImage( const std::string& url );
@@ -223,13 +234,14 @@ public:
    * If the URL is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.10
+   * @REMARK_INTERNET
+   * @REMARK_STORAGE
    * @param[in] url The URL to the image resource to display.
    * @param [in] size The width and height to fit the loaded image to.
    */
   void SetImage( const std::string& url, ImageDimensions size );
 
   /**
-   * @DEPRECATED_1_1.4
    * @brief Gets the Image instance handle used by the ImageView.
    *
    * A valid handle will be returned only if this instance was created with New(Image) or SetImage(Image) was called.
@@ -242,6 +254,7 @@ public:
 public: // Not intended for application developers
 
   /**
+   * @internal
    * @brief Creates a handle using the Toolkit::Internal implementation.
    *
    * @SINCE_1_0.0
@@ -250,6 +263,7 @@ public: // Not intended for application developers
   DALI_INTERNAL ImageView( Internal::ImageView& implementation );
 
   /**
+   * @internal
    * @brief Allows the creation of this ImageView from an Internal::CustomActor pointer.
    *
    * @SINCE_1_0.0