Microsoft.Extensions.Caching.SqlServer docs for .NET 10.0 APIs

[ericstj]

Microsoft.Extensions.Caching.SqlServer docs for .NET 10.0 APIs

Description

This issue tracks the porting of documentation for 6 APIs in the Microsoft.Extensions.Caching.SqlServer namespace that were added in .NET 10.0.

Instructions

Please follow the instructions in the main tracking issue (#120483) for documenting these APIs.

Undocumented APIs

The following APIs need documentation:

SqlServerCache

• M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.SqlServer.SqlServerCacheOptions})
• M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.Microsoft#Extensions#Caching#Distributed#IBufferDistributedCache#Set(System.String,System.Buffers.ReadOnlySequence{System.Byte},Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)
• M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.Microsoft#Extensions#Caching#Distributed#IBufferDistributedCache#SetAsync(System.String,System.Buffers.ReadOnlySequence{System.Byte},Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)
• M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.Microsoft#Extensions#Caching#Distributed#IBufferDistributedCache#TryGet(System.String,System.Buffers.IBufferWriter{System.Byte})
• M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.Microsoft#Extensions#Caching#Distributed#IBufferDistributedCache#TryGetAsync(System.String,System.Buffers.IBufferWriter{System.Byte},System.Threading.CancellationToken)

SqlServerCacheOptions

• M:Microsoft.Extensions.Caching.SqlServer.SqlServerCacheOptions.#ctor

Total APIs to document: 6

[ericstj]

I can confirm that the docs are missing - https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.caching.sqlserver.sqlservercache.-ctor?view=net-10.0-pp

However this assembly builds in ASPNetCore, not runtime https://github.com/dotnet/aspnetcore/tree/318c48149651c804d525eee3bf4287cd5149660b/src/Caching/SqlServer/src

@gewarren, is it correct for it's API docs to be in https://github.com/dotnet/dotnet-api-docs?

[ericstj]

This has a mix of issues - SqlServerCache.#ctor is documented in source and has been for some time. https://github.com/dotnet/aspnetcore/blob/569fc4cb6a48d6c8a2b9c31cb5bb5cfbe67c8599/src/Caching/SqlServer/src/SqlServerCache.cs#L32-L35

I can confirm that the XML in the package contains docs:

<member name="M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.SqlServer.SqlServerCacheOptions})">
<summary>
Initializes a new instance of
<see cref="T:Microsoft.Extensions.Caching.SqlServer.SqlServerCache"/>
.
</summary>
<param name="options">The configuration options.</param>
</member>

SqlServerCacheOptions.#ctor is an implicit constructor, so no docs in source.

IBufferDistributedCache members are explicit interface implementations missing any docs in source.