Backport API docs for System.Buffers #51296
Conversation
jeffhandley
added
documentation
|
Tagging subscribers to this area: @tannergooding, @pgovind, @GrabYourPitchforks Issue DetailsFixes #48967, backporting the API docs for
|
| /// <summary> | ||
| /// Owner of Memory<typeparamref name="T"/> that is responsible for disposing the underlying memory appropriately. | ||
| /// </summary> | ||
| #pragma warning disable CS1574 // XML comment has cref attribute that could not be resolved (System.Buffers.MemoryPool{T}.Rent) |
There was a problem hiding this comment.
This was a little interesting. System.Buffers.MemoryPool<T> isn't visible within the System.Buffers build because of it coming from System.Private.CoreLib. Retaining the <see cref> reference to it seemed valuable though. If we see enough of these situations, it would be possible for the DocsPortingTool to detect this situation and apply the #pragma automatically.
|
@carlossanlop I'm not sure that enabling doc generation is working as expected for this library. This project is odd in that all of the types are defined in files included in |
|
I'm going to close this PR for now. I'll revisit this port after we've gotten some other libraries ported that don't have the same complications as Buffers. |
ghost
locked as resolved and limited conversation to collaborators
Fixes #48967, backporting the API docs for
System.Buffers. This port utilizes changes to the DocsPortingTool from a couple of open PRs so that generic APIs are handled properly.