Update description of FloatingButton 03/121003/1
authorsung-su.kim <sung-su.kim@samsung.com>
Mon, 27 Mar 2017 04:34:06 +0000 (13:34 +0900)
committersung-su.kim <sung-su.kim@samsung.com>
Mon, 27 Mar 2017 04:34:06 +0000 (13:34 +0900)
Change-Id: I5828a9b3528398f221133ea23d56fefebe21916d

Tizen.Xamarin.Forms.Extension/FloatingButton.cs
Tizen.Xamarin.Forms.Extension/FloatingButtonItem.cs
Tizen.Xamarin.Forms.Extension/FloatingButtonMovablePosition.cs

index 88b21a1..17b5626 100644 (file)
@@ -4,7 +4,7 @@ using Xamarin.Forms;
 namespace Tizen.Xamarin.Forms.Extension
 {
     /// <summary>
-    /// The FloatingButton class
+    /// The FloatingButton class.
     /// This is only supported for mobile profiles.
     /// </summary>
     /// <example>
@@ -53,7 +53,7 @@ namespace Tizen.Xamarin.Forms.Extension
         }
 
         /// <summary>
-        /// Gets the horizontal position of the FloatingButton. This is a bindable property
+        /// Gets the horizontal position of the FloatingButton. This is a bindable property.
         /// </summary>
         public FloatingButtonPosition Position
         {
@@ -70,7 +70,7 @@ namespace Tizen.Xamarin.Forms.Extension
         }
 
         /// <summary>
-        /// Gets and sets the internal button of the FloatingButton
+        /// Gets and sets the internal button of the FloatingButton.
         /// </summary>
         public FloatingButtonItem FirstButton
         {
@@ -79,7 +79,7 @@ namespace Tizen.Xamarin.Forms.Extension
         }
 
         /// <summary>
-        /// Gets and sets the internal button of the FloatingButton
+        /// Gets and sets the internal button of the FloatingButton.
         /// </summary>
         public FloatingButtonItem SecondButton
         {
@@ -90,8 +90,8 @@ namespace Tizen.Xamarin.Forms.Extension
         /// <summary>
         /// Sets the horizontal position of the FloatingButton.
         /// </summary>
-        /// <param name="position"> FloatingButtonPosition value </param>
-        /// <param name="animated"> Bool value to set the animation when moving the position </param>
+        /// <param name="position"> The destination position of the FloatingButton. </param>
+        /// <param name="animated"> Set the animation when moving the position. </param>
         public void SetPosition(FloatingButtonPosition position, bool animated)
         {
             if (MovablePosition != FloatingButtonMovablePosition.None)
@@ -101,7 +101,7 @@ namespace Tizen.Xamarin.Forms.Extension
         }
 
         /// <summary>
-        /// A method to hide the FloatingButton
+        /// A method to hide the FloatingButton.
         /// </summary>
         public void Hide()
         {
@@ -110,7 +110,7 @@ namespace Tizen.Xamarin.Forms.Extension
         }
 
         /// <summary>
-        /// A method to show the FloatingButton
+        /// A method to show the FloatingButton.
         /// </summary>
         public void Show()
         {
@@ -121,7 +121,7 @@ namespace Tizen.Xamarin.Forms.Extension
         public FloatingButton()
         {
             if (Device.Idiom != TargetIdiom.Phone)
-                throw new Exception("FloatingButton is support only mobile profile.");
+                throw new Exception("FloatingButton is only support mobile profiles.");
 
             _floatingButton = DependencyService.Get<IFloatingButton>(DependencyFetchTarget.GlobalInstance);
 
index 0a25f50..652c720 100644 (file)
@@ -4,7 +4,7 @@ using Xamarin.Forms;
 namespace Tizen.Xamarin.Forms.Extension
 {
     /// <summary>
-    /// A class for containing icons and event information
+    /// The FloatingButtonItem class for containing icons and event information.
     /// </summary>
     public class FloatingButtonItem
     {
@@ -15,7 +15,7 @@ namespace Tizen.Xamarin.Forms.Extension
         }
 
         /// <summary>
-        /// Gets or sets the Icon of the FloatingButtonItem
+        /// Gets or sets the Icon of the FloatingButtonItem.
         /// </summary>
         public FileImageSource Icon
         {
@@ -24,7 +24,7 @@ namespace Tizen.Xamarin.Forms.Extension
         }
 
         /// <summary>
-        /// Occurs when the FloatingButtonItem clicked
+        /// Occurs when the FloatingButtonItem clicked.
         /// </summary>
         public event EventHandler Clicked;
 
index ef9f67c..7dedc6b 100644 (file)
@@ -9,22 +9,22 @@
 namespace Tizen.Xamarin.Forms.Extension
 {
     /// <summary>
-    /// Enumerates values that describe the Mode of FloatingButton.
+    /// Enumerates values that describe the MovablePosition of FloatingButton.
     /// </summary>
     public enum FloatingButtonMovablePosition
     {
         /// <summary>
-        /// allows all positions
+        /// Allows the FloatingButton can be placed in all FloatingButtonPosition.
         /// </summary>
         All,
 
         /// <summary>
-        /// allows LEFT and RIGHT positions only
+        /// Allows the FloatingButton can be placed in only LEFT and RIGHT FloatingButtonPosition.
         /// </summary>
         LeftRightOnly,
 
         /// <summary>
-        /// movement blocked
+        /// Blocks movement of the FloatingButton.
         /// </summary>
         None,
     }