Release 4.0.0-preview1-00301
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / AlphaFunction.cs
index cfada8c..529c128 100755 (executable)
@@ -1,32 +1,33 @@
-// 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.
-//
-//
-// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
-// Some have been manually changed
+/*
+ * 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
 {
 
     /// <summary>
-    /// Alpha functions are used in animations to specify the rate of change of the animation parameter over time.<br>
+    /// Alpha functions are used in animations to specify the rate of change of the animation parameter over time.<br />
     /// Understanding an animation as a parametric function over time, the alpha function is applied to the parameter of
     /// the animation before computing the final animation value.
     /// </summary>
     public class AlphaFunction : global::System.IDisposable
     {
         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+        /// <summary>swigCMemOwn.</summary>
+        /// <since_tizen> 3 </since_tizen>
         protected bool swigCMemOwn;
 
         internal AlphaFunction(global::System.IntPtr cPtr, bool cMemoryOwn)
@@ -42,9 +43,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>
         ~AlphaFunction()
         {
             if(!isDisposeQueued)
@@ -76,6 +84,10 @@ namespace Tizen.NUI
             }
         }
 
+        /// <summary>
+        /// To make the AlphaFunction instance be disposed.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         protected virtual void Dispose(DisposeTypes type)
         {
             if (disposed)
@@ -107,8 +119,8 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The constructor.<br>
-        /// Creates an alpha function object with the user-defined alpha function.<br>
+        /// The constructor.<br />
+        /// Creates an alpha function object with the user-defined alpha function.<br />
         /// </summary>
         /// <param name="func">User defined fuction. It must be a method formatted as float alphafunction(float progress)</param>
         /// <since_tizen> 3 </since_tizen>
@@ -118,8 +130,8 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The default constructor.<br>
-        /// Creates an alpha function object with the default built-in alpha function.<br>
+        /// The default constructor.<br />
+        /// Creates an alpha function object with the default built-in alpha function.<br />
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public AlphaFunction() : this(NDalicPINVOKE.new_AlphaFunction__SWIG_0(), true)
@@ -128,8 +140,8 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The constructor.<br>
-        /// Creates an alpha function object with the built-in alpha function passed as a parameter to the constructor.<br>
+        /// The constructor.<br />
+        /// Creates an alpha function object with the built-in alpha function passed as a parameter to the constructor.<br />
         /// </summary>
         /// <param name="function">One of the built-in alpha functions.</param>
         /// <since_tizen> 3 </since_tizen>
@@ -144,8 +156,8 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The constructor.<br>
-        /// Creates a bezier alpha function. The bezier will have the first point at (0,0) and the end point at (1,1).<br>
+        /// The constructor.<br />
+        /// Creates a bezier alpha function. The bezier will have the first point at (0,0) and the end point at (1,1).<br />
         /// </summary>
         /// <remarks>The x components of the control points will be clamped to the range [0, 1] to prevent non-monotonic curves.</remarks>
         /// <param name="controlPoint0">A Vector2 which will be used as the first control point of the curve.</param>
@@ -157,7 +169,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Retrives the control points of the alpha function.<br>
+        /// Retrives the control points of the alpha function.<br />
         /// </summary>
         /// <param name="controlPoint0">A Vector2 which will be used as the first control point of the curve.</param>
         /// <param name="controlPoint1">A Vector2 which will be used as the second control point of the curve.</param>
@@ -180,8 +192,8 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Returns the built-in function used by the alpha function.<br>
-        /// In case no built-in function has been specified, it will return AlphaFunction::DEFAULT.<br>
+        /// Returns the built-in function used by the alpha function.<br />
+        /// In case no built-in function has been specified, it will return AlphaFunction::DEFAULT.<br />
         /// </summary>
         /// <returns>One of the built-in alpha functions.</returns>
         /// <since_tizen> 3 </since_tizen>
@@ -266,6 +278,9 @@ namespace Tizen.NUI
             /// Sudden start, exceed end position and return to a gradual stop.
             /// </summary>
             EaseOutBack,
+            /// <summary>
+            /// The count of the BuiltinFunctions enum.
+            /// </summary>
             Count
         }