Enhance documents for ColorSelector and DropdownList 77/122677/3
authorjh5.cho <jh5.cho@samsung.com>
Mon, 3 Apr 2017 06:50:08 +0000 (15:50 +0900)
committerjh5.cho <jh5.cho@samsung.com>
Tue, 4 Apr 2017 06:05:51 +0000 (15:05 +0900)
Change-Id: I5d278e01be5af53fb39131dfda77be78e9fd7618
Signed-off-by: jh5.cho <jh5.cho@samsung.com>
Tizen.Xamarin.Forms.Extension/ColorChangedEventArgs.cs
Tizen.Xamarin.Forms.Extension/ColorSelector.cs
Tizen.Xamarin.Forms.Extension/DropdownList.cs

index 98d57cc..a770fe2 100755 (executable)
@@ -1,19 +1,29 @@
-using System;\r
-using Xamarin.Forms;\r
-\r
-namespace Tizen.Xamarin.Forms.Extension\r
-{\r
-    public class ColorChangedEventArgs : EventArgs\r
-    {\r
-        public ColorChangedEventArgs(Color oldColor, Color newColor)\r
-        {\r
-            OldColor = oldColor;\r
-            NewColor = newColor;\r
-        }\r
-\r
-        public Color OldColor { get; private set; }\r
-\r
-        public Color NewColor { get; private set; }\r
-\r
-    }\r
-}
\ No newline at end of file
+using System;
+using Xamarin.Forms;
+
+namespace Tizen.Xamarin.Forms.Extension
+{
+    /// <summary>
+    /// Arguments for the event that is raised when SelectedColor is changed.
+    /// The SelectedColor can be changed by either tapping the color on the palette or setting the color value.
+    /// </summary>
+    public class ColorChangedEventArgs : EventArgs
+    {
+        public ColorChangedEventArgs(Color oldColor, Color newColor)
+        {
+            OldColor = oldColor;
+            NewColor = newColor;
+        }
+
+        /// <summary>
+        /// The old SelectedColor which will be replaced by a newColor momentarily.
+        /// </summary>
+        public Color OldColor { get; private set; }
+
+        /// <summary>
+        /// The new SelectedColor, taking place of an old SelectedColor.
+        /// </summary>
+        public Color NewColor { get; private set; }
+
+    }
+}
index 58e3fa6..f0b0c20 100755 (executable)
@@ -7,6 +7,7 @@ namespace Tizen.Xamarin.Forms.Extension
 {
     /// <summary>
     /// The ColorSelector class allows the user to select a color.
+    /// The colors can be picked by the user from the color set by clicking on individual color items on the palette.
     /// </summary>
     /// <example>
     /// <code>
@@ -23,8 +24,8 @@ namespace Tizen.Xamarin.Forms.Extension
         public static readonly BindableProperty SelectedColorProperty = BindableProperty.Create("SelectedColor", typeof(Color), typeof(ColorSelector), Color.Default, propertyChanged: OnSelectedColorChanged );
 
         /// <summary>
-        /// Get or set current selected color from ColorSelector
-        /// Default value is Color.Default
+        /// Get or set current selected color from ColorSelector.
+        /// Default value is Color.Default.
         /// </summary>
         public Color SelectedColor
         {
@@ -33,7 +34,7 @@ namespace Tizen.Xamarin.Forms.Extension
         }
 
         /// <summary>
-        /// Occurs when the SelectedColor value changes
+        /// Occurs when the SelectedColor value changes.
         /// </summary>
         public event EventHandler<ColorChangedEventArgs> ColorChanged;
 
index 80d9107..074cd67 100755 (executable)
@@ -8,11 +8,13 @@ using Xamarin.Forms;
 namespace Tizen.Xamarin.Forms.Extension
 {
     /// <summary>
-    /// The DropdownList class
+    /// The DropdownList is a button like widget that pops up a list of items(automatically choosing the direction to display) that have a string label.
+    /// It is a convenience widget to avoid the need to do all the piecing together yourself.
+    /// It is intended for a small number of items in the dropdownList menu (no more than 8), though is capable of many more.
     /// </summary>
     /// <example>
     /// <code>
-    /// var dropdownList = new DropdownList()
+    /// var dropdownList = new DropdownList();
     /// dropdownList.ItemSelected += (s, e) =>
     /// {
     ///     Debug.WriteLine("e.Selected Item: " + e.SelectedItem);
@@ -38,8 +40,9 @@ namespace Tizen.Xamarin.Forms.Extension
 
         public static readonly BindableProperty DisplayMemberPathProperty = BindableProperty.Create("DisplayMemberPath", typeof(string), typeof(DropdownList), default(string), propertyChanged: OnDisplayMemberPathChanged);
 
-        /// <summary>\r
-        /// Occurs when an item in the DropdownList is selected.\r
+        /// <summary>
+        /// Occurs when an item in the DropdownList is selected.
+        /// SelectedItemChangedEventArgs will also have the selected item.
         /// </summary>
         public event EventHandler<SelectedItemChangedEventArgs> ItemSelected;