From: Adeel Kazmi <adeel.kazmi@samsung.com>
Date: Wed, 4 Sep 2019 18:16:35 +0000 (+0100)
Subject: Added a note to FileStream documentation about not calling fclose on the returned... 
X-Git-Tag: dali_1.4.37~7^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F86%2F213386%2F2;hp=39a7a59f0c7b12bf15cd11d093a392ce700dadca;p=platform%2Fcore%2Fuifw%2Fdali-adaptor.git

Added a note to FileStream documentation about not calling fclose on the returned FILE*

Change-Id: I0aea38343fbcbb7c7c3be2805753d3dd9d3e198d
---

diff --git a/dali/devel-api/adaptor-framework/file-stream.h b/dali/devel-api/adaptor-framework/file-stream.h
index 8fa9999..de69f06 100644
--- a/dali/devel-api/adaptor-framework/file-stream.h
+++ b/dali/devel-api/adaptor-framework/file-stream.h
@@ -107,6 +107,7 @@ public:
   /**
    * @brief Returns the file stream
    * @return FILE.
+   * @note This class is responsible for closing the file so the caller SHOULD NOT call fclose() on the returned pointer.
    */
   FILE* GetFile();