Skip to content

Commit 7625051

Browse files
authored
Updated the documentation for IConfiguration.GetReloadToken. (#9339)
1 parent 6a82ff0 commit 7625051

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

xml/Microsoft.Extensions.Configuration/IConfiguration.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ For more information, see [Configuration in .NET](/dotnet/core/extensions/config
9898
</ReturnValue>
9999
<Parameters />
100100
<Docs>
101-
<summary>Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> that can be used to observe when this configuration is reloaded.</summary>
102-
<returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" />.</returns>
103-
<remarks>To be added.</remarks>
101+
<summary>Attempts to get an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for change tracking.</summary>
102+
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> token if this provider supports change tracking, <see langword="null"/> otherwise.</returns>
103+
<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>
104104
</Docs>
105105
</Member>
106106
<Member MemberName="GetSection">

0 commit comments

Comments
 (0)