From 28dd21753c585ccef185e4759d697c73badd8232 Mon Sep 17 00:00:00 2001 From: Charlie Kindel Date: Sat, 6 Jun 2020 14:34:16 -0600 Subject: [PATCH] tweaked API docs for Date/TimeField --- Terminal.Gui/Views/DateField.cs | 20 ++++++++++---------- Terminal.Gui/Views/TimeField.cs | 6 +++--- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/Terminal.Gui/Views/DateField.cs b/Terminal.Gui/Views/DateField.cs index b2f7df16d..ac5563980 100644 --- a/Terminal.Gui/Views/DateField.cs +++ b/Terminal.Gui/Views/DateField.cs @@ -12,7 +12,7 @@ using NStack; namespace Terminal.Gui { /// - /// Date editing + /// Simple Date editing /// /// /// The provides date editing functionality with mouse support. @@ -30,13 +30,13 @@ namespace Terminal.Gui { string Format { get { return isShort ? shortFormat : longFormat; } } /// - /// DateChanged event, raised when the Date has changed. + /// DateChanged event, raised when the property has changed. /// /// - /// This event is raised when the changes. + /// This event is raised when the property changes. /// /// - /// The passed is a containing the old, new value and format. + /// The passed event arguments containing the old value, new value, and format string. /// public event Action> DateChanged; @@ -138,7 +138,7 @@ namespace Terminal.Gui { } /// - /// Get or set the data format for the widget. + /// Get or set the date format for the widget. /// public bool IsShortFormat { get => isShort; @@ -370,9 +370,9 @@ namespace Terminal.Gui { } /// - /// Virtual method that will invoke the with a . + /// Event firing method for the event. /// - /// The arguments of the + /// Event arguments public virtual void OnDateChanged (DateTimeEventArgs args) { DateChanged?.Invoke (args); @@ -380,7 +380,7 @@ namespace Terminal.Gui { } /// - /// Handled the for or events. + /// Defines the event arguments for and events. /// public class DateTimeEventArgs : EventArgs { /// @@ -399,11 +399,11 @@ namespace Terminal.Gui { public string Format { get; } /// - /// Initializes a new instance of + /// Initializes a new instance of /// /// The old or value. /// The new or value. - /// The or format. + /// The or format string. public DateTimeEventArgs (T oldValue, T newValue, string format) { OldValue = oldValue; diff --git a/Terminal.Gui/Views/TimeField.cs b/Terminal.Gui/Views/TimeField.cs index af5141fd5..4ac5c9b49 100644 --- a/Terminal.Gui/Views/TimeField.cs +++ b/Terminal.Gui/Views/TimeField.cs @@ -36,7 +36,7 @@ namespace Terminal.Gui { /// This event is raised when the changes. /// /// - /// The passed is a containing the old, new value and format. + /// The passed is a containing the old value, new value, and format string. /// public event Action> TimeChanged; @@ -288,9 +288,9 @@ namespace Terminal.Gui { } /// - /// Virtual method that will invoke the with a . + /// Event firing method that invokes the event. /// - /// The arguments of the + /// The event arguments public virtual void OnTimeChanged (DateTimeEventArgs args) { TimeChanged?.Invoke (args);