Release 4.0.0-preview1-00301
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / BaseHandle.cs
index dfc1890..7aacc31 100755 (executable)
@@ -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.
+ *
+ */
 
 namespace Tizen.NUI
 {
@@ -23,6 +24,10 @@ namespace Tizen.NUI
     public class BaseHandle : global::System.IDisposable
     {
         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+        /// <summary>
+        /// swigCMemOwn
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         protected bool swigCMemOwn;
         private bool _registerMe;
 
@@ -70,9 +75,17 @@ 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>
         ~BaseHandle()
         {
             if (!isDisposeQueued)
@@ -105,6 +118,10 @@ namespace Tizen.NUI
             }
         }
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         protected virtual void Dispose(DisposeTypes type)
         {
             if (disposed)
@@ -225,8 +242,8 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Logical AND operator for &&.<br>
-        /// It's possible when doing a && this function (opBitwiseAnd) is never called due to short circuiting.<br>
+        /// Logical AND operator.<br />
+        /// It's possible when doing a  operator this function (opBitwiseAnd) is never called due to short circuiting.<br />
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public static BaseHandle operator &(BaseHandle x, BaseHandle y)
@@ -239,8 +256,8 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Logical OR operator for ||.<br>
-        /// It's possible when doing a || this function (opBitwiseOr) is never called due to short circuiting.<br>
+        /// Logical OR operator for ||.<br />
+        /// It's possible when doing a || this function (opBitwiseOr) is never called due to short circuiting.<br />
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public static BaseHandle operator |(BaseHandle x, BaseHandle y)
@@ -360,7 +377,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Returns the type name for the Handle.<br>
+        /// Returns the type name for the Handle.<br />
         /// Will return an empty string if the typename does not exist. This will happen for types that
         /// have not registered with type-registry.
         /// </summary>
@@ -374,7 +391,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Returns the type info for the Handle.<br>
+        /// Returns the type info for the Handle.<br />
         /// </summary>
         /// <param name="info">The type information.</param>
         /// <returns>True If get the type info.</returns>