Marked new API's since 1.1.4 10/48610/3
authorLee Morgan <Lee.morgan@partner.samsung.com>
Wed, 23 Sep 2015 15:04:16 +0000 (16:04 +0100)
committerLee Morgan <Lee.morgan@partner.samsung.com>
Thu, 24 Sep 2015 11:56:18 +0000 (12:56 +0100)
Change-Id: I36ed0f90917a19ed967948af2ae160657c02a227

dali/public-api/images/encoded-buffer-image.h
dali/public-api/images/nine-patch-image.h

index c4c1d86..396f6c7 100644 (file)
@@ -129,6 +129,8 @@ public:
    * policy is set, a reload will not be possible, so the Image should never be
    * used once all actors using it have gone off-stage.
    * @return A handle to a newly allocated object.
+   *
+   * @since DALi 1.1.4
    */
   static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount, ImageDimensions size, FittingMode::Type fittingMode, SamplingMode::Type samplingMode, bool orientationCorrection = true );
 
index f0c3a30..35849c4 100644 (file)
@@ -119,6 +119,8 @@ public:
    * @brief Retrieves the horizontal stretch pixel ranges in the cropped image space
    *
    * @return the horizontal stretch pixel ranges in the cropped image space
+   *
+   * @since DALi 1.1.4
    */
   const StretchRanges& GetStretchPixelsX();
 
@@ -126,17 +128,21 @@ public:
    * @brief Retrieves the vertical stretch pixel ranges in the cropped image space
    *
    * @return the vertical stretch pixel ranges in the cropped image space
+   *
+   * @since DALi 1.1.4
    */
   const StretchRanges& GetStretchPixelsY();
 
   /**
-   * Get the child rectangle
+   * @brief Get the child rectangle
+   *
    * @return the position and size of the child rectangle
    */
   Rect<int> GetChildRectangle();
 
   /**
-   * Creates a buffer image from the bitmap with the 1 pixel border cropped off.
+   * @brief Creates a buffer image from the bitmap with the 1 pixel border cropped off.
+   *
    * This does not change the internal bitmap.
    *
    * @return The cropped BufferImage
@@ -144,9 +150,12 @@ public:
   BufferImage CreateCroppedBufferImage();
 
   /**
-   * Helper method to determine if the filename indicates that the image has a 9 patch or n patch border.
+   * @brief Helper method to determine if the filename indicates that the image has a 9 patch or n patch border.
+   *
    * @param [in] url The URL of the image file.
    * @return true if it is a 9 patch or n patch image
+   *
+   * @since DALi 1.1.4
    */
   static bool IsNinePatchUrl( const std::string& url );