Skip to content

Commit

Permalink
Extend descriptions of ObservableChangeSet methods (#292)
Browse files Browse the repository at this point in the history 
Added description of the special difference between the ToObservableChangeSet and AsObservableChangeSet methods
  • Loading branch information
@lexisstv @RolandPheasant
lexisstv authored and RolandPheasant committed Oct 21, 2019
1 parent 928e4e2 commit 1834f51
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 17 deletions.
9 changes: 6 additions & 3 deletions src/DynamicData/Binding/BindingListEx.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ namespace DynamicData.Binding
public static class BindingListEx
{
/// <summary>
/// Convert a binding list into an observable change set
/// Convert a binding list into an observable change set.
/// Change set observes list change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand All @@ -34,7 +35,8 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this BindingLi
}

/// <summary>
/// Convert a binding list into an observable change set
/// Convert a binding list into an observable change set.
/// Change set observes list change events.
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
Expand All @@ -60,7 +62,8 @@ public static IObservable<IChangeSet<TObject, TKey>> ToObservableChangeSet<TObje
}

/// <summary>
/// Convert a binding list into an observable change set
/// Convert a binding list into an observable change set.
/// Change set observes list change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <typeparam name="TCollection"></typeparam>
Expand Down
15 changes: 10 additions & 5 deletions src/DynamicData/Binding/ObservableCollectionEx.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ namespace DynamicData.Binding
public static class ObservableCollectionEx
{
/// <summary>
/// Convert an observable collection into an observable change set
/// Convert an observable collection into an observable change set.
/// Change set observes collection change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand All @@ -35,7 +36,8 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this Observabl
}

/// <summary>
/// Convert an observable collection into an observable change set
/// Convert an observable collection into an observable change set.
/// Change set observes collection change events.
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
Expand All @@ -61,7 +63,8 @@ public static IObservable<IChangeSet<TObject, TKey>> ToObservableChangeSet<TObje
}

/// <summary>
/// Convert the readonly observable collection into an observable change set
/// Convert the readonly observable collection into an observable change set.
/// Change set observes collection change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand All @@ -78,7 +81,8 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this ReadOnlyO
}

/// <summary>
/// Convert the readonly observable collection into an observable change set
/// Convert the readonly observable collection into an observable change set.
/// Change set observes collection change events.
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
Expand All @@ -104,7 +108,8 @@ public static IObservable<IChangeSet<TObject, TKey>> ToObservableChangeSet<TObje
}

/// <summary>
/// Convert an observable collection into an observable change set
/// Convert an observable collection into an observable change set.
/// Change set observes collection change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <typeparam name="TCollection"></typeparam>
Expand Down
6 changes: 4 additions & 2 deletions src/DynamicData/Cache/ObservableCacheEx.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5076,7 +5076,8 @@ public static IObservableCache<TObject, TKey> AsObservableCache<TObject, TKey>(t
#region Populate changetset from observables

/// <summary>
/// Converts the observable to an observable changeset
/// Converts the observable to an observable changeset.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
Expand Down Expand Up @@ -5110,7 +5111,8 @@ public static IObservable<IChangeSet<TObject, TKey>> ToObservableChangeSet<TObje
}

/// <summary>
/// Converts the observable to an observable changeset
/// Converts the observable to an observable changeset.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
Expand Down
6 changes: 4 additions & 2 deletions src/DynamicData/EnumerableEx.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ public static class EnumerableEx
#region Populate changeset from standard enumerable

/// <summary>
/// Converts the enumerable to an observable changeset
/// Converts the enumerable to an observable changeset.
/// Generates a snapshot in time based of enumerable.
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
Expand Down Expand Up @@ -64,7 +65,8 @@ public static IObservable<IChangeSet<TObject, TKey>> AsObservableChangeSet<TObje
#region Populate change set from standard enumerable

/// <summary>
/// Converts the enumerable to an observable changeset
/// Converts the enumerable to an observable changeset.
/// Generates a snapshot in time based of enumerable.
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand Down
18 changes: 13 additions & 5 deletions src/DynamicData/List/ObservableListEx.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public static class ObservableListEx

/// <summary>
/// Converts the observable to an observable changeset.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand All @@ -53,7 +54,8 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this IObservab
}

/// <summary>
/// Converts the observable to an observable changeset, allowing time expiry to be specified
/// Converts the observable to an observable changeset, allowing time expiry to be specified.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand Down Expand Up @@ -82,6 +84,7 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this IObservab

/// <summary>
/// Converts the observable to an observable changeset, with a specified limit of how large the list can be.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand All @@ -104,7 +107,8 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this IObservab
}

/// <summary>
/// Converts the observable to an observable changeset, allowing size and time limit to be specified
/// Converts the observable to an observable changeset, allowing size and time limit to be specified.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand All @@ -130,6 +134,7 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this IObservab

/// <summary>
/// Converts the observable to an observable changeset.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand All @@ -145,7 +150,8 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this IObservab
}

/// <summary>
/// Converts the observable to an observable changeset, allowing size and time limit to be specified
/// Converts the observable to an observable changeset, allowing size and time limit to be specified.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand All @@ -163,7 +169,8 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this IObservab
}

/// <summary>
/// Converts the observable to an observable changeset, allowing size to be specified
/// Converts the observable to an observable changeset, allowing size to be specified.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand All @@ -181,7 +188,8 @@ public static IObservable<IChangeSet<T>> ToObservableChangeSet<T>(this IObservab
}

/// <summary>
/// Converts the observable to an observable changeset, allowing size and time limit to be specified
/// Converts the observable to an observable changeset, allowing size and time limit to be specified.
/// Change set observes observable change events.
/// </summary>
/// <typeparam name="T">The type of the object.</typeparam>
/// <param name="source">The source.</param>
Expand Down

0 comments on commit 1834f51

Please sign in to comment.