diff --git a/src/DynamicData/Cache/Change.cs b/src/DynamicData/Cache/Change.cs index 494a5eb0e..9593871b3 100644 --- a/src/DynamicData/Cache/Change.cs +++ b/src/DynamicData/Cache/Change.cs @@ -28,7 +28,7 @@ public Change(ChangeReason reason, TKey key, TObject current, int index = -1) /// /// Initializes a new instance of the struct. - /// Constructor for ChangeReason.Move. + /// Constructor for . /// /// The key. /// The current. @@ -70,9 +70,9 @@ public Change(TKey key, TObject current, int currentIndex, int previousIndex) /// Value of the current. /// Value of the previous. /// - /// For ChangeReason.Add, a previous value cannot be specified + /// For , a previous value cannot be specified /// or - /// For ChangeReason.Change, must supply previous value. + /// For , must supply previous value. /// public Change(ChangeReason reason, TKey key, TObject current, in Optional previous, int currentIndex = -1, int previousIndex = -1) : this() @@ -91,7 +91,7 @@ public Change(ChangeReason reason, TKey key, TObject current, in Optional - /// Gets the reason for the change. + /// Gets the reason for the change. /// public ChangeReason Reason { get; } @@ -116,14 +116,14 @@ public Change(ChangeReason reason, TKey key, TObject current, in Optional - /// Gets the previous change. - /// This is only when Reason==ChangeReason.Replace. + /// Gets the item from before the change. + /// This is only when is . /// public Optional Previous { get; } /// - /// Gets the previous change. - /// This is only when Reason==ChangeReason.Update or ChangeReason.Move. + /// Gets the previous index. + /// This is only when is or . /// public int PreviousIndex { get; } diff --git a/src/DynamicData/List/Change.cs b/src/DynamicData/List/Change.cs index 3647dccc9..07e830ae6 100644 --- a/src/DynamicData/List/Change.cs +++ b/src/DynamicData/List/Change.cs @@ -47,7 +47,7 @@ public Change(ListChangeReason reason, IEnumerable items, int index = -1) /// /// Initializes a new instance of the class. - /// Constructor for ChangeReason.Move. + /// Constructor for . /// /// The current. /// The CurrentIndex. @@ -84,25 +84,27 @@ public Change(T current, int currentIndex, int previousIndex) /// Value of the current. /// Value of the previous. /// - /// For ChangeReason.Add, a previous value cannot be specified + /// For , a previous value cannot be specified /// or - /// For ChangeReason.Change, must supply previous value. + /// For , must supply previous value. + /// or + /// For , must supply an index. /// public Change(ListChangeReason reason, T current, in Optional previous, int currentIndex = -1, int previousIndex = -1) { if (reason == ListChangeReason.Add && previous.HasValue) { - throw new ArgumentException("For ChangeReason.Add, a previous value cannot be specified"); + throw new ArgumentException("For ListChangeReason.Add, a previous value cannot be specified"); } if (reason == ListChangeReason.Replace && !previous.HasValue) { - throw new ArgumentException("For ChangeReason.Replace, must supply previous value"); + throw new ArgumentException("For ListChangeReason.Replace, must supply previous value"); } if (reason == ListChangeReason.Refresh && currentIndex < 0) { - throw new ArgumentException("For ChangeReason.Refresh, must supply an index"); + throw new ArgumentException("For ListChangeReason.Refresh, must supply an index"); } Reason = reason; diff --git a/src/DynamicData/List/ItemChange.cs b/src/DynamicData/List/ItemChange.cs index 6d79a57e3..4b7d31a46 100644 --- a/src/DynamicData/List/ItemChange.cs +++ b/src/DynamicData/List/ItemChange.cs @@ -67,14 +67,14 @@ public ItemChange(ListChangeReason reason, T current, int currentIndex) public int CurrentIndex { get; } /// - /// Gets the previous change. - /// This is only when Reason==ChangeReason.Replace. + /// Gets the item from before the change. + /// This is only when is . /// public Optional Previous { get; } /// /// Gets the previous index. - /// This is only when Reason==ChangeReason.Replace or ChangeReason.Move. + /// This is only when is or . /// public int PreviousIndex { get; } diff --git a/src/DynamicData/List/RangeChange.cs b/src/DynamicData/List/RangeChange.cs index c056308f3..4abef195e 100644 --- a/src/DynamicData/List/RangeChange.cs +++ b/src/DynamicData/List/RangeChange.cs @@ -63,7 +63,7 @@ private RangeChange() public IEnumerator GetEnumerator() => _items.GetEnumerator(); /// - /// Inserts the item in the range at the specified index. + /// Inserts the item in the range at the specified index. /// /// The index. /// The item.