Skip to content

Commit bd1cf13

Browse files
apexvss@microsoft.comgewarren
authored andcommitted
CI Update
Build.Reason:Manual by Genevieve Warren Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=465020&view=results source_repo.branch:net9-rc2 source_repo.url:https://apidrop.visualstudio.com/_git/binaries
1 parent 96107af commit bd1cf13

File tree

104 files changed

+765
-586
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+765
-586
lines changed

xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheEntryExtensions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
</Attributes>
3737
<Docs>
3838
<summary>
39-
Extension methods for <see cref="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions" /> operations.
39+
Provides extension methods for <see cref="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions" /> operations.
4040
</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>

xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheEntryOptions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
</ReturnValue>
116116
<Docs>
117117
<summary>
118-
Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed.
118+
Gets or sets how long a cache entry can be inactive (for example, not accessed) before it will be removed.
119119
This will not extend the entry lifetime beyond the absolute expiration (if set).
120120
</summary>
121121
<value>To be added.</value>

xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,8 @@
132132
Sets a sequence of bytes in the specified cache with the specified key.
133133
</summary>
134134
<remarks>To be added.</remarks>
135-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
135+
<exception cref="T:System.ArgumentNullException">
136+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
136137
</Docs>
137138
</Member>
138139
<Member MemberName="SetAsync">
@@ -167,7 +168,8 @@
167168
<returns>A task that represents the asynchronous set operation.</returns>
168169
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.Set(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.Byte[])" />.</remarks>
169170
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
170-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
171+
<exception cref="T:System.ArgumentNullException">
172+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
171173
</Docs>
172174
</Member>
173175
<Member MemberName="SetString">
@@ -199,7 +201,8 @@
199201
Sets a string in the specified cache with the specified key.
200202
</summary>
201203
<remarks>To be added.</remarks>
202-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
204+
<exception cref="T:System.ArgumentNullException">
205+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
203206
</Docs>
204207
</Member>
205208
<Member MemberName="SetString">
@@ -233,7 +236,8 @@
233236
Sets a string in the specified cache with the specified key.
234237
</summary>
235238
<remarks>To be added.</remarks>
236-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
239+
<exception cref="T:System.ArgumentNullException">
240+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
237241
</Docs>
238242
</Member>
239243
<Member MemberName="SetStringAsync">
@@ -268,7 +272,8 @@
268272
<returns>A task that represents the asynchronous set operation.</returns>
269273
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String)" />.</remarks>
270274
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
271-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
275+
<exception cref="T:System.ArgumentNullException">
276+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
272277
</Docs>
273278
</Member>
274279
<Member MemberName="SetStringAsync">
@@ -305,7 +310,8 @@
305310
<returns>A task that represents the asynchronous set operation.</returns>
306311
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String,Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)" />.</remarks>
307312
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
308-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
313+
<exception cref="T:System.ArgumentNullException">
314+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
309315
</Docs>
310316
</Member>
311317
</Members>

xml/Microsoft.Extensions.Caching.Distributed/IBufferDistributedCache.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
<summary>
7070
Sets or overwrites a cache item.
7171
</summary>
72-
<remarks>This is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)" />, but avoids the array allocation.</remarks>
72+
<remarks>This method is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)" />, but avoids the array allocation.</remarks>
7373
</Docs>
7474
</Member>
7575
<Member MemberName="SetAsync">
@@ -112,7 +112,7 @@
112112
Asynchronously sets or overwrites a cache entry.
113113
</summary>
114114
<returns>To be added.</returns>
115-
<remarks>This is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.SetAsync(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)" />, but avoids the array allocation.</remarks>
115+
<remarks>This method is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.SetAsync(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)" />, but avoids the array allocation.</remarks>
116116
</Docs>
117117
</Member>
118118
<Member MemberName="TryGet">
@@ -142,11 +142,11 @@
142142
<param name="key">The unique key for the cache item.</param>
143143
<param name="destination">The target to write the cache contents on success.</param>
144144
<summary>
145-
Attempt to retrieve an existing cache item.
145+
Attempts to retrieve an existing cache item.
146146
</summary>
147147
<returns>
148148
<c>true</c> if the cache item is found, <c>false</c> otherwise.</returns>
149-
<remarks>This is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Get(System.String)" />, but avoids the array allocation.</remarks>
149+
<remarks>This method is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Get(System.String)" />, but avoids the array allocation.</remarks>
150150
</Docs>
151151
</Member>
152152
<Member MemberName="TryGetAsync">
@@ -183,11 +183,11 @@
183183
<param name="destination">The target to write the cache contents on success.</param>
184184
<param name="token">The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
185185
<summary>
186-
Asynchronously attempt to retrieve an existing cache entry.
186+
Asynchronously attempts to retrieve an existing cache entry.
187187
</summary>
188188
<returns>
189189
<c>true</c> if the cache entry is found, <c>false</c> otherwise.</returns>
190-
<remarks>This is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.GetAsync(System.String,System.Threading.CancellationToken)" />, but avoids the array allocation.</remarks>
190+
<remarks>This method is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.GetAsync(System.String,System.Threading.CancellationToken)" />, but avoids the array allocation.</remarks>
191191
</Docs>
192192
</Member>
193193
</Members>

xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
</Attributes>
4141
<Docs>
4242
<summary>
43-
An implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" /> using <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache" />.
43+
Implements <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" /> using <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache" />.
4444
</summary>
4545
<remarks>To be added.</remarks>
4646
</Docs>

xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
<Docs>
116116
<typeparam name="T">The type of the data being considered.</typeparam>
117117
<param name="key">The key of the entry to look for or create.</param>
118-
<param name="factory">Provides the underlying data service is the data is not available in the cache.</param>
118+
<param name="factory">Provides the underlying data service if the data is not available in the cache.</param>
119119
<param name="options">Additional options for this cache entry.</param>
120120
<param name="tags">The tags to associate with this cache item.</param>
121121
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
@@ -196,8 +196,8 @@
196196
<typeparam name="TState">The type of additional state required by <paramref name="factory" />.</typeparam>
197197
<typeparam name="T">The type of the data being considered.</typeparam>
198198
<param name="key">The key of the entry to look for or create.</param>
199+
<param name="factory">Provides the underlying data service if the data is not available in the cache.</param>
199200
<param name="state">The state required for <paramref name="factory" />.</param>
200-
<param name="factory">Provides the underlying data service is the data is not available in the cache.</param>
201201
<param name="options">Additional options for this cache entry.</param>
202202
<param name="tags">The tags to associate with this cache item.</param>
203203
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>

xml/Microsoft.Extensions.Caching.Hybrid/HybridCacheEntryOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
<Interfaces />
2020
<Docs>
2121
<summary>
22-
Additional options (expiration, etc.) that apply to a <see cref="T:Microsoft.Extensions.Caching.Hybrid.HybridCache" /> operation. When options
22+
Specifies additional options (for example, expiration) that apply to a <see cref="T:Microsoft.Extensions.Caching.Hybrid.HybridCache" /> operation. When options
2323
can be specified at multiple levels (for example, globally and per-call), the values are composed; the
2424
most granular non-null value is used, with null values being inherited. If no value is specified at
25-
any level, the implementation may choose a reasonable default.
25+
any level, the implementation can choose a reasonable default.
2626
</summary>
2727
<remarks>To be added.</remarks>
2828
</Docs>

xml/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.xml

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<summary>To be added.</summary>
27+
<summary>
28+
Options for configuring the default <see cref="T:Microsoft.Extensions.Caching.Hybrid.HybridCache" /> implementation.
29+
</summary>
2830
<remarks>To be added.</remarks>
2931
</Docs>
3032
<Members>
@@ -61,7 +63,12 @@
6163
<ReturnType>Microsoft.Extensions.Caching.Hybrid.HybridCacheEntryOptions</ReturnType>
6264
</ReturnValue>
6365
<Docs>
64-
<summary>To be added.</summary>
66+
<summary>
67+
Gets or sets the default global options to be applied to <see cref="T:Microsoft.Extensions.Caching.Hybrid.HybridCache" /> operations; if options are
68+
specified at the individual call level, the non-null values are merged (with the per-call
69+
options being used in preference to the global options). If no value is specified for a given
70+
option (globally or per-call), the implementation may choose a reasonable default.
71+
</summary>
6572
<value>To be added.</value>
6673
<remarks>To be added.</remarks>
6774
</Docs>
@@ -82,7 +89,9 @@
8289
<ReturnType>System.Boolean</ReturnType>
8390
</ReturnValue>
8491
<Docs>
85-
<summary>To be added.</summary>
92+
<summary>
93+
Gets or sets a value indicating whether compression for this <see cref="T:Microsoft.Extensions.Caching.Hybrid.HybridCache" /> instance is disabled.
94+
</summary>
8695
<value>To be added.</value>
8796
<remarks>To be added.</remarks>
8897
</Docs>
@@ -103,9 +112,12 @@
103112
<ReturnType>System.Int32</ReturnType>
104113
</ReturnValue>
105114
<Docs>
106-
<summary>To be added.</summary>
115+
<summary>
116+
Gets or sets the maximum permitted length (in characters) of keys; attempts to use keys over this size will be logged.
117+
</summary>
107118
<value>To be added.</value>
108119
<remarks>To be added.</remarks>
120+
<remark>The default value is 1024 characters.</remark>
109121
</Docs>
110122
</Member>
111123
<Member MemberName="MaximumPayloadBytes">
@@ -124,9 +136,12 @@
124136
<ReturnType>System.Int64</ReturnType>
125137
</ReturnValue>
126138
<Docs>
127-
<summary>To be added.</summary>
139+
<summary>
140+
Gets or sets the maximum size of cache items; attempts to store values over this size will be logged
141+
and the value will not be stored in cache.
142+
</summary>
128143
<value>To be added.</value>
129-
<remarks>To be added.</remarks>
144+
<remarks>The default value is 1 MiB.</remarks>
130145
</Docs>
131146
</Member>
132147
<Member MemberName="ReportTagMetrics">
@@ -145,7 +160,10 @@
145160
<ReturnType>System.Boolean</ReturnType>
146161
</ReturnValue>
147162
<Docs>
148-
<summary>To be added.</summary>
163+
<summary>
164+
Gets or sets a value indicating whether to use "tags" data as dimensions on metric reporting; if enabled, care should be used to ensure that
165+
tags do not contain data that should not be visible in metrics systems.
166+
</summary>
149167
<value>To be added.</value>
150168
<remarks>To be added.</remarks>
151169
</Docs>

xml/Microsoft.Extensions.Caching.Hybrid/IHybridCacheBuilder.xml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717
</Attribute>
1818
</Attributes>
1919
<Docs>
20-
<summary>To be added.</summary>
20+
<summary>
21+
Helper API for configuring <see cref="T:Microsoft.Extensions.Caching.Hybrid.HybridCache" />.
22+
</summary>
2123
<remarks>To be added.</remarks>
2224
</Docs>
2325
<Members>
@@ -37,7 +39,9 @@
3739
<ReturnType>Microsoft.Extensions.DependencyInjection.IServiceCollection</ReturnType>
3840
</ReturnValue>
3941
<Docs>
40-
<summary>To be added.</summary>
42+
<summary>
43+
Gets the services collection associated with this instance.
44+
</summary>
4145
<value>To be added.</value>
4246
<remarks>To be added.</remarks>
4347
</Docs>

xml/Microsoft.Extensions.Caching.Hybrid/IHybridCacheSerializerFactory.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@
6464
</Parameter>
6565
</Parameters>
6666
<Docs>
67-
<typeparam name="T">The type being serialized/deserialized.</typeparam>
67+
<typeparam name="T">The type being serialized or deserialized.</typeparam>
6868
<param name="serializer">The serializer.</param>
6969
<summary>
70-
Request a serializer for the provided type, if possible.
70+
Requests a serializer for the provided type, if possible.
7171
</summary>
7272
<returns>
7373
<c>true</c> if the factory supports this type, <c>false</c> otherwise.</returns>

0 commit comments

Comments
 (0)