Apply the new doxygen tagging rule for @DEPRECATED

[platform/core/uifw/dali-core.git] / dali / public-api / images / resource-image.h

diff --git a/dali/public-api/images/resource-image.h b/dali/public-api/images/resource-image.h
index 616f89d..9c44af1 100644 (file)
--- a/dali/public-api/images/resource-image.h
+++ b/dali/public-api/images/resource-image.h
@@ -69,24 +69,27 @@ class ResourceImage;
  * | %Signal Name         | Method                       |
  * |----------------------|------------------------------|
  * | imageLoadingFinished | @ref LoadingFinishedSignal() |
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API ResourceImage : public Image
 {
 public:
 
   /**
-   * @deprecated DALi 1.1.3 Image loading starts immediately in the frame when then ResourceImage object is created
+   * @DEPRECATED_1_1.3. Image loading starts immediately in the frame when then ResourceImage object is created.
    *
    * @brief LoadPolicy controls the way images are loaded into memory.
+   * @SINCE_1_0.0
    */
   enum LoadPolicy
   {
-    IMMEDIATE, ///< load image once it is created (default)
-    ON_DEMAND  ///< delay loading until the image is being used (a related actor is added to Stage)
+    IMMEDIATE, ///< load image once it is created (default) @SINCE_1_0.0
+    ON_DEMAND  ///< delay loading until the image is being used (a related actor is added to Stage) @SINCE_1_0.0
   };
 
   /**
    * @brief Type of signal for LoadingFinished and Uploaded.
+   * @SINCE_1_0.0
    */
   typedef Signal< void (ResourceImage) > ResourceImageSignal;
 
@@ -99,6 +102,7 @@ public:
    * synchronous, so it should not be used repeatedly or in tight
    * loops.
    *
+   * @SINCE_1_0.0
    * @param [in] url The URL of the image file.
    * @return The width and height in pixels of the image.
    */
@@ -108,6 +112,7 @@ public:
    * @brief Constructor which creates an empty ResourceImage object.
    *
    * Use ResourceImage::New(...) to create an initialised object.
+   * @SINCE_1_0.0
    */
   ResourceImage();
 
@@ -115,12 +120,14 @@ public:
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
   ~ResourceImage();
 
   /**
    * @brief This copy constructor is required for (smart) pointer semantics.
    *
+   * @SINCE_1_0.0
    * @param [in] handle A reference to the copied handle
    */
   ResourceImage( const ResourceImage& handle );
@@ -128,6 +135,7 @@ public:
   /**
    * @brief This assignment operator is required for (smart) pointer semantics.
    *
+   * @SINCE_1_0.0
    * @param [in] rhs  A reference to the copied handle
    * @return A reference to this
    */
@@ -145,6 +153,7 @@ public:
    * Uses defaults for all options.
    *
    * @sa Dali::FittingMode::Type Dali::SamplingMode::Type
+   * @SINCE_1_0.0
    * @param [in] url The URL of the image file to use.
    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
    * @return A handle to a newly allocated object
@@ -152,10 +161,11 @@ public:
   static ResourceImage New( const std::string& url, bool orientationCorrection = true );
 
   /**
-   * @deprecated DALi 1.1.3 use New( const std::string& url ) instead.
+   * @DEPRECATED_1_1.3. Use New( const std::string& url ) instead.
    *
    * @brief Create an initialised ResourceImage object.
    *
+   * @SINCE_1_0.0
    * @param [in] url The URL of the image file to use.
    * @param [in] loadPol    The LoadPolicy to apply when loading the image resource.
    * @param [in] releasePol The ReleasePolicy to apply to Image.
@@ -167,6 +177,7 @@ public:
   /**
    * @brief Create an initialised ResourceImage object.
    *
+   * @SINCE_1_0.0
    * @param [in] url The URL of the image file to use.
    * @param [in] size The width and height to fit the loaded image to.
    * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
@@ -181,10 +192,11 @@ public:
                             bool orientationCorrection = true );
 
   /**
-   * @deprecated DALi 1.1.3 use New( const std::string& url, ImageDimensions size ) instead.
+   * @DEPRECATED_1_1.3. Use New( const std::string& url, ImageDimensions size ) instead.
    *
    * @brief Create an initialised ResourceImage object.
    *
+   * @SINCE_1_0.0
    * @param [in] url The URL of the image file to use.
    * @param [in] loadPol    The LoadPolicy to apply when loading the image resource.
    * @param [in] releasePol The ReleasePolicy to apply to Image.
@@ -209,16 +221,18 @@ public:
    *
    * If handle points to a ResourceImage object the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
+   * @SINCE_1_0.0
    * @param[in] handle to An object
    * @return handle to a Image object or an uninitialized handle
    */
   static ResourceImage DownCast( BaseHandle handle );
 
   /**
-   * @deprecated DALi 1.1.3
+   * @DEPRECATED_1_1.3
    *
    * @brief Return load policy.
    *
+   * @SINCE_1_0.0
    * @return resource load policy
    */
   LoadPolicy GetLoadPolicy() const;
@@ -228,6 +242,7 @@ public:
    *
    * The asynchronous loading begins when the Image object is created.
    * After the Image object is discarded, the image data will be released from memory.
+   * @SINCE_1_0.0
    * @return The loading state, either Loading, Success or Failed.
    */
   LoadingState GetLoadingState() const;
@@ -235,6 +250,7 @@ public:
   /**
    * @brief Returns the URL of the image.
    *
+   * @SINCE_1_0.0
    * @return The URL of the image file.
    */
   std::string GetUrl() const;
@@ -244,6 +260,7 @@ public:
    *
    * The original set of image loading attributes (requested dimensions, scaling
    * mode and filter mode) are used when requesting the image again.
+   * @SINCE_1_0.0
    * @note If image is offstage and OnDemand policy is set, the reload request is
    * ignored.
    */
@@ -254,6 +271,7 @@ public: // Signals
   /**
    * @brief Emitted when the image data loads successfully, or when the loading fails.
    *
+   * @SINCE_1_0.0
    * @return A signal object to Connect() with.
    */
   ResourceImageSignal& LoadingFinishedSignal();