Skip to content

Commit 4eb50ed

Browse files
Updating xml doc comments. Also updating MD docs with permalinks when needed. (#212)
1 parent 1bdc238 commit 4eb50ed

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ some of the most frequent along with answers that are hopefully helpful.
2929
> xml through the use of token expansion that doesn't conform to the convenient mental paradigm of
3030
> only placing tokens within obvious key/value places of existing well-formed xml... you can try
3131
> [this wrapper approach](../samples/SamplesLib/ExpandWrapper.cs) as is demonstrated in the
32-
> [SampleConsoleApp](../samples/SampleConsoleApp/App.config#L36-L39).
32+
> [SampleConsoleApp](https://github.com/aspnet/MicrosoftConfigurationBuilders/blob/1bdc2388f139c046e1c58bcc147c875d5c918785/samples/SampleConsoleApp/App.config#L50-L53).
3333
> </sub></sub>
3434
</details>
3535

docs/SectionHandlers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ One thing to note is that the mechanism for associating a key/value lookup with
115115
is a simple post-fix to the key. This makes this feature incompatible with versioned keys in Azure Key Vault. Most other cases should
116116
just work as they did before, with a little extra magic cleanliness when you start using this feature.
117117

118-
An example of this new behavior from `ConnectionStringsSectionHandler2` can be seen in the [SampleConsoleApp](samples/SampleConsoleApp/App.config#L37-L46).
119-
Or in the [test project](https://github.com/aspnet/MicrosoftConfigurationBuilders/blob/main/test/Microsoft.Configuration.ConfigurationBuilders.Test/ConnectionStringsSectionHandler2Tests.cs).
120-
The [SampleWebApp](samples/SampleWebApp/Web.config#L38-L41) does not use the new section handler, but it does include some notes about how
118+
An example of this new behavior from `ConnectionStringsSectionHandler2` can be seen in the [SampleConsoleApp](https://github.com/aspnet/MicrosoftConfigurationBuilders/blob/1bdc2388f139c046e1c58bcc147c875d5c918785/samples/SampleConsoleApp/App.config#L37-L46).
119+
Or in the [test project](https://github.com/aspnet/MicrosoftConfigurationBuilders/blob/1bdc2388f139c046e1c58bcc147c875d5c918785/test/Microsoft.Configuration.ConfigurationBuilders.Test/ConnectionStringsSectionHandler2Tests.cs).
120+
The [SampleWebApp](https://github.com/aspnet/MicrosoftConfigurationBuilders/blob/1bdc2388f139c046e1c58bcc147c875d5c918785/samples/SampleWebApp/Web.config#L38-L41) does not use the new section handler, but it does include some notes about how
121121
it's resulting connection string collection would look different if it did.

src/Azure/AzureKeyVaultConfigBuilder.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,9 @@ public override string GetValue(string key)
164164
/// </summary>
165165
/// <returns>A token credential.</returns>
166166
protected virtual TokenCredential GetCredential() => new DefaultAzureCredential();
167-
167+
168168
/// <summary>
169-
/// Gets a <see cref="SecretClientOptions"/> to initialize the Key Vault SecretClient with. This defaults to <see cref="null"/>.
169+
/// Gets a <see cref="SecretClientOptions"/> to initialize the Key Vault SecretClient with. This defaults to a new <see cref="SecretClientOptions"/>.
170170
/// </summary>
171171
/// <returns>A token credential.</returns>
172172
protected virtual SecretClientOptions GetSecretClientOptions() => new SecretClientOptions();

src/AzureAppConfig/AzureAppConfigurationBuilder.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,9 +225,9 @@ public override ICollection<KeyValuePair<string, string>> GetAllValues(string pr
225225
/// </summary>
226226
/// <returns>A token credential.</returns>
227227
protected virtual TokenCredential GetCredential() => new DefaultAzureCredential();
228-
228+
229229
/// <summary>
230-
/// Gets a <see cref="ConfigurationClientOptions"/> to initialize the Key Vault SecretClient with. This defaults to <see cref="null"/>.
230+
/// Gets a <see cref="ConfigurationClientOptions"/> to initialize the Key Vault SecretClient with. This defaults to a new <see cref="ConfigurationClientOptions"/>.
231231
/// </summary>
232232
/// <returns>A token credential.</returns>
233233
protected virtual ConfigurationClientOptions GetConfigurationClientOptions() => new ConfigurationClientOptions();

0 commit comments

Comments
 (0)