Skip to content

Updated the documentation for IConfiguration.GetReloadToken. #9339

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 2 commits into from
Sep 28, 2023
Merged

Updated the documentation for IConfiguration.GetReloadToken. #9339

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfee085
Updated the documentation for `IConfiguration.GetReloadToken`.
tacosontitan Sep 27, 2023
d4e10c7
Updated remarks for `IConfiguration.GetReloadToken`.
tacosontitan Sep 27, 2023
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
6 changes: 3 additions & 3 deletions xml/Microsoft.Extensions.Configuration/IConfiguration.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ For more information, see [Configuration in .NET](/dotnet/core/extensions/config
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> that can be used to observe when this configuration is reloaded.</summary>
<returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" />.</returns>
<remarks>To be added.</remarks>
<summary>Attempts to get an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for change tracking.</summary>
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> token if this provider supports change tracking, <see langword="null"/> otherwise.</returns>
<remarks>GetReloadToken is a method that can be used to get a change token that notifies when the configuration is reloaded. A change token is a way to track changes in an object, such as a file, a cache entry, or an option.</remarks>
</Docs>
</Member>
<Member MemberName="GetSection">
Expand Down