Skip to content

Add xmldocs to generated metadata projects #9868

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

MattKotsenas
Copy link
Member

@MattKotsenas MattKotsenas commented Jun 13, 2025

Description

Add xmldocs to the generated metadata files to prevent CS1591 warnings in projects that have documentation generation enabled.

To test the change, I added a reference to Verify. Verify adds an implicit using for Xunit, which then means dropping using Xunit throughout the project to avoid IDE0005 errors.

Fixes #9197

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?

@Copilot Copilot AI review requested due to automatic review settings June 13, 2025 02:14
@MattKotsenas MattKotsenas requested a review from mitchdenny as a code owner June 13, 2025 02:14
@github-actions github-actions bot added the area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication label Jun 13, 2025
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Jun 13, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds XML documentation to generated metadata classes to suppress CS1591 warnings and updates the test project to use Verify for implicit Xunit imports.

  • Inject XML doc comments into the generated .targets output for project metadata classes
  • Remove explicit using Xunit; directives now covered by Verify’s implicit usings
  • Add Verify.XunitV3 package reference to the test project

Reviewed Changes

Copilot reviewed 70 out of 70 changed files in this pull request and generated no comments.

File Description
src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.in.targets Added <summary> XML comments for generated metadata classes and properties
tests/Aspire.Hosting.Tests/Aspire.Hosting.Tests.csproj Introduced Verify.XunitV3 package reference
tests/Aspire.Hosting.Tests/**/*.cs Removed redundant using Xunit; imports

@davidfowl
Copy link
Member

I'm looking at fixing this unnecessary using issue

@MattKotsenas
Copy link
Member Author

@davidfowl friendly ping here. Anything I can do to help get this in? Thanks so much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generated project metadata class produces CS1591 warnings if project generates documentation xml
2 participants