From: Eunki Hong <eunkiki.hong@samsung.com>
Date: Fri, 19 Jan 2024 04:04:36 +0000 (+0900)
Subject: [NUI] Add some remarks at BaseHandle class about Dispose
X-Git-Tag: submit/tizen/20240124.080400~1^2~2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=141c6b1f2ca30016415d0fe3898f3cf6a65a07e8;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

[NUI] Add some remarks at BaseHandle class about Dispose

Signed-off-by: Eunki Hong <eunkiki.hong@samsung.com>
---

diff --git a/src/Tizen.NUI/src/public/Common/BaseHandle.cs b/src/Tizen.NUI/src/public/Common/BaseHandle.cs
index 1bff524fc..f1d61bdaa 100755
--- a/src/Tizen.NUI/src/public/Common/BaseHandle.cs
+++ b/src/Tizen.NUI/src/public/Common/BaseHandle.cs
@@ -25,6 +25,11 @@ namespace Tizen.NUI
     /// <summary>
     /// BaseHandle is a handle to an internal Dali resource.
     /// </summary>
+    /// <remarks>
+    /// Internal Dali resources with BaseHandle has reference count internally.<br/>
+    /// And Dali resources will release the object only if reference count become zero.<br/>
+    /// It mean, even we call <see cref="Dispose"/>, the reousrce will not be released if some native has reference count.
+    /// </remarks>
     /// <since_tizen> 3 </since_tizen>
     public class BaseHandle : Element, global::System.IDisposable
     {
@@ -335,6 +340,10 @@ namespace Tizen.NUI
         /// <summary>
         /// Dispose.
         /// </summary>
+        /// <remarks>
+        /// This method release only C# side objects. If someone hold BaseHandle at Native side<br/>
+        /// the object will not be removed until native side reset the handle.
+        /// </remarks>
         /// <since_tizen> 3 </since_tizen>
         public void Dispose()
         {