Release 4.0.0-preview1-00301

[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / KeyFrames.cs

diff --git a/src/Tizen.NUI/src/public/KeyFrames.cs b/src/Tizen.NUI/src/public/KeyFrames.cs
index 92abafb..a9d2a30 100755 (executable)
--- a/src/Tizen.NUI/src/public/KeyFrames.cs
+++ b/src/Tizen.NUI/src/public/KeyFrames.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;
 
@@ -20,8 +21,8 @@ namespace Tizen.NUI
 {
 
     /// <summary>
-    /// A set of key frames for a property that can be animated using Dali Animation.<br>
-    /// This allows the generation of key frame objects from individual Property::Values.<br>
+    /// A set of key frames for a property that can be animated using DALi animation.<br />
+    /// This allows the generation of key frame objects from individual Property::Values.<br />
     /// </summary>
     public class KeyFrames : BaseHandle
     {
@@ -37,6 +38,10 @@ namespace Tizen.NUI
             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
         }
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         protected override void Dispose(DisposeTypes type)
         {
             if(disposed)
@@ -73,8 +78,9 @@ namespace Tizen.NUI
         /// <summary>
         /// Adds a key frame.
         /// </summary>
-        /// <param name="progress">A progress value between 0.0 and 1.0</param>
-        /// <param name="value">A value</param>
+        /// <param name="progress">A progress value between 0.0 and 1.0.</param>
+        /// <param name="value">A value.</param>
+        /// <since_tizen> 3 </since_tizen>
         public void Add(float progress, object value)
         {
             PropertyValue val = PropertyValue.CreateFromObject(value);
@@ -84,9 +90,10 @@ namespace Tizen.NUI
         /// <summary>
         /// Adds a key frame.
         /// </summary>
-        /// <param name="progress">A progress value between 0.0 and 1.0</param>
+        /// <param name="progress">A progress value between 0.0 and 1.0.</param>
         /// <param name="value">A value</param>
-        /// <param name="alpha">The alpha function used to blend to the next keyframe</param>
+        /// <param name="alpha">The alpha function used to blend to the next keyframe.</param>
+        /// <since_tizen> 3 </since_tizen>
         public void Add(float progress, object value, AlphaFunction alpha)
         {
             PropertyValue val = PropertyValue.CreateFromObject(value);
@@ -96,12 +103,17 @@ namespace Tizen.NUI
         /// <summary>
         /// Creates an initialized KeyFrames handle.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public KeyFrames() : this(NDalicPINVOKE.KeyFrames_New(), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 
         }
 
+        /// <summary>
+        /// [Obsolete("Please do not use! this will be deprecated")]
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         [Obsolete("Please do not use! this will be deprecated")]
         public static KeyFrames DownCast(BaseHandle handle)
         {
@@ -114,7 +126,8 @@ namespace Tizen.NUI
         /// Gets the type of the key frame.
         /// </summary>
         /// <returns>The key frame property type</returns>
-        public PropertyType GetType()
+        /// <since_tizen> 3 </since_tizen>
+        public new PropertyType GetType()
         {
             PropertyType ret = (PropertyType)NDalicPINVOKE.KeyFrames_GetType(swigCPtr);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -124,8 +137,9 @@ namespace Tizen.NUI
         /// <summary>
         /// Adds a key frame.
         /// </summary>
-        /// <param name="progress">A progress value between 0.0 and 1.0</param>
-        /// <param name="value">A value</param>
+        /// <param name="progress">A progress value between 0.0 and 1.0.</param>
+        /// <param name="value">A value.</param>
+        /// <since_tizen> 3 </since_tizen>
         public void Add(float progress, PropertyValue value)
         {
             NDalicPINVOKE.KeyFrames_Add__SWIG_0(swigCPtr, progress, PropertyValue.getCPtr(value));
@@ -135,9 +149,10 @@ namespace Tizen.NUI
         /// <summary>
         /// Adds a key frame.
         /// </summary>
-        /// <param name="progress">A progress value between 0.0 and 1.0</param>
-        /// <param name="value">A value</param>
-        /// <param name="alpha">The alpha function used to blend to the next keyframe</param>
+        /// <param name="progress">A progress value between 0.0 and 1.0.</param>
+        /// <param name="value">A value.</param>
+        /// <param name="alpha">The alpha function used to blend to the next keyframe.</param>
+        /// <since_tizen> 3 </since_tizen>
         public void Add(float progress, PropertyValue value, AlphaFunction alpha)
         {
             NDalicPINVOKE.KeyFrames_Add__SWIG_1(swigCPtr, progress, PropertyValue.getCPtr(value), AlphaFunction.getCPtr(alpha));
@@ -146,4 +161,4 @@ namespace Tizen.NUI
 
     }
 
-}
+}
\ No newline at end of file