Skip to content

Port Microsoft.Extensions new docs #10208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Aug 13, 2024
Merged

Port Microsoft.Extensions new docs #10208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
6448af3
Microsoft.Extensions.Caching.Distributed
carlossanlop Aug 6, 2024
548d2ce
Microsoft.Extensions.Caching.Hybrid
carlossanlop Aug 6, 2024
e87c90e
Microsoft.Extensions.Caching.Memory
carlossanlop Aug 6, 2024
aff3648
Microsoft.Extensions.Configuration
carlossanlop Aug 6, 2024
e336dc6
Microsoft.Extensions.DependencyInjection
carlossanlop Aug 6, 2024
188c96f
Microsoft.Extensions.FileProviders.Physical
carlossanlop Aug 6, 2024
6348e19
Microsoft.Extensions.Hosting
carlossanlop Aug 6, 2024
3e9f539
Microsoft.Extensions.Hosting.WindowsServices
carlossanlop Aug 6, 2024
6573f72
Microsoft.Extensions.Http.Logging
carlossanlop Aug 6, 2024
85e0250
Microsoft.Extensions.Logging
carlossanlop Aug 6, 2024
5b038d3
Microsoft.Extensions.Logging.Abstractions
carlossanlop Aug 6, 2024
40d4db1
Microsoft.Extensions.Logging.Configuration
carlossanlop Aug 6, 2024
a4a7341
Microsoft.Extensions.Logging.Console
carlossanlop Aug 6, 2024
c301abe
Microsoft.Extensions.Logging.EventSource
carlossanlop Aug 6, 2024
336e351
Fix paramrefs
carlossanlop Aug 7, 2024
981eb1f
Apply suggestions from code review
carlossanlop Aug 7, 2024
7d39eff
Apply suggestions from code review
carlossanlop Aug 13, 2024
4d2ad5e
Apply suggestions from code review
carlossanlop Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 25 additions & 23 deletions xml/Microsoft.Extensions.Caching.Distributed/IBufferDistributedCache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Represents a distributed cache of serialized values, with support for low allocation data transfer.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -53,11 +53,11 @@
<Parameter Name="options" Type="Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<param name="options">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="key">The key of the entry to create.</param>
<param name="value">The value for this cache entry.</param>
<param name="options">The cache options for the entry.</param>
<summary>Sets or overwrites a cache item.</summary>
<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>
</Docs>
</Member>
<Member MemberName="SetAsync">
Expand Down Expand Up @@ -88,13 +88,13 @@
<Parameter Name="token" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<param name="options">To be added.</param>
<param name="token">To be added.</param>
<summary>To be added.</summary>
<param name="key">The key of the entry to create.</param>
<param name="value">The value for this cache entry.</param>
<param name="options">The cache options for the value.</param>
<param name="token">The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
<summary>Asynchronously sets or overwrites a cache entry.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<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>
</Docs>
</Member>
<Member MemberName="TryGet">
Expand All @@ -117,11 +117,12 @@
<Parameter Name="destination" Type="System.Buffers.IBufferWriter&lt;System.Byte&gt;" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="key">The unique key for the cache item.</param>
<param name="destination">The target to write the cache contents on success.</param>
<summary>Attempts to retrieve an existing cache item.</summary>
<returns>
<see langword="true" /> if the cache item is found, <see langword="false" /> otherwise.</returns>
<remarks>This is functionally similar to <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Get(System.String)" />, but avoids the array allocation.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetAsync">
Expand Down Expand Up @@ -150,12 +151,13 @@
<Parameter Name="token" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="destination">To be added.</param>
<param name="token">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="key">The unique key for the cache entry.</param>
<param name="destination">The target to write the cache contents on success.</param>
<param name="token">The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
<summary>Asynchronously attempts to retrieve an existing cache entry.</summary>
<returns>
<see langword="true" /> if the cache entry is found, <see langword="false" /> otherwise.</returns>
<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>
</Docs>
</Member>
</Members>
Expand Down
14 changes: 7 additions & 7 deletions xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Provides multi-tier caching services building on <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" /> backends.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -215,9 +215,9 @@
<Docs>
<param name="keys">To be added.</param>
<param name="token">To be added.</param>
<summary>To be added.</summary>
<summary>Asynchronously removes the value associated with the key if it exists.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>Implementors should treat <see langword="null" /> as empty.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveAsync">
Expand All @@ -241,7 +241,7 @@
<Docs>
<param name="key">To be added.</param>
<param name="token">To be added.</param>
<summary>To be added.</summary>
<summary>Asynchronously removes the value associated with the key if it exists.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -267,9 +267,9 @@
<Docs>
<param name="tags">To be added.</param>
<param name="token">To be added.</param>
<summary>To be added.</summary>
<summary>Asynchronously removes all values associated with the specified tags.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>Implementors should treat <see langword="null" /> as empty.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveByTagAsync">
Expand All @@ -293,7 +293,7 @@
<Docs>
<param name="tag">To be added.</param>
<param name="token">To be added.</param>
<summary>To be added.</summary>
<summary>Asynchronously removes all values associated with the specified tag.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down
20 changes: 10 additions & 10 deletions xml/Microsoft.Extensions.Caching.Hybrid/HybridCacheEntryFlags.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Specifies additional flags that apply to a <see cref="T:Microsoft.Extensions.Caching.Hybrid.HybridCache" /> operation.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -40,7 +40,7 @@
</ReturnValue>
<MemberValue>32</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Disables compression for this payload.</summary>
</Docs>
</Member>
<Member MemberName="DisableDistributedCache">
Expand All @@ -60,7 +60,7 @@
</ReturnValue>
<MemberValue>12</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Disables both reading from and writing to the secondary distributed cache.</summary>
</Docs>
</Member>
<Member MemberName="DisableDistributedCacheRead">
Expand All @@ -80,7 +80,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Disables reading from the secondary distributed cache.</summary>
</Docs>
</Member>
<Member MemberName="DisableDistributedCacheWrite">
Expand All @@ -100,7 +100,7 @@
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Disables writing to the secondary distributed cache.</summary>
</Docs>
</Member>
<Member MemberName="DisableLocalCache">
Expand All @@ -120,7 +120,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Disables both reading from and writing to the local in-process cache.</summary>
</Docs>
</Member>
<Member MemberName="DisableLocalCacheRead">
Expand All @@ -140,7 +140,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Disables reading from the local in-process cache.</summary>
</Docs>
</Member>
<Member MemberName="DisableLocalCacheWrite">
Expand All @@ -160,7 +160,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Disables writing to the local in-process cache.</summary>
</Docs>
</Member>
<Member MemberName="DisableUnderlyingData">
Expand All @@ -180,7 +180,7 @@
</ReturnValue>
<MemberValue>16</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Only fetches the value from cache; does not attempt to access the underlying data store.</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand All @@ -200,7 +200,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>No additional flags.</summary>
</Docs>
</Member>
</Members>
Expand Down
16 changes: 12 additions & 4 deletions xml/Microsoft.Extensions.Caching.Hybrid/HybridCacheEntryOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>
<para>Specifies dditional options, such as expiration, that apply to a <see cref="T:Microsoft.Extensions.Caching.Hybrid.HybridCache" /> operation. When options</para>
<para>can be specified at multiple levels (for example, globally and per-call), the values are composed; the</para>
<para>most granular non-<see langword="null" /> value is used, with <see langword="null" /> values being inherited. If no value is specified at</para>
<para>any level, the implementation can choose a reasonable default.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -51,7 +56,7 @@
<ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the overall cache duration of this entry, passed to the backend distributed cache.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -72,7 +77,7 @@
<ReturnType>System.Nullable&lt;Microsoft.Extensions.Caching.Hybrid.HybridCacheEntryFlags&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets additional flags that apply to the requested operation.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -95,7 +100,10 @@
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
<para>When retrieving a cached value from an external cache store, this value will be used to calculate the local</para>
<para>cache expiration, not exceeding the remaining overall cache lifetime.</para>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
11 changes: 6 additions & 5 deletions xml/Microsoft.Extensions.Caching.Hybrid/IHybridCacheSerializerFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Factory provider for per-type <see cref="T:Microsoft.Extensions.Caching.Hybrid.IHybridCacheSerializer`1" /> instances.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -54,10 +54,11 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="serializer">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type being serialized/deserialized.</typeparam>
<param name="serializer">The serializer.</param>
<summary>Requests a serializer for the provided type, if possible.</summary>
<returns>
<see langword="true" /> if the factory supports this type, <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
8 changes: 4 additions & 4 deletions xml/Microsoft.Extensions.Caching.Hybrid/IHybridCacheSerializer`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
</TypeParameters>
<Interfaces />
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>To be added.</summary>
<typeparam name="T">The type being serialized/deserialized.</typeparam>
<summary>Provides per-type serialization and deserialization support for <see cref="T:Microsoft.Extensions.Caching.Hybrid.HybridCache" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -52,7 +52,7 @@
</Parameters>
<Docs>
<param name="source">To be added.</param>
<summary>To be added.</summary>
<summary>Deserializes a <typeparamref name="T" /> value from the provided <paramref name="source" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -85,7 +85,7 @@
<Docs>
<param name="value">To be added.</param>
<param name="target">To be added.</param>
<summary>To be added.</summary>
<summary>Serializes <paramref name="value" /> to the provided <paramref name="target" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
28 changes: 14 additions & 14 deletions xml/Microsoft.Extensions.Caching.Memory/CacheExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,13 +192,13 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="TItem">To be added.</typeparam>
<param name="cache">To be added.</param>
<param name="key">To be added.</param>
<param name="factory">To be added.</param>
<param name="createOptions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TItem">The type of the object to get.</typeparam>
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache" /> instance this method extends.</param>
<param name="key">The key of the entry to look for or create.</param>
<param name="factory">The factory that creates the value associated with this key if the key does not exist in the cache.</param>
<param name="createOptions">The options to be applied to the <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry" /> if the key does not exist in the cache.</param>
<summary>Gets the value associated with this key if it exists, or generates a new entry using the provided key and a value from the given factory if the key is not found.</summary>
<returns>The value associated with this key.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -288,13 +288,13 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="TItem">To be added.</typeparam>
<param name="cache">To be added.</param>
<param name="key">To be added.</param>
<param name="factory">To be added.</param>
<param name="createOptions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TItem">The type of the object to get.</typeparam>
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache" /> instance this method extends.</param>
<param name="key">The key of the entry to look for or create.</param>
<param name="factory">The factory task that creates the value associated with this key if the key does not exist in the cache.</param>
<param name="createOptions">The options to be applied to the <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry" /> if the key does not exist in the cache.</param>
<summary>Asynchronously gets the value associated with this key if it exists, or generates a new entry using the provided key and a value from the given factory if the key is not found.</summary>
<returns>The task object representing the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>An implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache" /> using a dictionary to
<summary>Implements <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache" /> using a dictionary to
store its entries.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -323,7 +323,7 @@
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.Object&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets an enumerable of the all the keys in the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Loading