From: Feng Jin <feng16.jin@samsung.com>
Date: Fri, 13 Oct 2017 17:41:37 +0000 (+0800)
Subject: Fis some document errors.
X-Git-Tag: preview1-00301^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F06%2F155506%2F1;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

Fis some document errors.

Change-Id: Ifcd5f5cb6708dcfa51d44ceaa251ad2211b16d54
Signed-off-by: Feng Jin <feng16.jin@samsung.com>
---

diff --git a/src/Tizen.NUI/src/public/ImfManager.cs b/src/Tizen.NUI/src/public/ImfManager.cs
index 11f7091..32b86fd 100755
--- a/src/Tizen.NUI/src/public/ImfManager.cs
+++ b/src/Tizen.NUI/src/public/ImfManager.cs
@@ -21,7 +21,7 @@ using System.ComponentModel;
 namespace Tizen.NUI
 {
     /// <summary>
-    /// Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
+    /// Specifically manages the input method framework which enables the virtual or hardware keyboards.
     /// </summary>
     public class ImfManager : BaseHandle
     {
@@ -1741,7 +1741,7 @@ namespace Tizen.NUI
             /// </summary>
             Preedit,
             /// <summary>
-            /// Commit recieved.
+            /// Commit received.
             /// </summary>
             Commit,
             /// <summary>
diff --git a/src/Tizen.NUI/src/public/Key.cs b/src/Tizen.NUI/src/public/Key.cs
index b3373c8..6ee3284 100755
--- a/src/Tizen.NUI/src/public/Key.cs
+++ b/src/Tizen.NUI/src/public/Key.cs
@@ -88,6 +88,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Dispose.
         /// </summary>
+        /// <param name="type">The dispose type.</param>
         /// <since_tizen> 3 </since_tizen>
         protected virtual void Dispose(DisposeTypes type)
         {
diff --git a/src/Tizen.NUI/src/public/NUIApplication.cs b/src/Tizen.NUI/src/public/NUIApplication.cs
index 08aba06..148c1df 100755
--- a/src/Tizen.NUI/src/public/NUIApplication.cs
+++ b/src/Tizen.NUI/src/public/NUIApplication.cs
@@ -56,16 +56,19 @@ namespace Tizen.NUI
         /// <summary>
         /// The constructor with a stylesheet.
         /// </summary>
+        /// <param name="styleSheet">The styleSheet url.</param>
         /// <since_tizen> 3 </since_tizen>
-        public NUIApplication(string stylesheet) : base(new NUICoreBackend(stylesheet))
+        public NUIApplication(string styleSheet) : base(new NUICoreBackend(styleSheet))
         {
         }
 
         /// <summary>
         /// The constructor with a stylesheet and window mode.
         /// </summary>
+        /// <param name="styleSheet">The styleSheet url.</param>
+        /// <param name="windowMode">The windowMode.</param>
         /// <since_tizen> 3 </since_tizen>
-        public NUIApplication(string stylesheet, WindowMode windowMode) : base(new NUICoreBackend(stylesheet,windowMode))
+        public NUIApplication(string styleSheet, WindowMode windowMode) : base(new NUICoreBackend(styleSheet, windowMode))
         {
         }
 
diff --git a/src/Tizen.NUI/src/public/NUIWidgetApplication.cs b/src/Tizen.NUI/src/public/NUIWidgetApplication.cs
index d341147..daf782b 100755
--- a/src/Tizen.NUI/src/public/NUIWidgetApplication.cs
+++ b/src/Tizen.NUI/src/public/NUIWidgetApplication.cs
@@ -41,8 +41,9 @@ namespace Tizen.NUI
         /// <summary>
         /// The constructor with stylesheet.
         /// </summary>
+        /// <param name="styleSheet">The styleSheet url.</param>
         /// <since_tizen> 4 </since_tizen>
-        public NUIWidgetApplication(string stylesheet) : base(new NUIWidgetCoreBackend(stylesheet))
+        public NUIWidgetApplication(string styleSheet) : base(new NUIWidgetCoreBackend(styleSheet))
         {
             Tizen.Log.Fatal("NUI", "### NUIWidgetApplication(string) called");
         }
diff --git a/src/Tizen.NUI/src/public/Position2D.cs b/src/Tizen.NUI/src/public/Position2D.cs
index 356352a..73f3d98 100755
--- a/src/Tizen.NUI/src/public/Position2D.cs
+++ b/src/Tizen.NUI/src/public/Position2D.cs
@@ -88,6 +88,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Dispose.
         /// </summary>
+        /// <param name="type">The dispose type.</param>
         /// <since_tizen> 3 </since_tizen>
         protected virtual void Dispose(DisposeTypes type)
         {
@@ -378,6 +379,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Converts a Position2D instance to a Vector2 instance.
         /// </summary>
+        /// <param name="position2d">An object of the Position2D type.</param>
+        /// <returns>return an object of the Vector2 type</returns>
         /// <since_tizen> 3 </since_tizen>
         public static implicit operator Vector2(Position2D position2d)
         {
@@ -387,6 +390,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Converts a Vector2 instance to a Position2D instance.
         /// </summary>
+        /// <param name="vec">An object of the Vector2 type.</param>
+        /// <returns>return an object of the Position2D type</returns>
         /// <since_tizen> 3 </since_tizen>
         public static implicit operator Position2D(Vector2 vec)
         {
@@ -396,6 +401,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Converts a Position2D instance to a Uint16Pair instance.
         /// </summary>
+        /// <param name="position2d">An object of the Position2D type.</param>
+        /// <returns>return an object of the Uint16Pair type</returns>
         /// <since_tizen> 4 </since_tizen>
         public static implicit operator Uint16Pair(Position2D position2d)
         {
@@ -405,6 +412,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Converts a Uint16Pair instance to a Position2D instance.
         /// </summary>
+        /// <param name="pair">An object of the Uint16Pair type.</param>
+        /// <returns>return an object of the Position2D type</returns>
         /// <since_tizen> 4 </since_tizen>
         public static implicit operator Position2D(Uint16Pair pair)
         {
diff --git a/src/Tizen.NUI/src/public/PropertyCondition.cs b/src/Tizen.NUI/src/public/PropertyCondition.cs
index 24c255f..5cc2dca 100755
--- a/src/Tizen.NUI/src/public/PropertyCondition.cs
+++ b/src/Tizen.NUI/src/public/PropertyCondition.cs
@@ -82,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()
         {
@@ -89,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);
@@ -100,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);
@@ -111,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);
@@ -122,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);
@@ -133,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);
@@ -144,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);
@@ -155,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);
diff --git a/src/Tizen.NUI/src/public/PropertyNotification.cs b/src/Tizen.NUI/src/public/PropertyNotification.cs
index 4713364..efba44b 100755
--- a/src/Tizen.NUI/src/public/PropertyNotification.cs
+++ b/src/Tizen.NUI/src/public/PropertyNotification.cs
@@ -154,8 +154,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Get property notification from Intptr.
+        /// Get property notification from Intptr.<br/>
+        /// This should be internal, please do not use.
         /// </summary>
+        /// <param name="cPtr">An object of IntPtr type.</param>
+        /// <returns>An object of the PropertyNotification type.</returns>
         /// <since_tizen> 4 </since_tizen>
         public static PropertyNotification GetPropertyNotificationFromPtr(global::System.IntPtr cPtr)
         {
@@ -176,6 +179,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Downcast a PropertyNotification instance.
         /// </summary>
+        /// <param name="handle">Handle to an object of BaseHandle type.</param>
+        /// <returns>Handle to an object of the PropertyNotification type.</returns>
         /// <since_tizen> 4 </since_tizen>
         public static PropertyNotification DownCast(BaseHandle handle)
         {
@@ -196,6 +201,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Assign.
         /// </summary>
+        /// <param name="rhs">A reference to the copied handle.</param>
+        /// <returns>A reference to this.</returns>
         /// <since_tizen> 4 </since_tizen>
         public PropertyNotification Assign(PropertyNotification rhs)
         {
@@ -207,6 +214,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Gets the condition of this notification.
         /// </summary>
+        /// <returns>The condition is returned.</returns>
         /// <since_tizen> 4 </since_tizen>
         public PropertyCondition GetCondition()
         {
@@ -229,6 +237,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Gets the target handle's property index that this notification.
         /// </summary>
+        /// <returns>The target property index.</returns>
         /// <since_tizen> 4 </since_tizen>
         public int GetTargetProperty()
         {
@@ -240,6 +249,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Sets the Notification mode.
         /// </summary>
+        /// <param name="mode">mode Notification mode (Default is PropertyNotification::NotifyOnTrue).</param>
         /// <since_tizen> 4 </since_tizen>
         public void SetNotifyMode(PropertyNotification.NotifyMode mode)
         {
@@ -250,6 +260,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Retrieves the current Notification mode.
         /// </summary>
+        /// <returns>Notification mode.</returns>
         /// <since_tizen> 4 </since_tizen>
         public PropertyNotification.NotifyMode GetNotifyMode()
         {
diff --git a/src/Tizen.NUI/src/public/PropertyNotifySignal.cs b/src/Tizen.NUI/src/public/PropertyNotifySignal.cs
index 9041162..5994505 100755
--- a/src/Tizen.NUI/src/public/PropertyNotifySignal.cs
+++ b/src/Tizen.NUI/src/public/PropertyNotifySignal.cs
@@ -88,6 +88,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Dispose
         /// </summary>
+        /// <param name="type">The dispose type.</param>
         /// <since_tizen> 3 </since_tizen>
         protected virtual void Dispose(DisposeTypes type)
         {
diff --git a/src/Tizen.NUI/src/public/Size2D.cs b/src/Tizen.NUI/src/public/Size2D.cs
index d651b5d..d270f87 100755
--- a/src/Tizen.NUI/src/public/Size2D.cs
+++ b/src/Tizen.NUI/src/public/Size2D.cs
@@ -377,6 +377,7 @@ namespace Tizen.NUI
         /// The type cast operator, Size2D to Vector2.
         /// </summary>
         /// <param name="size">An object of the Size2D type.</param>
+        /// <returns>return a Vector2 instance</returns>
         /// <since_tizen> 3 </since_tizen>
         public static implicit operator Vector2(Size2D size)
         {
@@ -386,17 +387,19 @@ namespace Tizen.NUI
         /// <summary>
         /// The type cast operator, Vector2 to Size2D type.
         /// </summary>
-        /// <param name="vec">An object of the Vector2 type.</param>
+        /// <param name="vector2">An object of the Vector2 type.</param>
+        /// <returns>return a Size2D instance</returns>
         /// <since_tizen> 3 </since_tizen>
-        public static implicit operator Size2D(Vector2 vec)
+        public static implicit operator Size2D(Vector2 vector2)
         {
-            return new Size2D((int)vec.X, (int)vec.Y);
+            return new Size2D((int)vector2.X, (int)vector2.Y);
         }
 
         /// <summary>
         /// The type cast operator, Size2D to Uint16Pair.
         /// </summary>
         /// <param name="size2d">An object of the Size2D type.</param>
+        /// <returns>return a Uint16Pair instance</returns>
         /// <since_tizen> 4 </since_tizen>
         public static implicit operator Uint16Pair(Size2D size2d)
         {
@@ -407,6 +410,7 @@ namespace Tizen.NUI
         /// The type cast operator, Uint16Pair to Size2D type.
         /// </summary>
         /// <param name="pair">An object of the Vector2 type.</param>
+        /// <returns>return a Size2D instance</returns>
         /// <since_tizen> 4 </since_tizen>
         public static implicit operator Size2D(Uint16Pair pair)
         {
diff --git a/src/Tizen.NUI/src/public/Widget.cs b/src/Tizen.NUI/src/public/Widget.cs
index 1b4b693..e4b9956 100755
--- a/src/Tizen.NUI/src/public/Widget.cs
+++ b/src/Tizen.NUI/src/public/Widget.cs
@@ -529,7 +529,7 @@ namespace Tizen.NUI
             /// </summary>
             /// <remark>
             /// 0 -> no force
-            /// 1 -> force but do someting
+            /// 1 -> force but do something
             /// 2 -> force
             /// </remark>
             /// <since_tizen> 4 </since_tizen>
diff --git a/src/Tizen.NUI/src/public/Window.cs b/src/Tizen.NUI/src/public/Window.cs
index 0260096..28c9ee7 100755
--- a/src/Tizen.NUI/src/public/Window.cs
+++ b/src/Tizen.NUI/src/public/Window.cs
@@ -687,6 +687,11 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// Retrieves the layer at a specified depth.
+        /// </summary>
+        /// <param name="depth">The layer's depth index.</param>
+        /// <returns>The layer found at the given depth.</returns>
         /// <since_tizen> 3 </since_tizen>
         public Layer GetLayer(uint depth)
         {