|
35 | 35 | </Attribute>
|
36 | 36 | </Attributes>
|
37 | 37 | <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> |
39 | 41 | <remarks>To be added.</remarks>
|
40 | 42 | </Docs>
|
41 | 43 | <Members>
|
|
62 | 64 | <Docs>
|
63 | 65 | <param name="cache">The cache in which to store the data.</param>
|
64 | 66 | <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> |
66 | 70 | <returns>The string value from the stored cache key.</returns>
|
67 | 71 | <remarks>To be added.</remarks>
|
68 | 72 | </Docs>
|
|
91 | 95 | <param name="cache">The cache in which to store the data.</param>
|
92 | 96 | <param name="key">The key to get the stored data for.</param>
|
93 | 97 | <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> |
95 | 101 | <returns>A task that gets the string value from the stored cache key.</returns>
|
96 | 102 | <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>
|
97 | 103 | <exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
|
122 | 128 | <param name="cache">The cache in which to store the data.</param>
|
123 | 129 | <param name="key">The key to store the data in.</param>
|
124 | 130 | <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> |
126 | 134 | <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> |
129 | 136 | </Docs>
|
130 | 137 | </Member>
|
131 | 138 | <Member MemberName="SetAsync">
|
|
154 | 161 | <param name="key">The key to store the data in.</param>
|
155 | 162 | <param name="value">The data to store in the cache.</param>
|
156 | 163 | <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> |
158 | 167 | <returns>A task that represents the asynchronous set operation.</returns>
|
159 | 168 | <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>
|
160 | 169 | <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> |
163 | 171 | </Docs>
|
164 | 172 | </Member>
|
165 | 173 | <Member MemberName="SetString">
|
|
187 | 195 | <param name="cache">The cache in which to store the data.</param>
|
188 | 196 | <param name="key">The key to store the data in.</param>
|
189 | 197 | <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> |
191 | 201 | <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> |
194 | 203 | </Docs>
|
195 | 204 | </Member>
|
196 | 205 | <Member MemberName="SetString">
|
|
220 | 229 | <param name="key">The key to store the data in.</param>
|
221 | 230 | <param name="value">The data to store in the cache.</param>
|
222 | 231 | <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> |
224 | 235 | <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> |
227 | 237 | </Docs>
|
228 | 238 | </Member>
|
229 | 239 | <Member MemberName="SetStringAsync">
|
|
252 | 262 | <param name="key">The key to store the data in.</param>
|
253 | 263 | <param name="value">The data to store in the cache.</param>
|
254 | 264 | <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> |
256 | 268 | <returns>A task that represents the asynchronous set operation.</returns>
|
257 | 269 | <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>
|
258 | 270 | <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> |
261 | 272 | </Docs>
|
262 | 273 | </Member>
|
263 | 274 | <Member MemberName="SetStringAsync">
|
|
288 | 299 | <param name="value">The data to store in the cache.</param>
|
289 | 300 | <param name="options">The cache options for the entry.</param>
|
290 | 301 | <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> |
292 | 305 | <returns>A task that represents the asynchronous set operation.</returns>
|
293 | 306 | <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>
|
294 | 307 | <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> |
297 | 309 | </Docs>
|
298 | 310 | </Member>
|
299 | 311 | </Members>
|
|
0 commit comments