Skip to content

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?

@dotnet-policy-service
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
Contributor

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
Contributor

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
Contributor

@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 <[email protected]>
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