Skip to content

Update XML comments to prevent compiler warnings... #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -8,6 +8,6 @@ namespace Microsoft.AspNetCore.Components.QuickGrid;
/// </summary>
/// <typeparam name="TGridItem">The type of data represented by each row in the grid.</typeparam>
/// <param name="request">Parameters describing the data being requested.</param>
/// <returns>A <see cref="ValueTask{GridItemsProviderResult{TResult}}" /> that gives the data to be displayed.</returns>
/// <returns>A <see cref="T:ValueTask{GridItemsProviderResult{TResult}}" /> that gives the data to be displayed.</returns>
public delegate ValueTask<GridItemsProviderResult<TGridItem>> GridItemsProvider<TGridItem>(
GridItemsProviderRequest<TGridItem> request);
Original file line number Diff line number Diff line change
@@ -46,7 +46,7 @@ public static class GridItemsProviderResult
/// </summary>
/// <typeparam name="TGridItem">The type of data represented by each row in the grid.</typeparam>
/// <param name="items">The items being supplied.</param>
/// <param name="totalItemCount">The total numer of items that exist. See <see cref="TotalItemCount"/> for details.</param>
/// <param name="totalItemCount">The total numer of items that exist. See <see cref="GridItemsProviderResult{TGridItem}.TotalItemCount"/> for details.</param>
/// <returns>An instance of <see cref="GridItemsProviderResult{TGridItem}"/>.</returns>
public static GridItemsProviderResult<TGridItem> From<TGridItem>(ICollection<TGridItem> items, int totalItemCount)
=> new GridItemsProviderResult<TGridItem>(items, totalItemCount);
Original file line number Diff line number Diff line change
@@ -79,10 +79,10 @@ public partial class QuickGrid<TGridItem> : IAsyncDisposable
/// unique identifier, such as a primary key value, for each data item.
///
/// This allows the grid to preserve the association between row elements and data items based on their
/// unique identifiers, even when the <see cref="TGridItem"/> instances are replaced by new copies (for
/// unique identifiers, even when the <typeparamref name="TGridItem"/> instances are replaced by new copies (for
/// example, after a new query against the underlying data store).
///
/// If not set, the @key will be the <see cref="TGridItem"/> instance itself.
/// If not set, the @key will be the <typeparamref name="TGridItem"/> instance itself.
/// </summary>
[Parameter] public Func<TGridItem, object> ItemKey { get; set; } = x => x!;