From: seungho <sbsh.baek@samsung.com>
Date: Fri, 23 Jul 2021 04:52:48 +0000 (+0900)
Subject: [NUI] Add some comment about Animatable property of View
X-Git-Tag: accepted/tizen/unified/20231205.024657~1651
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=77ba100fe9a5f80e7cfbe7d94590a1013ad58b02;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

[NUI] Add some comment about Animatable property of View

Signed-off-by: seungho <sbsh.baek@samsung.com>
---

diff --git a/src/Tizen.NUI/src/public/BaseComponents/View.cs b/src/Tizen.NUI/src/public/BaseComponents/View.cs
index 58c0b62..0ff1f26 100755
--- a/src/Tizen.NUI/src/public/BaseComponents/View.cs
+++ b/src/Tizen.NUI/src/public/BaseComponents/View.cs
@@ -470,6 +470,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "CornerRadius", new Vector4(10, 10, 10, 10));
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 9 </since_tizen>
@@ -997,6 +1000,14 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// Retrieves and sets the view's opacity.<br />
         /// </summary>
+        /// <remarks>
+        /// <para>
+        /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "Opacity", 0.5f);
+        /// </code>
+        /// </para>
+        /// </remarks>
         /// <since_tizen> 3 </since_tizen>
         public float Opacity
         {
@@ -1244,6 +1255,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "SizeWidth", 500.0f);
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
@@ -1267,6 +1281,9 @@ namespace Tizen.NUI.BaseComponents
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
         /// </para>
+        /// <code>
+        /// animation.AnimateTo(view, "SizeHeight", 500.0f);
+        /// </code>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
         public float SizeHeight
@@ -1290,6 +1307,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "Position", new Position(50, 0));
+        /// </code>
         /// </para>
         /// The property cascade chaining set is possible. For example, this (view.Position.X = 1.0f;) is possible.
         /// </remarks>
@@ -1314,6 +1334,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "PositionX", 50.0f);
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
@@ -1336,6 +1359,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "PositionY", 50.0f);
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
@@ -1358,6 +1384,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "PositionZ", 50.0f);
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
@@ -1400,6 +1429,9 @@ namespace Tizen.NUI.BaseComponents
         /// </para>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "Orientation", new Rotation(new Radian((float)Math.PI), Vector3.XAxis));
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
@@ -1438,6 +1470,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "Scale", new Vector3(1.5f, 1.5f, 1.0f));
+        /// </code>
         /// </para>
         /// The property cascade chaining set is possible. For example, this (view.Scale.X = 0.1f;) is possible.
         /// </remarks>
@@ -1462,6 +1497,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "ScaleX", 1.5f);
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
@@ -1484,6 +1522,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "ScaleY", 1.5f);
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
@@ -1506,6 +1547,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "ScaleZ", 1.5f);
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
@@ -1548,6 +1592,9 @@ namespace Tizen.NUI.BaseComponents
         /// </para>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "Visibility", false);
+        /// </code>
         /// </para>
         /// </remarks>
         /// <since_tizen> 3 </since_tizen>
@@ -2017,6 +2064,9 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <para>
         /// Animatable - This property can be animated using <c>Animation</c> class.
+        /// <code>
+        /// animation.AnimateTo(view, "Size", new Size(100, 100));
+        /// </code>
         /// </para>
         /// The property cascade chaining set is possible. For example, this (view.Size.Width = 1.0f;) is possible.
         /// </remarks>