Skip to content

Commit 8ba6add

Browse files
gewarrenCopilot
andauthored
Fix up docs with Copilot (M.E.ServiceDiscovery) (#7598)
* docs fix up * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 3c16426 commit 8ba6add

7 files changed

Lines changed: 24 additions & 11 deletions

File tree

src/Libraries/Microsoft.Extensions.ServiceDiscovery.Abstractions/IServiceEndpointBuilder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace Microsoft.Extensions.ServiceDiscovery;
88

99
/// <summary>
10-
/// Builder to create a <see cref="ServiceEndpointSource"/> instances.
10+
/// Represents a builder that creates <see cref="ServiceEndpointSource"/> instances.
1111
/// </summary>
1212
public interface IServiceEndpointBuilder
1313
{

src/Libraries/Microsoft.Extensions.ServiceDiscovery.Dns/DnsServiceEndpointProviderOptions.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ public class DnsServiceEndpointProviderOptions
2929
public double RetryBackOffFactor { get; set; } = 2;
3030

3131
/// <summary>
32-
/// Gets or sets a delegate used to determine whether to apply host name metadata to each resolved endpoint. Defaults to <c>false</c>.
32+
/// Gets or sets a delegate used to determine whether to apply host name metadata to each resolved endpoint.
3333
/// </summary>
34+
/// <value>
35+
/// The default delegate returns <see langword="false"/>.
36+
/// </value>
3437
public Func<ServiceEndpoint, bool> ShouldApplyHostNameMetadata { get; set; } = _ => false;
3538
}

src/Libraries/Microsoft.Extensions.ServiceDiscovery.Dns/DnsSrvServiceEndpointProviderOptions.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@ public class DnsSrvServiceEndpointProviderOptions
4242
public Func<ServiceEndpointQuery, string>? ServiceDomainNameCallback { get; set; }
4343

4444
/// <summary>
45-
/// Gets or sets a delegate used to determine whether to apply host name metadata to each resolved endpoint. Defaults to <c>false</c>.
45+
/// Gets or sets a delegate used to determine whether to apply host name metadata to each resolved endpoint.
4646
/// </summary>
47+
/// <value>
48+
/// The default delegate returns <see langword="false"/>.
49+
/// </value>
4750
public Func<ServiceEndpoint, bool> ShouldApplyHostNameMetadata { get; set; } = _ => false;
4851
}

src/Libraries/Microsoft.Extensions.ServiceDiscovery/ConfigurationServiceEndpointProviderOptions.cs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,18 @@ namespace Microsoft.Extensions.ServiceDiscovery;
1111
public sealed class ConfigurationServiceEndpointProviderOptions
1212
{
1313
/// <summary>
14-
/// The name of the configuration section which contains service endpoints. Defaults to <c>"Services"</c>.
14+
/// Gets or sets the name of the configuration section that contains service endpoints.
1515
/// </summary>
16+
/// <value>
17+
/// The default value is <c>"Services"</c>.
18+
/// </value>
1619
public string SectionName { get; set; } = "Services";
1720

1821
/// <summary>
19-
/// Gets or sets a delegate used to determine whether to apply host name metadata to each resolved endpoint. Defaults to a delegate which returns <c>false</c>.
22+
/// Gets or sets a delegate used to determine whether to apply host name metadata to each resolved endpoint.
2023
/// </summary>
24+
/// <value>
25+
/// The default delegate returns <see langword="false"/>.
26+
/// </value>
2127
public Func<ServiceEndpoint, bool> ShouldApplyHostNameMetadata { get; set; } = _ => false;
2228
}

src/Libraries/Microsoft.Extensions.ServiceDiscovery/Http/IServiceDiscoveryHttpMessageHandlerFactory.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
namespace Microsoft.Extensions.ServiceDiscovery.Http;
55

66
/// <summary>
7-
/// Factory which creates <see cref="HttpMessageHandler"/> instances which resolve endpoints using service discovery
7+
/// Represents a factory that creates <see cref="HttpMessageHandler"/> instances that resolve endpoints using service discovery
88
/// before delegating to a provided handler.
99
/// </summary>
1010
public interface IServiceDiscoveryHttpMessageHandlerFactory
1111
{
1212
/// <summary>
13-
/// Creates an <see cref="HttpMessageHandler"/> instance which resolve endpoints using service discovery before
13+
/// Creates an <see cref="HttpMessageHandler"/> instance that resolves endpoints using service discovery before
1414
/// delegating to a provided handler.
1515
/// </summary>
1616
/// <param name="handler">The handler to delegate to.</param>

src/Libraries/Microsoft.Extensions.ServiceDiscovery/Internal/ServiceEndpointResolverResult.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ internal sealed class ServiceEndpointResolverResult(ServiceEndpointSource? endpo
1818
public Exception? Exception { get; } = exception;
1919

2020
/// <summary>
21-
/// Gets a value indicating whether resolution completed successfully.
21+
/// Gets a value that indicates whether resolution completed successfully.
2222
/// </summary>
2323
[MemberNotNullWhen(true, nameof(EndpointSource))]
2424
public bool ResolvedSuccessfully => Exception is null;

src/Libraries/Microsoft.Extensions.ServiceDiscovery/ServiceDiscoveryOptions.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ namespace Microsoft.Extensions.ServiceDiscovery;
1212
public sealed class ServiceDiscoveryOptions
1313
{
1414
/// <summary>
15-
/// Gets or sets a value indicating whether all URI schemes for URIs resolved by the service discovery system are allowed.
16-
/// If this value is <see langword="true"/>, all URI schemes are allowed.
17-
/// If this value is <see langword="false"/>, only the schemes specified in <see cref="AllowedSchemes"/> are allowed.
15+
/// Gets or sets a value that indicates whether all URI schemes for URIs resolved by the service discovery system are allowed.
1816
/// </summary>
17+
/// <value>
18+
/// <see langword="true"/> to allow all URI schemes; <see langword="false"/> to allow only schemes specified in <see cref="AllowedSchemes"/>.
19+
/// </value>
1920
public bool AllowAllSchemes { get; set; } = true;
2021

2122
/// <summary>

0 commit comments

Comments
 (0)