Fix broken documentation in Steeltoe 3.x (#1654)

Author: bart-vmware

src/Common/src/Common.Http/LoadBalancer/LoadBalancerDelegatingHandler.cs

@@ -20,8 +20,10 @@ public class LoadBalancerDelegatingHandler : DelegatingHandler
     private readonly ILoadBalancer _loadBalancer;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="LoadBalancerDelegatingHandler"/> class. <para />
+    /// Initializes a new instance of the <see cref="LoadBalancerDelegatingHandler"/> class.
+    /// <para>
     /// For use with <see cref="IHttpClientBuilder"/>
+    /// </para>
     /// </summary>
     /// <param name="loadBalancer">Load balancer to use</param>
     public LoadBalancerDelegatingHandler(ILoadBalancer loadBalancer)
@@ -30,8 +32,10 @@ public LoadBalancerDelegatingHandler(ILoadBalancer loadBalancer)
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="LoadBalancerDelegatingHandler"/> class. <para />
+    /// Initializes a new instance of the <see cref="LoadBalancerDelegatingHandler"/> class.
+    /// <para>
     /// For use with <see cref="IHttpClientBuilder"/>
+    /// </para>
     /// </summary>
     /// <param name="loadBalancer">Load balancer to use</param>
     /// <param name="logger">For logging</param>
@@ -42,7 +46,9 @@ public LoadBalancerDelegatingHandler(ILoadBalancer loadBalancer, ILogger logger)
     }
 
     /// <inheritdoc />
-    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+    protected override async Task<HttpResponseMessage> SendAsync(
+        HttpRequestMessage request,
+        CancellationToken cancellationToken)
     {
         // record the original request
         var originalUri = request.RequestUri;
@@ -70,7 +76,8 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
             request.RequestUri = originalUri;
 
             // track stats
-            await _loadBalancer.UpdateStatsAsync(originalUri, resolvedUri, DateTime.UtcNow - startTime, exception).ConfigureAwait(false);
+            await _loadBalancer.UpdateStatsAsync(originalUri, resolvedUri, DateTime.UtcNow - startTime, exception)
+                .ConfigureAwait(false);
         }
     }
 }

src/Common/src/Common.Http/LoadBalancer/LoadBalancerHttpClientHandler.cs

@@ -19,8 +19,10 @@ public class LoadBalancerHttpClientHandler : HttpClientHandler
     private readonly ILoadBalancer _loadBalancer;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="LoadBalancerHttpClientHandler"/> class. <para />
+    /// Initializes a new instance of the <see cref="LoadBalancerHttpClientHandler"/> class.
+    /// <para>
     /// For use with <see cref="HttpClient"/> without <see cref="IHttpClientFactory"/>
+    /// </para>
     /// </summary>
     /// <param name="loadBalancer">Load balancer to use</param>
     public LoadBalancerHttpClientHandler(ILoadBalancer loadBalancer)
@@ -29,8 +31,10 @@ public LoadBalancerHttpClientHandler(ILoadBalancer loadBalancer)
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="LoadBalancerHttpClientHandler"/> class. <para />
+    /// Initializes a new instance of the <see cref="LoadBalancerHttpClientHandler"/> class.
+    /// <para>
     /// For use with <see cref="HttpClient"/> without <see cref="IHttpClientFactory"/>
+    /// </para>
     /// </summary>
     /// <param name="loadBalancer">Load balancer to use</param>
     /// <param name="logger">For logging</param>
@@ -41,7 +45,9 @@ public LoadBalancerHttpClientHandler(ILoadBalancer loadBalancer, ILogger logger)
     }
 
     /// <inheritdoc />
-    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+    protected override async Task<HttpResponseMessage> SendAsync(
+        HttpRequestMessage request,
+        CancellationToken cancellationToken)
     {
         // record the original request
         var originalUri = request.RequestUri;
@@ -69,7 +75,8 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
             request.RequestUri = originalUri;
 
             // track stats
-            await _loadBalancer.UpdateStatsAsync(originalUri, resolvedUri, DateTime.UtcNow - startTime, exception).ConfigureAwait(false);
+            await _loadBalancer.UpdateStatsAsync(originalUri, resolvedUri, DateTime.UtcNow - startTime, exception)
+                .ConfigureAwait(false);
         }
     }
 }

src/Discovery/src/ClientBase/SimpleClients/ConfigurationDiscoveryClientBuilderExtensions.cs

@@ -11,14 +11,15 @@ public static class ConfigurationDiscoveryClientBuilderExtensions
     /// </summary>
     /// <param name="clientBuilder">this</param>
     /// <remarks>
-    ///     Build your list of service instances under the configuration prefix discovery:services<para></para>
-    ///     For example:
-    ///       "discovery": {
-    ///         "services": [
-    ///           { "serviceId": "CartService", "host": "knownhost1", "port": 443, "isSecure": true },
-    ///           { "serviceId": "CartService", "host": "knownhost2", "port": 443, "isSecure": true },
-    ///         ]
-    ///       }
+    /// Build your list of service instances under the configuration prefix <c>discovery:services</c>, for example:
+    /// <code><![CDATA[
+    /// "discovery": {
+    ///   "services": [
+    ///     { "serviceId": "CartService", "host": "knownhost1", "port": 443, "isSecure": true },
+    ///     { "serviceId": "CartService", "host": "knownhost2", "port": 443, "isSecure": true },
+    ///   ]
+    /// }
+    /// ]]></code>
     /// </remarks>
     public static DiscoveryClientBuilder UseConfiguredInstances(this DiscoveryClientBuilder clientBuilder)
     {

src/Discovery/src/Eureka/IEurekaInstanceConfig.cs

@@ -35,27 +35,27 @@ public interface IEurekaInstanceConfig
     bool IsInstanceEnabledOnInit { get; set; }
 
     /// <summary>
-    /// Gets or sets the <code>non-secure</code> port on which the instance should receive traffic.
+    /// Gets or sets the <c>non-secure</c> port on which the instance should receive traffic.
     /// Configuration property: eureka:instance:port
     /// </summary>
     int NonSecurePort { get; set; }
 
     /// <summary>
-    /// Gets or sets the <code>Secure port</code> on which the instance should receive traffic.
+    /// Gets or sets the <c>Secure port</c> on which the instance should receive traffic.
     /// Configuration property: eureka:instance:securePort
     /// </summary>
     int SecurePort { get; set; }
 
     /// <summary>
-    /// Gets or sets a value indicating whether indicates whether the <code>non-secure</code> port should be enabled for traffic or not.
-    /// Set true if the <code>non-secure</code> port is enabled, false otherwise.
+    /// Gets or sets a value indicating whether indicates whether the <c>non-secure</c> port should be enabled for traffic or not.
+    /// Set true if the <c>non-secure</c> port is enabled, false otherwise.
     /// Configuration property: eureka:instance:nonSecurePortEnabled
     /// </summary>
     bool IsNonSecurePortEnabled { get; set; }
 
     /// <summary>
-    /// Gets or sets a value indicating whether indicates whether the <code>secure</code> port should be enabled for traffic or not.
-    /// Set true if the <code>secure</code> port is enabled, false otherwise.
+    /// Gets or sets a value indicating whether indicates whether the <c>secure</c> port should be enabled for traffic or not.
+    /// Set true if the <c>secure</c> port is enabled, false otherwise.
     /// Configuration property: eureka:instance:securePortEnabled
     /// </summary>
     bool SecurePortEnabled { get; set; }
@@ -104,7 +104,7 @@ public interface IEurekaInstanceConfig
     string SecureVirtualHostName { get; set; }
 
     /// <summary>
-    /// Gets or sets the <code>AWS autoscaling group name</code> associated with this instance. This information is
+    /// Gets or sets the <c>AWS autoscaling group name</c> associated with this instance. This information is
     /// specifically used in an AWS environment to automatically put an instance out of service after the instance is
     /// launched and it has been disabled for traffic..
     /// Configuration property: eureka:instance:asgName
@@ -136,7 +136,7 @@ public interface IEurekaInstanceConfig
     /// <see cref="SecurePort"/> and <see cref="NonSecurePort"/>.
     ///
     /// It is normally used for informational purposes for other services to findabout the status of this instance.
-    /// Users can provide a simple <code>HTML</code> indicating what is the current status of the instance.
+    /// Users can provide a simple <c>HTML</c> page indicating what is the current status of the instance.
     /// Configuration property: eureka:instance:statusPageUrlPath
     /// </summary>
     string StatusPageUrlPath { get; set; }
@@ -147,7 +147,7 @@ public interface IEurekaInstanceConfig
     /// users can provide the full URL. If the full URL is provided it takes precedence.
     ///
     /// It is normally used for informational purposes for other services tofind about the status of this instance.
-    /// Users can provide a simple<code>HTML</code> indicating what is the current status of the instance.
+    /// Users can provide a simple <c>HTML</c> page indicating what is the current status of the instance.
     /// The full URL should follow the format http://${eureka.hostname}:7001/ where the value ${eureka.hostname} is
     /// replaced at runtime.
     /// Configuration property: eureka:instance:statusPageUrl
@@ -170,7 +170,7 @@ public interface IEurekaInstanceConfig
     /// provide the full URL. If the full URL is provided it takes precedence.
     ///
     /// It is normally used for informational purposes for other services tofind about the status of this instance.
-    /// Users can provide a simple<code>HTML</code> indicating what is the current status of the instance.
+    /// Users can provide a simple <c>HTML</c> page indicating what is the current status of the instance.
     /// The full URL should follow the format http://${eureka.hostname}:7001/ where the value ${eureka.hostname} is
     /// replaced at runtime.
     /// Configuration property: eureka:instance:homePageUrl