Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / images / nine-patch-image.h

diff --git a/dali/public-api/images/nine-patch-image.h b/dali/public-api/images/nine-patch-image.h
index 925d2c2..8c4f291 100644 (file)
--- a/dali/public-api/images/nine-patch-image.h
+++ b/dali/public-api/images/nine-patch-image.h
@@ -36,7 +36,8 @@ class NinePatchImage;
 }
 
 /**
- * @brief NinePatchImage represents an image resource that can be added to ImageViews.
+ * @brief NinePatchImage represents an nine-patch image resource.
+ *
  * It contains a bitmap that is synchronously loaded from the file system that contains
  * a 9 patch border - a 1 pixel border that describes the stretch borders and the child
  * area.
@@ -44,11 +45,9 @@ class NinePatchImage;
  * The class offers an API to read the stretch area and child area, but it does not
  * remove the border from it's bitmap. An API can be used to obtain a BufferImage with
  * the border removed.
- *
- * Adding this image to an ImageView using an Image handle will automatically convert
- * to use the cropped BufferImage - if you don't retain a handle to this object, it will
- * be automatically destroyed.
  * @since_tizen 2.4
+ * @remarks This is an experimental feature for ImageActor and might not be supported in the next release.
+ * We do recommend not to use it.
  */
 class DALI_IMPORT_API NinePatchImage : public ResourceImage
 {
@@ -56,7 +55,7 @@ public:
   /**
    * @brief Constructor which creates an uninitialized NinePatchImage object.
    *
-   * Use Image::New(...) to create an initialised object.
+   * Use @ref Image::New to create an initialised object.
    * @since_tizen 2.4
    */
   NinePatchImage();
@@ -66,23 +65,23 @@ public:
    *
    * A pixel buffer for image data is allocated and loaded from the filesystem.
    * Dali has ownership of the buffer.
-   * @note: default resource management policies are Immediate and Never
-   *
    * @since_tizen 2.4
-   * @param [in] filename    File to load synchronously into buffer
-   * @return a handle to a new instance of NinePatchImage
+   * @param [in] filename File to load synchronously into buffer
+   * @return A handle to a new instance of NinePatchImage
+   * @note Default resource management policies are Immediate and Never
+   *
    */
   static NinePatchImage New( const std::string& filename );
 
   /**
-   * @brief Downcast an Object handle to NinePatchImage.
+   * @brief Downcast a handle to NinePatchImage handle.
    *
    * If handle points to a NinePatchImage the downcast produces valid
    * handle. If not the returned handle is left uninitialized.
    *
    * @since_tizen 2.4
-   * @param[in] handle to An object
-   * @return handle to a NinePatchImage or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a NinePatchImage or an uninitialized handle
    */
   static NinePatchImage DownCast( BaseHandle handle );
 
@@ -121,12 +120,13 @@ public:
   /**
    * @brief Get the child rectangle
    * @since_tizen 2.4
-   * @return the position and size of the child rectangle
+   * @return The position and size of the child rectangle
    */
   Rect<int> GetChildRectangle();
 
   /**
    * @brief Creates a buffer image from the bitmap with the 1 pixel border cropped off.
+   *
    * This does not change the internal bitmap.
    *
    * @since_tizen 2.4