Release 4.0.0-preview1-00301
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / PropertyCondition.cs
index f32b310..5cc2dca 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
 {
@@ -33,6 +34,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)
@@ -77,6 +82,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Retrieves the arguments that this condition uses.
         /// </summary>
+        /// <returns>The arguments used for this condition.</returns>
         /// <since_tizen> 4 </since_tizen>
         public uint GetArgumentCount()
         {
@@ -84,10 +90,12 @@ namespace Tizen.NUI
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
             return ret;
         }
-        ///<summary>
+        /// <summary>
         /// Retrieves the arguments that this condition uses
-        ///</summary>
-        ///<since_tizen> 4 </since_tizen>
+        /// </summary>
+        /// <param name="index">The condition index to get the argument.</param>
+        /// <returns>The arguments used for this condition.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public float GetArgument(uint index)
         {
             float ret = NDalicPINVOKE.PropertyCondition_GetArgument(swigCPtr, index);
@@ -95,10 +103,12 @@ namespace Tizen.NUI
             return ret;
         }
 
-        ///<summary>
+        /// <summary>
         /// LessThan condition compares whether property is less than arg.
-        ///</summary>
-        ///<since_tizen> 4 </since_tizen>
+        /// </summary>
+        /// <param name="arg">The argument for the condition.</param>
+        /// <returns>A property condition function object.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public static PropertyCondition LessThan(float arg)
         {
             PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.LessThanCondition(arg), true);
@@ -106,10 +116,12 @@ namespace Tizen.NUI
             return ret;
         }
 
-        ///<summary>
+        /// <summary>
         /// GreaterThan condition compares whether property is greater than arg.
-        ///</summary>
-        ///<since_tizen> 4 </since_tizen>
+        /// </summary>
+        /// <param name="arg">The argument for the condition.</param>
+        /// <returns>A property condition function object.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public static PropertyCondition GreaterThan(float arg)
         {
             PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.GreaterThanCondition(arg), true);
@@ -117,10 +129,13 @@ namespace Tizen.NUI
             return ret;
         }
 
-        ///<summary>
+        /// <summary>
         /// Inside condition compares whether property is greater than arg0 and less than arg1.
-        ///</summary>
-        ///<since_tizen> 4 </since_tizen>
+        /// </summary>
+        /// <param name="arg0">The first argument for the condition.</param>
+        /// <param name="arg1">The second argument for the condition.</param>
+        /// <returns>A property condition function object.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public static PropertyCondition Inside(float arg0, float arg1)
         {
             PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.InsideCondition(arg0, arg1), true);
@@ -128,10 +143,13 @@ namespace Tizen.NUI
             return ret;
         }
 
-        ///<summary>
+        /// <summary>
         /// Outside condition compares whether property is less than arg0 or greater than arg1
-        ///</summary>
-        ///<since_tizen> 4 </since_tizen>
+        /// </summary>
+        /// <param name="arg0">The first argument for the condition.</param>
+        /// <param name="arg1">The second argument for the condition.</param>
+        /// <returns>A property condition function object.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public static PropertyCondition Outside(float arg0, float arg1)
         {
             PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.OutsideCondition(arg0, arg1), true);
@@ -139,10 +157,13 @@ namespace Tizen.NUI
             return ret;
         }
 
-        ///<summary>
+        /// <summary>
         /// Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount.
-        ///</summary>
-        ///<since_tizen> 4 </since_tizen>
+        /// </summary>
+        /// <param name="stepAmount">The step size required to trigger condition.</param>
+        /// <param name="initialValue">The initial value to step from.</param>
+        /// <returns>A property condition function object.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public static PropertyCondition Step(float stepAmount, float initialValue)
         {
             PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.StepCondition__SWIG_0(stepAmount, initialValue), true);
@@ -150,10 +171,12 @@ namespace Tizen.NUI
             return ret;
         }
 
-        ///<summary>
+        /// <summary>
         /// Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.
-        ///</summary>
-        ///<since_tizen> 4 </since_tizen>
+        /// </summary>
+        /// <param name="stepAmount">List of values to receive notifications for as a property crosses them.</param>
+        /// <returns>A property condition function object.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public static PropertyCondition Step(float stepAmount)
         {
             PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.StepCondition__SWIG_1(stepAmount), true);