Skip to content
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

Jump to bottom

docs: add missing xml document's comments #57329

Merged
merged 4 commits into from
Sep 2, 2021
Merged

docs: add missing xml document's comments #57329

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
594a9fc
docs: add missing xml document's comments
SEWeiTung Aug 13, 2021
b703d47
Update src/libraries/Microsoft.Extensions.Configuration.Abstractions/…
SEWeiTung Aug 14, 2021
a8acab8
Update src/libraries/Microsoft.Extensions.Configuration.Abstractions/…
SEWeiTung Aug 14, 2021
bd8f813
Update ConfigurationExtensions.cs
SEWeiTung Aug 14, 2021
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
12 changes: 7 additions & 5 deletions src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public static class ConfigurationExtensions
/// <summary>
/// Adds a new configuration source.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/> to add to.</param>
/// <param name="builder">The builder to add to.</param>
/// <param name="configureSource">Configures the source secrets.</param>
/// <returns>The <see cref="IConfigurationBuilder"/>.</returns>
public static IConfigurationBuilder Add<TSource>(this IConfigurationBuilder builder, Action<TSource> configureSource) where TSource : IConfigurationSource, new()
Expand All @@ -28,7 +28,7 @@ public static class ConfigurationExtensions
/// <summary>
/// Shorthand for GetSection("ConnectionStrings")[name].
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <param name="configuration">The configuration to enumerate.</param>
/// <param name="name">The connection string key.</param>
/// <returns>The connection string.</returns>
public static string GetConnectionString(this IConfiguration configuration, string name)
Expand All @@ -39,14 +39,14 @@ public static string GetConnectionString(this IConfiguration configuration, stri
/// <summary>
/// Get the enumeration of key value pairs within the <see cref="IConfiguration" />
/// </summary>
/// <param name="configuration">The <see cref="IConfiguration"/> to enumerate.</param>
/// <param name="configuration">The configuration to enumerate.</param>
/// <returns>An enumeration of key value pairs.</returns>
public static IEnumerable<KeyValuePair<string, string>> AsEnumerable(this IConfiguration configuration) => configuration.AsEnumerable(makePathsRelative: false);

/// <summary>
/// Get the enumeration of key value pairs within the <see cref="IConfiguration" />
/// </summary>
/// <param name="configuration">The <see cref="IConfiguration"/> to enumerate.</param>
/// <param name="configuration">The configuration to enumerate.</param>
/// <param name="makePathsRelative">If true, the child keys returned will have the current configuration's Path trimmed from the front.</param>
/// <returns>An enumeration of key value pairs.</returns>
public static IEnumerable<KeyValuePair<string, string>> AsEnumerable(this IConfiguration configuration, bool makePathsRelative)
Expand All @@ -73,6 +73,8 @@ public static IEnumerable<KeyValuePair<string, string>> AsEnumerable(this IConfi
/// <summary>
/// Determines whether the section has a <see cref="IConfigurationSection.Value"/> or has children
/// </summary>
/// <param name="section">The section to enumerate.</param>
/// <returns><see langword="true" /> if the section has values or children; otherwise, <see langword="false" />.</returns>
public static bool Exists(this IConfigurationSection section)
{
if (section == null)
Expand All @@ -85,7 +87,7 @@ public static bool Exists(this IConfigurationSection section)
/// <summary>
/// Gets a configuration sub-section with the specified key.
/// </summary>
/// <param name="configuration"></param>
/// <param name="configuration">The configuration to enumerate.</param>
/// <param name="key">The key of the configuration section.</param>
/// <returns>The <see cref="IConfigurationSection"/>.</returns>
/// <remarks>
Expand Down