Release 4.0.0-preview1-00301

[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / internal / SlotObserver.cs

diff --git a/src/Tizen.NUI/src/internal/SlotObserver.cs b/src/Tizen.NUI/src/internal/SlotObserver.cs
index b008646..757959f 100755 (executable)
--- a/src/Tizen.NUI/src/internal/SlotObserver.cs
+++ b/src/Tizen.NUI/src/internal/SlotObserver.cs
@@ -1,18 +1,19 @@
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 using System;
 using System.Runtime.InteropServices;
 using System.ComponentModel;
@@ -20,10 +21,17 @@ using System.ComponentModel;
 namespace Tizen.NUI
 {
     //Please do not use! this will be internal
+    /// <summary>
+    /// Abstract Interface used by a slot to inform a signal it is disconnecting.<br />
+    /// This is used by the slot if wants to disconnect or is deleted.<br />
+    /// </summary>
+    /// <since_tizen> 3 </since_tizen>
     [EditorBrowsable(EditorBrowsableState.Never)]
     public class SlotObserver : global::System.IDisposable
     {
         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+        /// <summary>swigCMemOwn.</summary>
+        /// <since_tizen> 3 </since_tizen>
         protected bool swigCMemOwn;
 
         internal SlotObserver(global::System.IntPtr cPtr, bool cMemoryOwn)
@@ -39,10 +47,16 @@ namespace Tizen.NUI
 
         //A Flag to check who called Dispose(). (By User or DisposeQueue)
         private bool isDisposeQueued = false;
-        //A Flat to check if it is already disposed.
+        /// <summary>
+        /// A Flat to check if it is already disposed.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         protected bool disposed = false;
 
-
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         ~SlotObserver()
         {
             if (!isDisposeQueued)
@@ -52,6 +66,10 @@ namespace Tizen.NUI
             }
         }
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public void Dispose()
         {
             //Throw excpetion if Dispose() is called in separate thread.
@@ -71,6 +89,10 @@ namespace Tizen.NUI
             }
         }
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         protected virtual void Dispose(DisposeTypes type)
         {
             if (disposed)
@@ -103,7 +125,11 @@ namespace Tizen.NUI
             disposed = true;
         }
 
-
+        /// <summary>
+        /// This method is called when the slot is disconnecting.
+        /// </summary>
+        /// <param name="callback">The callback attached to the signal disconnected.</param>
+        /// <since_tizen> 3 </since_tizen>
         public virtual void SlotDisconnected(SWIGTYPE_p_Dali__CallbackBase callback)
         {
             NDalicPINVOKE.SlotObserver_SlotDisconnected(swigCPtr, SWIGTYPE_p_Dali__CallbackBase.getCPtr(callback));