From f81b773062cb39bab718355f4c5470ec3217720a Mon Sep 17 00:00:00 2001 From: "wenfeng.ge" Date: Fri, 31 Mar 2017 10:57:32 +0800 Subject: [PATCH] Add and update API comments for ElmSharp Calendar.cs | ColorSelector.cs Change-Id: I9f41244f591bfc2d7ab40cb3ac19c5d1863fc535 --- src/ElmSharp/ElmSharp/Calendar.cs | 62 +++++++++++++++++++++++++++------- src/ElmSharp/ElmSharp/ColorSelector.cs | 2 +- 2 files changed, 50 insertions(+), 14 deletions(-) mode change 100644 => 100755 src/ElmSharp/ElmSharp/Calendar.cs diff --git a/src/ElmSharp/ElmSharp/Calendar.cs b/src/ElmSharp/ElmSharp/Calendar.cs old mode 100644 new mode 100755 index b388c9e..f6d96c2 --- a/src/ElmSharp/ElmSharp/Calendar.cs +++ b/src/ElmSharp/ElmSharp/Calendar.cs @@ -22,31 +22,61 @@ using System.Runtime.InteropServices; namespace ElmSharp { /// - /// Event periodicity, used to define if a mark should be repeated beyond event's day. It's set when a mark is added. + /// Enumeration for event periodicity, used to define if a mark should be repeated beyond event's day. It's set when a mark is added. /// public enum CalendarMarkRepeatType { - Unique, ///Default value. Marks will be displayed only on event day. - Daily, ///Marks will be displayed every day after event day. - Weekly, ///Marks will be displayed every week after event day. - Monthly, ///Marks will be displayed every month day that coincides to event day. - Annually, ///Marks will be displayed every year that coincides to event day. - LastDayOfMonth ///Marks will be displayed every last day of month after event day. + /// + /// Default value. Marks will be displayed only on event day. + /// + Unique, + /// + /// Marks will be displayed every day after event day. + /// + Daily, + /// + /// Marks will be displayed every week after event day. + /// + Weekly, + /// + /// Marks will be displayed every month day that coincides to event day. + /// + Monthly, + /// + /// Marks will be displayed every year that coincides to event day. + /// + Annually, + /// + /// Marks will be displayed every last day of month after event day. + /// + LastDayOfMonth } /// - /// The mode, who determine how user could select a day + /// Enumeration for the mode, which determine how user could select a day. /// public enum CalendarSelectMode { - Default, ///Default value. a day is always selected. - Always, ///a day is always selected. - None, ///None of the days can be selected. - OnDemand ///User may have selected a day or not. + /// + /// Default value. a day is always selected. + /// + Default, + /// + /// A day is always selected. + /// + Always, + /// + /// None of the days can be selected. + /// + None, + /// + /// User may have selected a day or not. + /// + OnDemand } /// - /// Item for a calendar mark. + /// The CalendarMark is a Item for marking a Calendar's type,date and repeat type. /// public class CalendarMark { @@ -67,6 +97,12 @@ namespace ElmSharp /// public CalendarMarkRepeatType Repeat; + /// + /// Creates and initializes a new instance of the CalendarMark class. + /// + /// Type of mark + /// Date of inclusion of the mark + /// Repeat type public CalendarMark(string type, DateTime date, CalendarMarkRepeatType repeat) { Handle = IntPtr.Zero; diff --git a/src/ElmSharp/ElmSharp/ColorSelector.cs b/src/ElmSharp/ElmSharp/ColorSelector.cs index 2a40ca1..ed5a225 100755 --- a/src/ElmSharp/ElmSharp/ColorSelector.cs +++ b/src/ElmSharp/ElmSharp/ColorSelector.cs @@ -108,7 +108,7 @@ namespace ElmSharp } /// - /// Gets Alpha of a default Color Class. + /// Gets Alpha of a default Color Class(Value is -1). /// public override int Opacity { -- 2.7.4