Update Images' public header comments

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

diff --git a/dali/public-api/images/frame-buffer-image.h b/dali/public-api/images/frame-buffer-image.h
index 5b42573..a778d69 100644 (file)
--- a/dali/public-api/images/frame-buffer-image.h
+++ b/dali/public-api/images/frame-buffer-image.h
@@ -39,22 +39,26 @@ namespace RenderBuffer
 {
 /**
  * @brief Render Buffer formats
+ *
  * The default format for framebuffer creation is COLOR, so If a depth buffer for 3D rendering is required use
  * COLOR_DEPTH instead
+ * @SINCE_1_0.0
  */
 enum Format ///< Framebuffer format, default color depth is RGBA 32 bit with alpha @SINCE_1_0.0
 {
   COLOR,                ///< Framebuffer will be created with color buffer. @SINCE_1_0.0
   COLOR_DEPTH,          ///< Framebuffer will be created with color and depth buffer @SINCE_1_0.0
   COLOR_STENCIL,        ///< Framebuffer will be created with color and stencil buffer @SINCE_1_0.0
-  COLOR_DEPTH_STENCIL   ///< Framebuffer will be created with color, depth and stencil buffer. NOTE: May be not supported in all devices @SINCE_1_0.0
+  COLOR_DEPTH_STENCIL   ///< Framebuffer will be created with color, depth and stencil buffer. @note May be not supported in all devices @SINCE_1_0.0
 };
 }
 
 /**
- * @brief FrameBufferImage represents a Open GL ES Frame Buffer Object
- * It contains the result of an 'off screen' render pass of a RenderTask.
- * The FrameBufferImage can then be used for rendering to the screen.
+ * @brief FrameBufferImage represents a GLES Frame Buffer Object and contains the result
+ * of an 'off screen' render pass of a RenderTask.
+ *
+ * The FrameBufferImage can then be used with an @ref Dali::Toolkit::ImageView (with optional shader
+ * effects) and rendered to the screen.
  * @SINCE_1_0.0
  */
 class DALI_IMPORT_API FrameBufferImage : public Image
@@ -63,7 +67,7 @@ public:
   /**
    * @brief Constructor which creates an uninitialized FrameBufferImage object.
    *
-   * Use Image::New(...) to create an initialised object.
+   * Use @ref FrameBufferImage::New to create an initialised object.
    * @SINCE_1_0.0
    */
   FrameBufferImage();
@@ -91,10 +95,13 @@ public:
    *
    * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
    * @SINCE_1_0.0
+   * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
+   * We do recommend not to use this method.
+   * Please refer the Remarks of ReleasePolicy for more information.
    * @param [in] width       The width in pixels. Setting to zero will use the width of the stage.
    * @param [in] height      The height in pixels. Setting to zero will use the height of the stage.
    * @param [in] pixelFormat The pixel format.
-   * @param [in] releasePolicy The ReleasePolicy to apply to the FrameBufferImage.
+   * @param [in] releasePolicy The releasePolicy to apply to the FrameBufferImage.
    * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
    *
    * @return A handle to a new instance of a FrameBufferImage.
@@ -122,8 +129,11 @@ public:
    *
    * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
    * @SINCE_1_0.0
+   * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
+   * We do recommend not to use this method.
+   * Please refer the remarks of ReleasePolicy for more information.
    * @param [in] image       The native image.
-   * @param [in] releasePolicy The ReleasePolicy to apply to the FrameBufferImage.
+   * @param [in] releasePolicy The releasePolicy to apply to the FrameBufferImage.
    *
    * @return A handle to a new instance of a FrameBufferImage.
    * @post When the FrameBufferImage is first used as a render target, an exception may be thrown if the NativeImage cannot be mapped to a texture.
@@ -131,13 +141,13 @@ public:
   static FrameBufferImage New(NativeImageInterface& image, ReleasePolicy releasePolicy);
 
   /**
-   * @brief Downcast an Object handle to FrameBufferImage handle.
+   * @brief Downcast a handle to FrameBufferImage handle.
    *
    * If handle points to a FrameBufferImage 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 FrameBufferImage object or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a FrameBufferImage object or an uninitialized handle
    */
   static FrameBufferImage DownCast( BaseHandle handle );