Apply the new doxygen tagging rule for @DEPRECATED

- Change @deprecrated 1.x.x to @DEPRECATED_1_x.x to follow the new doxygen tagging rule.

Change-Id: Ic8b4fbc7462777cdcfcad1aad3a856bd1e21bb0c

diff --git a/dali/internal/event/images/buffer-image-impl.h b/dali/internal/event/images/buffer-image-impl.h
index 72db2e2..7be9544 100644 (file)
--- a/dali/internal/event/images/buffer-image-impl.h
+++ b/dali/internal/event/images/buffer-image-impl.h
@@ -62,7 +62,7 @@ public:
                              ReleasePolicy releasePol = IMAGE_RELEASE_POLICY_DEFAULT );
 
   /**
-   * @deprecated Support for externally owned Pixel Buffers is due to be removed TBA. It is recommended that a BufferImage owned Buffer be used instead.
+   * @DEPRECATED_1_1.5. Support for externally owned Pixel Buffers is due to be removed TBA. It is recommended that a BufferImage owned Buffer be used instead.
    *
    * @brief Create a new BufferImage, which uses external data source.
    *

diff --git a/dali/public-api/actors/image-actor.h b/dali/public-api/actors/image-actor.h
index 5160bc9..072f3cc 100644 (file)
--- a/dali/public-api/actors/image-actor.h
+++ b/dali/public-api/actors/image-actor.h
@@ -42,6 +42,7 @@ class ImageActor;
 }
 
 /**
+ * @DEPRECATED_1_1.11
  * @brief An actor for displaying images.
  *
  * Allows the developer to add an actor to stage which displays the content of an Image object.
@@ -77,15 +78,33 @@ public:
   {
     enum
     {
-      PIXEL_AREA = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "pixelArea",   type Rect<int> @SINCE_1_0.0
-      STYLE,                                                   ///< @deprecated Dali 1.1.11 name "style",       type std::string @SINCE_1_0.0
-      BORDER,                                                  ///< @deprecated Dali 1.1.11 name "border",      type Vector4 @SINCE_1_0.0
-      IMAGE,                                                   ///< name "image",       type Map {"filename":"", "loadPolicy":...} @SINCE_1_0.0
+      /**
+       * @brief name "pixelArea",   type Rect<int>
+       * @SINCE_1_0.0
+       */
+      PIXEL_AREA = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX,
+      /**
+       * @DEPRECATED_1_1.11
+       * @brief name "style",       type std::string
+       * @SINCE_1_0.0
+       */
+      STYLE,
+      /**
+       * @DEPRECATED_1_1.11
+       * @brief name "border",      type Vector4
+       * @SINCE_1_0.0
+       */
+      BORDER,
+      /**
+       * @brief name "image",       type Map {"filename":"", "loadPolicy":...}
+       * @SINCE_1_0.0
+       */
+      IMAGE,
     };
   };
 
   /**
-   * @deprecated DALi 1.1.11, only quad style supported, use ImageView instead for nine patch
+   * @DEPRECATED_1_1.11. Only quad style supported, use ImageView instead for nine patch.
    *
    * @brief Style determines how the Image is rendered.
    *
@@ -111,8 +130,18 @@ public:
   enum Style
   {
     STYLE_QUAD,                 ///< As a simple quad. @SINCE_1_0.0
-    STYLE_NINE_PATCH,           ///< @deprecated Dali 1.1.11 As a nine-patch. @SINCE_1_0.0
-    STYLE_NINE_PATCH_NO_CENTER  ///< @deprecated Dali 1.1.11 As a nine-patch without center section being rendered. @SINCE_1_0.0
+    /**
+     * @DEPRECATED_1_1.11
+     * @brief As a nine-patch.
+     * @SINCE_1_0.0
+     */
+    STYLE_NINE_PATCH,
+    /**
+     * @DEPRECATED_1_1.11
+     * @brief As a nine-patch without center section being rendered.
+     * @SINCE_1_0.0
+     */
+    STYLE_NINE_PATCH_NO_CENTER
   };
 
   /**
@@ -252,7 +281,7 @@ public:
   PixelArea GetPixelArea() const;
 
   /**
-   * @deprecated DALi 1.1.11, use ImageView instead
+   * @DEPRECATED_1_1.11. Use ImageView instead.
    *
    * @brief Set how the image is rendered; the default is STYLE_QUAD.
    *
@@ -265,7 +294,7 @@ public:
   void SetStyle(Style style);
 
   /**
-   * @deprecated DALi 1.1.11, use ImageView instead
+   * @DEPRECATED_1_1.11. Use ImageView instead.
    *
    * @brief Query how the image is rendered.
    *
@@ -278,7 +307,7 @@ public:
   Style GetStyle() const;
 
   /**
-   * @deprecated DALi 1.1.11, use ImageView instead
+   * @DEPRECATED_1_1.11. Use ImageView instead.
    *
    * @brief Set the border used with STYLE_NINE_PATCH.
    *
@@ -290,7 +319,7 @@ public:
   void SetNinePatchBorder(const Vector4& border);
 
   /**
-   * @deprecated DALi 1.1.11, use ImageView instead
+   * @DEPRECATED_1_1.11. Use ImageView instead.
    *
    * @brief Retrieve the border used with STYLE_NINE_PATCH.
    *

diff --git a/dali/public-api/images/buffer-image.h b/dali/public-api/images/buffer-image.h
index 481c3a0..7c3a6d9 100644 (file)
--- a/dali/public-api/images/buffer-image.h
+++ b/dali/public-api/images/buffer-image.h
@@ -81,7 +81,7 @@ public:
                          Pixel::Format pixelformat=Pixel::RGBA8888);
 
   /**
-   * @deprecated DALi 1.1.3, use New( unsigned int width, unsigned int height ) instead.
+   * @DEPRECATED_1_1.3. Use New( unsigned int width, unsigned int height ) instead.
    *
    * @brief Create a new BufferImage.
    *
@@ -132,7 +132,7 @@ public:
                          unsigned int  stride=0);
 
   /**
-   * @deprecated DALi 1.1.3, use New( PixelBuffer* pixelBuffer, unsigned int width, unsigned int height ) instead.
+   * @DEPRECATED_1_1.3. Use New( PixelBuffer* pixelBuffer, unsigned int width, unsigned int height ) instead.
    *
    * @brief Create a new BufferImage, which uses an external data source.
    *

diff --git a/dali/public-api/images/encoded-buffer-image.h b/dali/public-api/images/encoded-buffer-image.h
index fb7501b..ea90887 100644 (file)
--- a/dali/public-api/images/encoded-buffer-image.h
+++ b/dali/public-api/images/encoded-buffer-image.h
@@ -78,7 +78,7 @@ public:
   EncodedBufferImage();
 
   /**
-   * @deprecated DALi 1.1.3 use New(const uint8_t* const, std::size_t,ImageDimensions,FittingMode::Type,SamplingMode::Type,bool) instead.
+   * @DEPRECATED_1_1.3. Use New(const uint8_t* const, std::size_t,ImageDimensions,FittingMode::Type,SamplingMode::Type,bool) instead.
    *
    * @brief Create an initialised image object from an encoded image buffer in memory.
    *

diff --git a/dali/public-api/images/frame-buffer-image.h b/dali/public-api/images/frame-buffer-image.h
index 0d4f74b..5b42573 100644 (file)
--- a/dali/public-api/images/frame-buffer-image.h
+++ b/dali/public-api/images/frame-buffer-image.h
@@ -85,7 +85,7 @@ public:
                               RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
 
   /**
-   * @deprecated DALi 1.1.3 use New() instead.
+   * @DEPRECATED_1_1.3. Use New() instead.
    *
    * @brief Create a new FrameBufferImage.
    *
@@ -116,7 +116,7 @@ public:
   static FrameBufferImage New(NativeImageInterface& image);
 
   /**
-   * @deprecated DALi 1.1.3 use New( NativeImageInterface& ) instead.
+   * @DEPRECATED_1_1.3. Use New( NativeImageInterface& ) instead.
    *
    * @brief Create a new FrameBufferImage.
    *

diff --git a/dali/public-api/images/image.h b/dali/public-api/images/image.h
index 81e61b6..ef15109 100644 (file)
--- a/dali/public-api/images/image.h
+++ b/dali/public-api/images/image.h
@@ -57,7 +57,7 @@ class DALI_IMPORT_API Image : public BaseHandle
 public:
 
   /**
-   * @deprecated DALi 1.1.3 Image resource is released as soon as last handle is released
+   * @DEPRECATED_1_1.3. Image resource is released as soon as last handle is released.
    * @brief ReleasePolicy controls the way images are deleted from memory.
    * @SINCE_1_0.0
    */
@@ -120,7 +120,7 @@ public:
   static Image DownCast( BaseHandle handle );
 
   /**
-   * @deprecated DALi 1.1.3
+   * @DEPRECATED_1_1.3
    *
    * @brief Return resource release policy.
    *

diff --git a/dali/public-api/images/nine-patch-image.h b/dali/public-api/images/nine-patch-image.h
index 67bf601..d9055da 100644 (file)
--- a/dali/public-api/images/nine-patch-image.h
+++ b/dali/public-api/images/nine-patch-image.h
@@ -116,7 +116,7 @@ public:
   NinePatchImage& operator=(const NinePatchImage& rhs);
 
   /**
-   * @deprecated DALi 1.1.4 use GetStretchPixelsX and GetStretchPixelsY instead
+   * @DEPRECATED_1_1.4. Use GetStretchPixelsX and GetStretchPixelsY instead.
    *
    * @brief Get the stretch borders
    *

diff --git a/dali/public-api/images/resource-image.h b/dali/public-api/images/resource-image.h
index 9004a75..9c44af1 100644 (file)
--- a/dali/public-api/images/resource-image.h
+++ b/dali/public-api/images/resource-image.h
@@ -76,7 +76,7 @@ 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
@@ -161,7 +161,7 @@ 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.
    *
@@ -192,7 +192,7 @@ 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.
    *
@@ -228,7 +228,7 @@ public:
   static ResourceImage DownCast( BaseHandle handle );
 
   /**
-   * @deprecated DALi 1.1.3
+   * @DEPRECATED_1_1.3
    *
    * @brief Return load policy.
    *

diff --git a/dali/public-api/shader-effects/shader-effect.h b/dali/public-api/shader-effects/shader-effect.h
index e056d4a..ed0d44f 100644 (file)
--- a/dali/public-api/shader-effects/shader-effect.h
+++ b/dali/public-api/shader-effects/shader-effect.h
@@ -66,7 +66,7 @@ class ShaderEffect;
 }
 
 /**
- * @deprecated DALi 1.0.47
+ * @DEPRECATED_1_0.47
  *
  * @brief Shader effects provide a visual effect for image actors.
  *
@@ -168,9 +168,9 @@ public:
    */
   enum UniformCoordinateType
   {
-    COORDINATE_TYPE_DEFAULT,           ///< Default, No transformation to be applied @SINCE_1_0.0
-    COORDINATE_TYPE_VIEWPORT_POSITION, ///< @deprecated Dali 1.1.11 The uniform is a position vector in viewport coordinates that needs to be converted to GL view space coordinates. @SINCE_1_0.0
-    COORDINATE_TYPE_VIEWPORT_DIRECTION ///< @deprecated Dali 1.1.11 The uniform is a directional vector in viewport coordinates that needs to be converted to GL view space coordinates. @SINCE_1_0.0
+    COORDINATE_TYPE_DEFAULT,           ///< @brief Default, No transformation to be applied @SINCE_1_0.0
+    COORDINATE_TYPE_VIEWPORT_POSITION, ///< @DEPRECATED_1_1.11 @brief The uniform is a position vector in viewport coordinates that needs to be converted to GL view space coordinates. @SINCE_1_0.0
+    COORDINATE_TYPE_VIEWPORT_DIRECTION ///< @DEPRECATED_1_1.11 @brief The uniform is a directional vector in viewport coordinates that needs to be converted to GL view space coordinates. @SINCE_1_0.0
   };
 
   /**