Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
99cad37
docs: overhaul XML comments for ObservableListEx extension methods
dwcullop Apr 14, 2026
25e479e
docs: add event tables to remaining list operators
dwcullop Apr 14, 2026
7f7b919
docs: fix review findings in list operator docs
dwcullop Apr 14, 2026
7d044e1
docs: remove internal type names from public XML comments
dwcullop Apr 14, 2026
53eb8c8
docs: replace inline YieldWithoutIndex references with seealso links
dwcullop Apr 14, 2026
d8857ea
docs: link types with see/cref instead of inline code tags
dwcullop Apr 14, 2026
897a19d
docs: add type links to all param descriptions in list operators
dwcullop Apr 14, 2026
ffe39c3
docs: fix CS1712 warning for AutoRefresh typeparam
dwcullop Apr 14, 2026
79a58e9
docs: use see langword for C# keywords (true, false, null)
dwcullop Apr 14, 2026
080f81e
docs: add cross-links from list operators to cache equivalents
dwcullop Apr 14, 2026
2b5544e
Fix param descriptions: proper English with type links
dwcullop Apr 14, 2026
3f3e6d4
Perfect param descriptions: purpose verbs, combined crefs, no redundancy
dwcullop Apr 14, 2026
5d147a5
Fix review findings: dangling prepositions, missing purposes
dwcullop Apr 14, 2026
cc8bddf
Eliminate trailing prepositions in param descriptions
dwcullop Apr 14, 2026
053a4c0
Merge branch 'main' into docs/update-list-xml-comments
dwcullop Apr 17, 2026
3df35b8
Merge branch 'main' into docs/update-list-xml-comments
dwcullop Apr 17, 2026
b50a95e
docs: add bidirectional seealso cross-links for PopulateInto, StartWi…
dwcullop Apr 17, 2026
07bbbcc
Merge branch 'main' into docs/update-list-xml-comments
dwcullop Apr 17, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/DynamicData/Cache/ObservableCacheEx.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
/// </summary>
/// <typeparam name="TObject">The type of items in the cache.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
/// <param name="source">The source <see cref="IObservable{IChangeSet{TObject, TKey}}"/> to observe and adapt.</param>

Check warning on line 36 in src/DynamicData/Cache/ObservableCacheEx.cs

View workflow job for this annotation

GitHub Actions / build

Type parameter declaration must be an identifier not a type. See also error CS0081.

Check warning on line 36 in src/DynamicData/Cache/ObservableCacheEx.cs

View workflow job for this annotation

GitHub Actions / build

XML comment has syntactically incorrect cref attribute 'IObservable{IChangeSet{TObject, TKey}}'
/// <param name="adaptor">The <see cref="IChangeSetAdaptor{TObject, TKey}"/> whose Adapt method is called for each changeset.</param>
/// <returns>An observable that emits the same changesets as <paramref name="source"/>, after the adaptor has processed each one.</returns>
/// <remarks>
Expand Down Expand Up @@ -65,7 +65,7 @@
}

/// <inheritdoc cref="Adapt{TObject, TKey}(IObservable{IChangeSet{TObject, TKey}}, IChangeSetAdaptor{TObject, TKey})"/>
/// <param name="source">The source <see cref="IObservable{ISortedChangeSet{TObject, TKey}}"/> to observe and adapt.</param>

Check warning on line 68 in src/DynamicData/Cache/ObservableCacheEx.cs

View workflow job for this annotation

GitHub Actions / build

Type parameter declaration must be an identifier not a type. See also error CS0081.

Check warning on line 68 in src/DynamicData/Cache/ObservableCacheEx.cs

View workflow job for this annotation

GitHub Actions / build

XML comment has syntactically incorrect cref attribute 'IObservable{ISortedChangeSet{TObject, TKey}}'
/// <param name="adaptor">The <see cref="ISortedChangeSetAdaptor{TObject, TKey}"/> whose Adapt method is called for each changeset.</param>
/// <remarks>This overload operates on <see cref="ISortedChangeSet{TObject, TKey}"/>. Delegates to Rx's <c>Do</c> operator.</remarks>
public static IObservable<IChangeSet<TObject, TKey>> Adapt<TObject, TKey>(this IObservable<ISortedChangeSet<TObject, TKey>> source, ISortedChangeSetAdaptor<TObject, TKey> adaptor)
Expand Down Expand Up @@ -170,8 +170,8 @@
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
/// <param name="source">The source <see cref="IObservable{IChangeSet{TObject, TKey}}"/> to combine.</param>

Check warning on line 173 in src/DynamicData/Cache/ObservableCacheEx.cs

View workflow job for this annotation

GitHub Actions / build

Type parameter declaration must be an identifier not a type. See also error CS0081.

Check warning on line 173 in src/DynamicData/Cache/ObservableCacheEx.cs

View workflow job for this annotation

GitHub Actions / build

XML comment has syntactically incorrect cref attribute 'IObservable{IChangeSet{TObject, TKey}}'
/// <param name="others">The additional <see cref="IObservable{IChangeSet{TObject, TKey}}"/> streams to combine with.</param>

Check warning on line 174 in src/DynamicData/Cache/ObservableCacheEx.cs

View workflow job for this annotation

GitHub Actions / build

Type parameter declaration must be an identifier not a type. See also error CS0081.

Check warning on line 174 in src/DynamicData/Cache/ObservableCacheEx.cs

View workflow job for this annotation

GitHub Actions / build

XML comment has syntactically incorrect cref attribute 'IObservable{IChangeSet{TObject, TKey}}'
/// <returns>An observable which emits change sets.</returns>
/// <exception cref="ArgumentNullException">source or others.</exception>
/// <seealso cref="ObservableListEx.And"/>
Expand Down Expand Up @@ -230,7 +230,7 @@
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
/// <param name="sources">The <see cref="IObservableList{IObservableCache{TObject, TKey}}"/> of changeset streams to combine.</param>

Check warning on line 233 in src/DynamicData/Cache/ObservableCacheEx.cs

View workflow job for this annotation

GitHub Actions / build

XML comment has syntactically incorrect cref attribute 'IObservableList{IObservableCache{TObject, TKey}}'
/// <returns>An observable which emits change sets.</returns>
public static IObservable<IChangeSet<TObject, TKey>> And<TObject, TKey>(this IObservableList<IObservableCache<TObject, TKey>> sources)
where TObject : notnull
Expand Down Expand Up @@ -4224,6 +4224,7 @@
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="destination"/> is <see langword="null"/>.</exception>
/// <seealso cref="PopulateFrom{TObject, TKey}(ISourceCache{TObject, TKey}, IObservable{IEnumerable{TObject}})"/>
/// <seealso cref="AsObservableCache{TObject, TKey}(IObservable{IChangeSet{TObject, TKey}}, bool)"/>
/// <seealso cref="ObservableListEx.PopulateInto{T}(IObservable{IChangeSet{T}}, ISourceList{T})"/>
public static IDisposable PopulateInto<TObject, TKey>(this IObservable<IChangeSet<TObject, TKey>> source, ISourceCache<TObject, TKey> destination)
where TObject : notnull
where TKey : notnull
Expand Down Expand Up @@ -4892,6 +4893,7 @@
/// <typeparam name="TKey">The type of the key.</typeparam>
/// <param name="source">The source <see cref="IObservable{IChangeSet{TObject, TKey}}"/> to prepend an empty changeset to.</param>
/// <returns>An observable that emits an empty changeset first, then all source changesets.</returns>
/// <seealso cref="ObservableListEx.StartWithEmpty{T}(IObservable{IChangeSet{T}})"/>
public static IObservable<IChangeSet<TObject, TKey>> StartWithEmpty<TObject, TKey>(this IObservable<IChangeSet<TObject, TKey>> source)
where TObject : notnull
where TKey : notnull => source.StartWith(ChangeSet<TObject, TKey>.Empty);
Expand Down Expand Up @@ -5102,6 +5104,7 @@
/// <typeparam name="TKey">The type of the key.</typeparam>
/// <param name="source">The source <see cref="IObservable{IChangeSet{TObject, TKey}}"/> to materialize into a collection on each change.</param>
/// <returns>An observable which emits the read only collection.</returns>
/// <seealso cref="ObservableListEx.ToCollection{TObject}(IObservable{IChangeSet{TObject}})"/>
public static IObservable<IReadOnlyCollection<TObject>> ToCollection<TObject, TKey>(this IObservable<IChangeSet<TObject, TKey>> source)
where TObject : notnull
where TKey : notnull => source.QueryWhenChanged(query => new ReadOnlyCollectionLight<TObject>(query.Items));
Expand Down Expand Up @@ -5254,6 +5257,7 @@
/// <param name="sort">The <see cref="Func{TObject, TSortKey}"/> sort function.</param>
/// <param name="sortOrder">The <see cref="SortDirection"/> sort order. Defaults to ascending.</param>
/// <returns>An observable which emits the read only collection.</returns>
/// <seealso cref="ObservableListEx.ToSortedCollection{TObject, TSortKey}(IObservable{IChangeSet{TObject}}, Func{TObject, TSortKey}, SortDirection)"/>
public static IObservable<IReadOnlyCollection<TObject>> ToSortedCollection<TObject, TKey, TSortKey>(this IObservable<IChangeSet<TObject, TKey>> source, Func<TObject, TSortKey> sort, SortDirection sortOrder = SortDirection.Ascending)
where TObject : notnull
where TKey : notnull
Expand Down
Loading