Skip to content
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

QuickGrid API docs missing #52466

Closed
1 task done
guardrex opened this issue Nov 29, 2023 · 8 comments
Closed
1 task done

QuickGrid API docs missing #52466

guardrex opened this issue Nov 29, 2023 · 8 comments
Assignees
Labels
area-blazor Includes: Blazor, Razor Components Docs This issue tracks updating documentation feature-blazor-quickgrid
Milestone

Comments

@guardrex
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe the problem.

API docs aren't available for https://github.com/dotnet/aspnetcore/tree/release/8.0/src/Components/QuickGrid/Microsoft.AspNetCore.Components.QuickGrid ...

https://learn.microsoft.com/en-us/dotnet/api/?term=Microsoft.AspNetCore.Components.QuickGrid

Describe the solution you'd like

API docs for cross-linking in Blazor articles

Additional context

No response

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-blazor Includes: Blazor, Razor Components label Nov 29, 2023
@javiercn javiercn added the Docs This issue tracks updating documentation label Nov 30, 2023
@javiercn javiercn added this to the 8.0.x milestone Dec 15, 2023
@javiercn
Copy link
Member

This is about the XML comments not being produced/published, parking this in 8.0.x to patch

@mkArtakMSFT
Copy link
Member

@wtgodbe can you please handle this? Thanks!

@wtgodbe
Copy link
Member

wtgodbe commented Jan 3, 2024

@Rick-Anderson do you know why the xml doc comments aren't getting published as docs? We do have the comments in src, e.g.

/// <summary>
/// A callback that provides data for a <see cref="QuickGrid{TGridItem}"/>.
/// </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}" /> that gives the data to be displayed.</returns>

@wtgodbe
Copy link
Member

wtgodbe commented Jan 31, 2024

@Rick-Anderson any idea what we need to do here?

@Rick-Anderson
Copy link
Contributor

@v-alje I opened this workitem to track publishing.

@v-alje
Copy link

v-alje commented Jan 31, 2024

What is the NuGet package name?

@guardrex
Copy link
Contributor Author

@v-alje ... It's Microsoft.AspNetCore.Components.QuickGrid ...

https://www.nuget.org/packages/Microsoft.AspNetCore.Components.QuickGrid

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-blazor Includes: Blazor, Razor Components Docs This issue tracks updating documentation feature-blazor-quickgrid
Projects
Status: Done
Development

No branches or pull requests

9 participants