Add comment in the capture.h 20/237620/3
authorSeungho, Baek <sbsh.baek@samsung.com>
Thu, 2 Jul 2020 01:51:45 +0000 (10:51 +0900)
committerSeungho, Baek <sbsh.baek@samsung.com>
Mon, 6 Jul 2020 08:20:01 +0000 (17:20 +0900)
 - Add @return comment at the GetNativeImageSource()

Change-Id: Ic46eac21b4f138871ae5e1a7b9dc19140da85b9e
Signed-off-by: Seungho, Baek <sbsh.baek@samsung.com>
dali/public-api/capture/capture.h

index 5585603..73afb16 100755 (executable)
@@ -176,6 +176,7 @@ public:
    * @param[in] source source actor to be used for capture.
    * @param[in] size captured size.
    * @param[in] path image file path to be saved as a file.
+   *            If path is empty string, the captured result is not be saved as a file.
    * @param[in] clearColor background color of captured scene
    * @param[in] quality The value to control image quality for jpeg file format in the range [1, 100]
    */
@@ -189,6 +190,7 @@ public:
    * @param[in] source source actor to be used for capture.
    * @param[in] size captured size.
    * @param[in] path image file path to be saved as a file.
+   *            If path is empty string, the captured result is not be saved as a file.
    * @param[in] clearColor background color of captured scene
    */
   void Start( Actor source, const Vector2& size, const std::string &path, const Vector4& clearColor );
@@ -201,6 +203,7 @@ public:
    * @param[in] source source actor to be used for capture.
    * @param[in] size captured size.
    * @param[in] path image file path to be saved as a file.
+   *            If path is empty string, the captured result is not be saved as a file.
    * @note Clear color is transparent.
    */
   void Start( Actor source, const Vector2& size, const std::string &path );
@@ -209,6 +212,8 @@ public:
    * @brief Get NativeImageSourcePtr that is saved captured image.
    *
    * @SINCE_1_9.10
+   *
+   * @return NativeImageSourcePtr Captured result that can be rendered with DALi
    */
   Dali::NativeImageSourcePtr GetNativeImageSource() const;