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.

Sign up for GitHub

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

Jump to bottom

Fix up handling for non-generic Task and ValueTask #61085

Closed
wants to merge 1 commit into from
Closed

Fix up handling for non-generic Task and ValueTask #61085

wants to merge 1 commit into from

Conversation

captainsafia
Copy link
Member

Closes #61019.

@captainsafia captainsafia requested a review from a team as a code owner March 22, 2025 00:55
@dotnet-issue-labeler dotnet-issue-labeler bot added the area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates label Mar 22, 2025
@captainsafia captainsafia added feature-openapi area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc labels Mar 22, 2025
BrennanConroy
BrennanConroy reviewed Mar 24, 2025
View reviewed changes
src/OpenApi/gen/XmlComments/MemberKey.cs
{
actualReturnType = compilation.GetSpecialType(SpecialType.System_Void);
}
actualReturnType = namedType.ConstructedFrom;
Copy link
Member

Choose a reason for hiding this comment

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

Was trying to understand what exactly this did, and why we couldn't just get rid of this check since ReplaceGenericArguments below should handle Task<T>.
Looks like ConstructedFrom would return Task<int> if you had a type like Example : Task<int>. Is that the desired effect? We should probably add a test like that.

We also have tests for Task and Task<T>

aspnetcore/src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/snapshots/CompletenessTests.SupportsAllXmlTagsOnSchemas#OpenApiXmlCommentSupport.generated.verified.cs

Lines 274 to 276 in 394df7a

_cache.Add(new MemberKey(typeof(global::ExampleClass), MemberType.Method, "AddAsync", typeof(global::System.Threading.Tasks.Task<>), [typeof(global::System.Int32), typeof(global::System.Int32)]), new XmlComment(@"This method is an example of a method that
returns an awaitable item.", null, null, null, null, false, null, null, null));
_cache.Add(new MemberKey(typeof(global::ExampleClass), MemberType.Method, "DoNothingAsync", typeof(global::System.Threading.Tasks.Task), []), new XmlComment(@"This method is an example of a method that

So not too sure what was broken.

@captainsafia
Copy link
Member Author

Closing in favor of #61145.

@dotnet-policy-service dotnet-policy-service bot added this to the 10.0-preview4 milestone Mar 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BrennanConroy BrennanConroy BrennanConroy left review comments

@martincostello martincostello martincostello approved these changes

Assignees
No one assigned
Labels
area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates feature-openapi
Projects
None yet
Milestone
10.0-preview4
Development

Successfully merging this pull request may close these issues.

[10-preview.2] CS0673 error from XmlCommentGenerator
3 participants
@captainsafia @martincostello @BrennanConroy