Skip to content

Commit ffb9b6e

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=456964&view=results source_repo.branch:net9-rc1 source_repo.url:https://apidrop.visualstudio.com/_git/binaries
1 parent 3af31fa commit ffb9b6e

File tree

337 files changed

+8130
-3928
lines changed

Some content is hidden

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

337 files changed

+8130
-3928
lines changed

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@
3535
</Attribute>
3636
</Attributes>
3737
<Docs>
38-
<summary>Provides extension methods for <see cref="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions" /> operations.</summary>
38+
<summary>
39+
Extension methods for <see cref="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions" /> operations.
40+
</summary>
3941
<remarks>To be added.</remarks>
4042
</Docs>
4143
<Members>
@@ -62,7 +64,9 @@
6264
<Docs>
6365
<param name="options">The options to be operated on.</param>
6466
<param name="absolute">The expiration time, in absolute terms.</param>
65-
<summary>Sets an absolute expiration date for the cache entry.</summary>
67+
<summary>
68+
Sets an absolute expiration date for the cache entry.
69+
</summary>
6670
<returns>To be added.</returns>
6771
<remarks>To be added.</remarks>
6872
</Docs>
@@ -90,7 +94,9 @@
9094
<Docs>
9195
<param name="options">The options to be operated on.</param>
9296
<param name="relative">The expiration time, relative to now.</param>
93-
<summary>Sets an absolute expiration time, relative to now.</summary>
97+
<summary>
98+
Sets an absolute expiration time, relative to now.
99+
</summary>
94100
<returns>To be added.</returns>
95101
<remarks>To be added.</remarks>
96102
</Docs>
@@ -118,8 +124,10 @@
118124
<Docs>
119125
<param name="options">The options to be operated on.</param>
120126
<param name="offset">The sliding expiration time.</param>
121-
<summary>Sets how long the cache entry can be inactive (e.g. not accessed) before it will be removed.
122-
This will not extend the entry lifetime beyond the absolute expiration (if set).</summary>
127+
<summary>
128+
Sets how long the cache entry can be inactive (e.g. not accessed) before it will be removed.
129+
This will not extend the entry lifetime beyond the absolute expiration (if set).
130+
</summary>
123131
<returns>To be added.</returns>
124132
<remarks>To be added.</remarks>
125133
</Docs>

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
</Base>
2626
<Interfaces />
2727
<Docs>
28-
<summary>Provides the cache options for an entry in <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" />.</summary>
28+
<summary>
29+
Provides the cache options for an entry in <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" />.
30+
</summary>
2931
<remarks>To be added.</remarks>
3032
</Docs>
3133
<Members>
@@ -64,7 +66,9 @@
6466
<ReturnType>System.Nullable&lt;System.DateTimeOffset&gt;</ReturnType>
6567
</ReturnValue>
6668
<Docs>
67-
<summary>Gets or sets an absolute expiration date for the cache entry.</summary>
69+
<summary>
70+
Gets or sets an absolute expiration date for the cache entry.
71+
</summary>
6872
<value>To be added.</value>
6973
<remarks>To be added.</remarks>
7074
</Docs>
@@ -86,7 +90,9 @@
8690
<ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
8791
</ReturnValue>
8892
<Docs>
89-
<summary>Gets or sets an absolute expiration time, relative to now.</summary>
93+
<summary>
94+
Gets or sets an absolute expiration time, relative to now.
95+
</summary>
9096
<value>To be added.</value>
9197
<remarks>To be added.</remarks>
9298
</Docs>
@@ -108,8 +114,10 @@
108114
<ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
109115
</ReturnValue>
110116
<Docs>
111-
<summary>Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed.
112-
This will not extend the entry lifetime beyond the absolute expiration (if set).</summary>
117+
<summary>
118+
Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed.
119+
This will not extend the entry lifetime beyond the absolute expiration (if set).
120+
</summary>
113121
<value>To be added.</value>
114122
<remarks>To be added.</remarks>
115123
</Docs>

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

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@
3535
</Attribute>
3636
</Attributes>
3737
<Docs>
38-
<summary>Extension methods for setting data in an <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" />.</summary>
38+
<summary>
39+
Extension methods for setting data in an <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" />.
40+
</summary>
3941
<remarks>To be added.</remarks>
4042
</Docs>
4143
<Members>
@@ -62,7 +64,9 @@
6264
<Docs>
6365
<param name="cache">The cache in which to store the data.</param>
6466
<param name="key">The key to get the stored data for.</param>
65-
<summary>Gets a string from the specified cache with the specified key.</summary>
67+
<summary>
68+
Gets a string from the specified cache with the specified key.
69+
</summary>
6670
<returns>The string value from the stored cache key.</returns>
6771
<remarks>To be added.</remarks>
6872
</Docs>
@@ -91,7 +95,9 @@
9195
<param name="cache">The cache in which to store the data.</param>
9296
<param name="key">The key to get the stored data for.</param>
9397
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
94-
<summary>Asynchronously gets a string from the specified cache with the specified key.</summary>
98+
<summary>
99+
Asynchronously gets a string from the specified cache with the specified key.
100+
</summary>
95101
<returns>A task that gets the string value from the stored cache key.</returns>
96102
<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.GetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String)" />.</remarks>
97103
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
@@ -122,10 +128,11 @@
122128
<param name="cache">The cache in which to store the data.</param>
123129
<param name="key">The key to store the data in.</param>
124130
<param name="value">The data to store in the cache.</param>
125-
<summary>Sets a sequence of bytes in the specified cache with the specified key.</summary>
131+
<summary>
132+
Sets a sequence of bytes in the specified cache with the specified key.
133+
</summary>
126134
<remarks>To be added.</remarks>
127-
<exception cref="T:System.ArgumentNullException">
128-
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
135+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
129136
</Docs>
130137
</Member>
131138
<Member MemberName="SetAsync">
@@ -154,12 +161,13 @@
154161
<param name="key">The key to store the data in.</param>
155162
<param name="value">The data to store in the cache.</param>
156163
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
157-
<summary>Asynchronously sets a sequence of bytes in the specified cache with the specified key.</summary>
164+
<summary>
165+
Asynchronously sets a sequence of bytes in the specified cache with the specified key.
166+
</summary>
158167
<returns>A task that represents the asynchronous set operation.</returns>
159168
<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>
160169
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
161-
<exception cref="T:System.ArgumentNullException">
162-
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
170+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
163171
</Docs>
164172
</Member>
165173
<Member MemberName="SetString">
@@ -187,10 +195,11 @@
187195
<param name="cache">The cache in which to store the data.</param>
188196
<param name="key">The key to store the data in.</param>
189197
<param name="value">The data to store in the cache.</param>
190-
<summary>Sets a string in the specified cache with the specified key.</summary>
198+
<summary>
199+
Sets a string in the specified cache with the specified key.
200+
</summary>
191201
<remarks>To be added.</remarks>
192-
<exception cref="T:System.ArgumentNullException">
193-
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
202+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
194203
</Docs>
195204
</Member>
196205
<Member MemberName="SetString">
@@ -220,10 +229,11 @@
220229
<param name="key">The key to store the data in.</param>
221230
<param name="value">The data to store in the cache.</param>
222231
<param name="options">The cache options for the entry.</param>
223-
<summary>Sets a string in the specified cache with the specified key.</summary>
232+
<summary>
233+
Sets a string in the specified cache with the specified key.
234+
</summary>
224235
<remarks>To be added.</remarks>
225-
<exception cref="T:System.ArgumentNullException">
226-
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
236+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
227237
</Docs>
228238
</Member>
229239
<Member MemberName="SetStringAsync">
@@ -252,12 +262,13 @@
252262
<param name="key">The key to store the data in.</param>
253263
<param name="value">The data to store in the cache.</param>
254264
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
255-
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
265+
<summary>
266+
Asynchronously sets a string in the specified cache with the specified key.
267+
</summary>
256268
<returns>A task that represents the asynchronous set operation.</returns>
257269
<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>
258270
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
259-
<exception cref="T:System.ArgumentNullException">
260-
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
271+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
261272
</Docs>
262273
</Member>
263274
<Member MemberName="SetStringAsync">
@@ -288,12 +299,13 @@
288299
<param name="value">The data to store in the cache.</param>
289300
<param name="options">The cache options for the entry.</param>
290301
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
291-
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
302+
<summary>
303+
Asynchronously sets a string in the specified cache with the specified key.
304+
</summary>
292305
<returns>A task that represents the asynchronous set operation.</returns>
293306
<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>
294307
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
295-
<exception cref="T:System.ArgumentNullException">
296-
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
308+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
297309
</Docs>
298310
</Member>
299311
</Members>

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

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
</Attribute>
2626
</Attributes>
2727
<Docs>
28-
<summary>Represents a distributed cache of serialized values, with support for low allocation data transfer.</summary>
28+
<summary>
29+
Represents a distributed cache of serialized values, with support for low allocation data transfer.
30+
</summary>
2931
<remarks>To be added.</remarks>
3032
</Docs>
3133
<Members>
@@ -64,7 +66,9 @@
6466
<param name="key">The key of the entry to create.</param>
6567
<param name="value">The value for this cache entry.</param>
6668
<param name="options">The cache options for the entry.</param>
67-
<summary>Sets or overwrites a cache item.</summary>
69+
<summary>
70+
Sets or overwrites a cache item.
71+
</summary>
6872
<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>
6973
</Docs>
7074
</Member>
@@ -104,7 +108,9 @@
104108
<param name="value">The value for this cache entry.</param>
105109
<param name="options">The cache options for the value.</param>
106110
<param name="token">The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
107-
<summary>Asynchronously sets or overwrites a cache entry.</summary>
111+
<summary>
112+
Asynchronously sets or overwrites a cache entry.
113+
</summary>
108114
<returns>To be added.</returns>
109115
<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>
110116
</Docs>
@@ -135,9 +141,11 @@
135141
<Docs>
136142
<param name="key">The unique key for the cache item.</param>
137143
<param name="destination">The target to write the cache contents on success.</param>
138-
<summary>Attempts to retrieve an existing cache item.</summary>
144+
<summary>
145+
Attempt to retrieve an existing cache item.
146+
</summary>
139147
<returns>
140-
<see langword="true" /> if the cache item is found, <see langword="false" /> otherwise.</returns>
148+
<c>true</c> if the cache item is found, <c>false</c> otherwise.</returns>
141149
<remarks>This is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Get(System.String)" />, but avoids the array allocation.</remarks>
142150
</Docs>
143151
</Member>
@@ -174,9 +182,11 @@
174182
<param name="key">The unique key for the cache entry.</param>
175183
<param name="destination">The target to write the cache contents on success.</param>
176184
<param name="token">The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
177-
<summary>Asynchronously attempts to retrieve an existing cache entry.</summary>
185+
<summary>
186+
Asynchronously attempt to retrieve an existing cache entry.
187+
</summary>
178188
<returns>
179-
<see langword="true" /> if the cache entry is found, <see langword="false" /> otherwise.</returns>
189+
<c>true</c> if the cache entry is found, <c>false</c> otherwise.</returns>
180190
<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>
181191
</Docs>
182192
</Member>

0 commit comments

Comments
 (0)