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

Add new API docs for System.Runtime.InteropServices #106208

Merged
merged 2 commits into from
Aug 9, 2024

Conversation

jkoritzinsky
Copy link
Member

Adds the rest of the missing API docs we can put in code from #105986

@carlossanlop the CollectionsMarshal APIs do have docs in source. Do we need to manually port them to dotnet-api-docs?

Copy link
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

@carlossanlop
Copy link
Member

the CollectionsMarshal APIs do have docs in source. Do we need to manually port them to dotnet-api-docs?

@jkoritzinsky Yes, they need them manually ported, because the source of truth is not triple slash comments, but dotnet-api-docs, as indicated by this turned-off property in the csproj:

<UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>

@carlossanlop
Copy link
Member

Note: We can't just turn the property on, because we would need to backport the language-reviewed docs from dotnet-api-docs into runtime first.

@jkoritzinsky
Copy link
Member Author

Okay I'll port the docs over manually after this PR gets in.

Copy link
Member

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

Left some suggestions for you to consider, and aside from that, it looks good.

Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
@jkoritzinsky jkoritzinsky merged commit 2ae5d7a into dotnet:main Aug 9, 2024
154 of 157 checks passed
@jkoritzinsky jkoritzinsky deleted the net9-docs branch August 9, 2024 23:33
@github-actions github-actions bot locked and limited conversation to collaborators Sep 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants