Skip to content

Commit 665081b

Browse files
Add See Also links for Configuration APIs (dotnet#8768)
1 parent b1a538f commit 665081b

File tree

17 files changed

+166
-28
lines changed

17 files changed

+166
-28
lines changed

xml/Microsoft.Extensions.Configuration.CommandLine/CommandLineConfigurationProvider.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,15 @@
2424
<Interfaces />
2525
<Docs>
2626
<summary>A command line based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider" />.</summary>
27-
<remarks>To be added.</remarks>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
For more information and examples, see [Command-line configuration provider](/dotnet/core/extensions/configuration-providers#command-line-configuration-provider).
33+
34+
]]></format>
35+
</remarks>
2836
</Docs>
2937
<Members>
3038
<Member MemberName=".ctor">

xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,15 @@
2424
<Interfaces />
2525
<Docs>
2626
<summary>An environment variable based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider" />.</summary>
27-
<remarks>To be added.</remarks>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
For more information and examples, see [Environment variable configuration provider](/dotnet/core/extensions/configuration-providers#environment-variable-configuration-provider).
33+
34+
]]></format>
35+
</remarks>
2836
</Docs>
2937
<Members>
3038
<Member MemberName=".ctor">

xml/Microsoft.Extensions.Configuration.Ini/IniConfigurationProvider.xml

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,27 @@
2323
</Base>
2424
<Interfaces />
2525
<Docs>
26-
<summary>An INI file based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider" />.
27-
Files are simple line structures (<see href="https://en.wikipedia.org/wiki/INI_file">INI Files on Wikipedia</see>).</summary>
28-
<remarks>To be added.</remarks>
29-
<examples>
30-
[Section:Header]
31-
key1=value1
32-
key2 = " value2 "
33-
; comment
34-
# comment
35-
/ comment
36-
</examples>
26+
<summary>An INI file based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider" />.</summary>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
INI files are simple line structures ([INI Files on Wikipedia](https://en.wikipedia.org/wiki/INI_file)). The following example demonstrates a structure of the INI file:
33+
34+
```
35+
[Section:Header]
36+
key1=value1
37+
key2 = " value2 "
38+
; comment
39+
# comment
40+
/ comment
41+
```
42+
43+
For more information and examples, see [INI configuration provider](/dotnet/core/extensions/configuration-providers#ini-configuration-provider).
44+
45+
]]></format>
46+
</remarks>
3747
</Docs>
3848
<Members>
3949
<Member MemberName=".ctor">

xml/Microsoft.Extensions.Configuration.Json/JsonConfigurationProvider.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,15 @@
2424
<Interfaces />
2525
<Docs>
2626
<summary>A JSON file based <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider" />.</summary>
27-
<remarks>To be added.</remarks>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
For more information and examples, see [JSON configuration provider](/dotnet/core/extensions/configuration-providers#json-configuration-provider).
33+
34+
]]></format>
35+
</remarks>
2836
</Docs>
2937
<Members>
3038
<Member MemberName=".ctor">

xml/Microsoft.Extensions.Configuration.Memory/MemoryConfigurationProvider.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,15 @@
3131
</Interfaces>
3232
<Docs>
3333
<summary>In-memory implementation of <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" />.</summary>
34-
<remarks>To be added.</remarks>
34+
<remarks>
35+
<format type="text/markdown"><![CDATA[
36+
37+
## Remarks
38+
39+
For more information and examples, see [Memory configuration provider](/dotnet/core/extensions/configuration-providers#memory-configuration-provider).
40+
41+
]]></format>
42+
</remarks>
3543
</Docs>
3644
<Members>
3745
<Member MemberName=".ctor">

xml/Microsoft.Extensions.Configuration.Xml/XmlConfigurationProvider.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,15 @@
2424
<Interfaces />
2525
<Docs>
2626
<summary>Represents an XML file as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource" />.</summary>
27-
<remarks>To be added.</remarks>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
For more information and examples, see [XML configuration provider](/dotnet/core/extensions/configuration-providers#xml-configuration-provider).
33+
34+
]]></format>
35+
</remarks>
2836
</Docs>
2937
<Members>
3038
<Member MemberName=".ctor">

xml/Microsoft.Extensions.Configuration/CommandLineConfigurationExtensions.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,15 @@
2424
<Interfaces />
2525
<Docs>
2626
<summary>Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider" /> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</summary>
27-
<remarks>To be added.</remarks>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
For more information and examples, see [Command-line configuration provider](/dotnet/core/extensions/configuration-providers#command-line-configuration-provider).
33+
34+
]]></format>
35+
</remarks>
2836
</Docs>
2937
<Members>
3038
<Member MemberName="AddCommandLine">

xml/Microsoft.Extensions.Configuration/ConfigurationBinder.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,15 @@
2424
<Interfaces />
2525
<Docs>
2626
<summary>Static helper class that allows binding strongly typed objects to configuration values.</summary>
27-
<remarks>To be added.</remarks>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
For more information and examples, see [Binding](/dotnet/core/extensions/configuration#binding).
33+
34+
]]></format>
35+
</remarks>
2836
</Docs>
2937
<Members>
3038
<Member MemberName="Bind">

xml/Microsoft.Extensions.Configuration/ConfigurationProvider.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@
2828
</Interfaces>
2929
<Docs>
3030
<summary>Base helper class for implementing an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" />.</summary>
31-
<remarks>To be added.</remarks>
31+
<remarks>
32+
<format type="text/markdown"><![CDATA[
33+
34+
## Remarks
35+
36+
For more information, see [Configuration providers in .NET](/dotnet/core/extensions/configuration-providers).
37+
38+
]]></format>
39+
</remarks>
3240
</Docs>
3341
<Members>
3442
<Member MemberName=".ctor">

xml/Microsoft.Extensions.Configuration/EnvironmentVariablesExtensions.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,15 @@
2424
<Interfaces />
2525
<Docs>
2626
<summary>Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider" /> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</summary>
27-
<remarks>To be added.</remarks>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
For more information and examples, see [Environment variable configuration provider](/dotnet/core/extensions/configuration-providers#environment-variable-configuration-provider).
33+
34+
]]></format>
35+
</remarks>
2836
</Docs>
2937
<Members>
3038
<Member MemberName="AddEnvironmentVariables">

0 commit comments

Comments
 (0)