Release 4.0.0-preview1-00235
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / RelativeVector3.cs
index d83d7b0..46d7e8f 100755 (executable)
@@ -20,8 +20,8 @@ namespace Tizen.NUI
 {
 
     /// <summary>
-    /// RelativeVector3 is a three dimensional vector.
-    /// All values(x, y, z and w) should be between [0, 1].
+    /// RelativeVector3 is a three-dimensional vector.
+    /// All values (x, y, z and w) should be between [0, 1].
     /// </summary>
     public class RelativeVector3 : global::System.IDisposable
     {
@@ -104,11 +104,11 @@ namespace Tizen.NUI
 
 
         /// <summary>
-        /// Addition operator.
+        /// The addition operator.
         /// </summary>
-        /// <param name="arg1">Vector to add</param>
-        /// <param name="arg2">Vector to add</param>
-        /// <returns>A vector containing the result of the addition</returns>
+        /// <param name="arg1">The vector to add.</param>
+        /// <param name="arg2">Th vector to add.</param>
+        /// <returns>The vector containing the result of the addition.</returns>
         public static RelativeVector3 operator +(RelativeVector3 arg1, RelativeVector3 arg2)
         {
             RelativeVector3 result = arg1.Add(arg2);
@@ -117,11 +117,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Subtraction operator.
+        /// The subtraction operator.
         /// </summary>
-        /// <param name="arg1">Vector to subtract</param>
-        /// <param name="arg2">Vector to subtract</param>
-        /// <returns>A vector containing the result of the subtraction</returns>
+        /// <param name="arg1">The vector to subtract.</param>
+        /// <param name="arg2">The vector to subtract.</param>
+        /// <returns>The vector containing the result of the subtraction.</returns>
         public static RelativeVector3 operator -(RelativeVector3 arg1, RelativeVector3 arg2)
         {
             RelativeVector3 result = arg1.Subtract(arg2);
@@ -130,11 +130,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Multiplication operator.
+        /// The multiplication operator.
         /// </summary>
-        /// <param name="arg1">The vector to multiply</param>
-        /// <param name="arg2">The vector to multiply</param>
-        /// <returns>A vector containing the result of the multiplication</returns>
+        /// <param name="arg1">The vector to multiply.</param>
+        /// <param name="arg2">The vector to multiply.</param>
+        /// <returns>The vector containing the result of the multiplication.</returns>
         public static RelativeVector3 operator *(RelativeVector3 arg1, RelativeVector3 arg2)
         {
             RelativeVector3 result = arg1.Multiply(arg2);
@@ -143,11 +143,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Multiplication operator.
+        /// The multiplication operator.
         /// </summary>
-        /// <param name="arg1">The vector to multiply</param>
-        /// <param name="arg2">The float value to scale the vector</param>
-        /// <returns>A vector containing the result of the scaling</returns>
+        /// <param name="arg1">The vector to multiply.</param>
+        /// <param name="arg2">The float value to scale the vector.</param>
+        /// <returns>The vector containing the result of the scaling.</returns>
         public static RelativeVector3 operator *(RelativeVector3 arg1, float arg2)
         {
             RelativeVector3 result = arg1.Multiply(arg2);
@@ -156,11 +156,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Division operator.
+        /// The division operator.
         /// </summary>
-        /// <param name="arg1">The vector to divide</param>
-        /// <param name="arg2">The vector to divide</param>
-        /// <returns>A vector containing the result of the division</returns>
+        /// <param name="arg1">The vector to divide.</param>
+        /// <param name="arg2">The vector to divide.</param>
+        /// <returns>The vector containing the result of the division.</returns>
         public static RelativeVector3 operator /(RelativeVector3 arg1, RelativeVector3 arg2)
         {
             RelativeVector3 result = arg1.Divide(arg2);
@@ -169,11 +169,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Division operator.
+        /// The division operator.
         /// </summary>
-        /// <param name="arg1">The vector to divide</param>
-        /// <param name="arg2">The float value to scale the vector by</param>
-        /// <returns>A vector containing the result of the scaling</returns>
+        /// <param name="arg1">The vector to divide.</param>
+        /// <param name="arg2">The float value to scale the vector by.</param>
+        /// <returns>The vector containing the result of the scaling.</returns>
         public static RelativeVector3 operator /(RelativeVector3 arg1, float arg2)
         {
             RelativeVector3 result = arg1.Divide(arg2);
@@ -183,10 +183,10 @@ namespace Tizen.NUI
 
 
         /// <summary>
-        /// Const array subscript operator overload. Should be 0, 1 or 2.
+        /// The const array subscript operator overload. Should be 0, 1 or 2.
         /// </summary>
-        /// <param name="index">Subscript index</param>
-        /// <returns>The float at the given index</returns>
+        /// <param name="index">The subscript index.</param>
+        /// <returns>The float at the given index.</returns>
         public float this[uint index]
         {
             get
@@ -206,7 +206,7 @@ namespace Tizen.NUI
 
 
         /// <summary>
-        /// Constructor
+        /// The constructor.
         /// </summary>
         public RelativeVector3() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true)
         {
@@ -214,11 +214,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Constructor
+        /// The constructor.
         /// </summary>
-        /// <param name="x">x component</param>
-        /// <param name="y">y component</param>
-        /// <param name="z">z component</param>
+        /// <param name="x">The x component.</param>
+        /// <param name="y">The y component.</param>
+        /// <param name="z">The z component.</param>
         public RelativeVector3(float x, float y, float z) : this(NDalicPINVOKE.new_Vector3__SWIG_1(x, y, z), true)
         {
             ValueCheck(x);
@@ -228,18 +228,18 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Constructor
+        /// The constructor.
         /// </summary>
-        /// <param name="relativeVector2">RelativeVector2 to create this vector from</param>
+        /// <param name="relativeVector2">The RelativeVector2 to create this vector from.</param>
         public RelativeVector3(RelativeVector2 relativeVector2) : this(NDalicPINVOKE.new_Vector3__SWIG_3(RelativeVector2.getCPtr(relativeVector2)), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
         /// <summary>
-        /// Constructor
+        /// The constructor.
         /// </summary>
-        /// <param name="relativeVector4">RelativeVector4 to create this vector from</param>
+        /// <param name="relativeVector4">The RelativeVector4 to create this vector from.</param>
         public RelativeVector3(RelativeVector4 relativeVector4) : this(NDalicPINVOKE.new_Vector3__SWIG_4(RelativeVector4.getCPtr(relativeVector4)), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -296,10 +296,10 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Compare if rhs is equal to
+        /// Compares if the rhs is equal to.
         /// </summary>
-        /// <param name="rhs">The vector to compare</param>
-        /// <returns>Returns true if the two vectors are equal, otherwise false</returns>
+        /// <param name="rhs">The vector to compare.</param>
+        /// <returns>Returns true if the two vectors are equal, otherwise false.</returns>
         public bool EqualTo(RelativeVector3 rhs)
         {
             bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, RelativeVector3.getCPtr(rhs));
@@ -308,10 +308,10 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Compare if rhs is not equal to
+        /// Compares if the rhs is not equal to.
         /// </summary>
-        /// <param name="rhs">The vector to compare</param>
-        /// <returns>Returns true if the two vectors are not equal, otherwise false</returns>
+        /// <param name="rhs">The vector to compare.</param>
+        /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
         public bool NotEqualTo(RelativeVector3 rhs)
         {
             bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, RelativeVector3.getCPtr(rhs));
@@ -321,7 +321,7 @@ namespace Tizen.NUI
 
 
         /// <summary>
-        /// x component
+        /// The x component.
         /// </summary>
         public float X
         {
@@ -340,7 +340,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// y component
+        /// The y component.
         /// </summary>
         public float Y
         {
@@ -359,7 +359,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// z component
+        /// The z component.
         /// </summary>
         public float Z
         {