improve summary comments

Author: phnx47

src/IMetricServer.cs

@@ -1,22 +1,22 @@
 namespace Prometheus.Client.MetricServer;
 
 /// <summary>
-///     MetricSever
+/// Interface for the metrics server.
 /// </summary>
 public interface IMetricServer
 {
     /// <summary>
-    ///     Server is Running?
+    /// Get a value indicating whether the server is currently running.
     /// </summary>
     bool IsRunning { get; }
 
     /// <summary>
-    ///     Start server
+    /// Start the metrics server.
     /// </summary>
     void Start();
 
     /// <summary>
-    ///     Stop server
+    /// Stop the metrics server.
     /// </summary>
     void Stop();
 }

src/MetricServer.cs

@@ -9,54 +9,46 @@
 
 namespace Prometheus.Client.MetricServer;
 
-/// <inheritdoc cref="IMetricServer" />
 /// <summary>
-///     MetricSever based of Kestrel
+/// Kestrel-based implementation of the metrics server.
 /// </summary>
 public class MetricServer : IMetricServer
 {
     private readonly MetricServerOptions _options;
     private IWebHost _host;
 
     /// <summary>
-    ///     Constructor
+    /// Initialize a new instance of the <see cref="MetricServer"/> class with default options.
     /// </summary>
     public MetricServer()
         : this(new MetricServerOptions())
     {
     }
 
     /// <summary>
-    ///     Constructor
+    /// Initialize a new instance of the <see cref="MetricServer"/> class with the specified options.
     /// </summary>
+    /// <param name="options">The server configuration options.</param>
     public MetricServer(MetricServerOptions options)
     {
         ArgumentNullException.ThrowIfNull(options);
-
         if (!options.MapPath.StartsWith('/'))
             options.MapPath = "/" + options.MapPath;
-
         _options = options;
-
         _options.CollectorRegistry ??= Metrics.DefaultCollectorRegistry;
-
         if (_options.UseDefaultCollectors)
             options.CollectorRegistry.UseDefaultCollectors(options.MetricPrefixName);
     }
 
-    /// <inheritdoc />
     public bool IsRunning => _host != null;
 
-    /// <inheritdoc />
     public void Start()
     {
         if (IsRunning)
             return;
-
         var configBuilder = new ConfigurationBuilder();
         configBuilder.Properties["parent"] = this;
         var config = configBuilder.Build();
-
         _host = new WebHostBuilder()
             .UseConfiguration(config)
             .UseKestrel(options =>
@@ -68,16 +60,13 @@ public void Start()
             .ConfigureServices(services => { services.AddSingleton<IStartup>(new Startup(_options)); })
             .UseSetting(WebHostDefaults.ApplicationKey, typeof(Startup).GetTypeInfo().Assembly.FullName)
             .Build();
-
         _host.Start();
     }
 
-    /// <inheritdoc />
     public void Stop()
     {
         if (!IsRunning)
             return;
-
         _host.Dispose();
         _host = null;
     }
@@ -101,14 +90,12 @@ public void Configure(IApplicationBuilder app)
             var contentType = _options.ResponseEncoding != null
                 ? $"{Defaults.ContentType}; charset={_options.ResponseEncoding.BodyName}"
                 : Defaults.ContentType;
-
             app.Map(_options.MapPath, coreapp =>
             {
                 coreapp.Run(async context =>
                 {
                     var response = context.Response;
                     response.ContentType = contentType;
-
                     await using var outputStream = response.Body;
                     await ScrapeHandler.ProcessAsync(_options.CollectorRegistry, outputStream);
                 });

src/MetricServerOptions.cs

@@ -1,52 +1,51 @@
-using System;
 using System.Security.Cryptography.X509Certificates;
 using System.Text;
 using Prometheus.Client.Collectors;
 
 namespace Prometheus.Client.MetricServer;
 
 /// <summary>
-///     Metric Server Options
+/// Configuration options for the metrics server.
 /// </summary>
 public class MetricServerOptions
 {
     /// <summary>
-    ///     Host name
+    /// The hostname to bind the server to. Default is "*".
     /// </summary>
     public string Host { get; set; } = "*";
 
     /// <summary>
-    ///     Port number to listen
+    /// The port number to listen on. Default is 5000.
     /// </summary>
     public int Port { get; set; } = 5000;
 
     /// <summary>
-    ///     Endpoint path
+    /// The endpoint path for metrics. Default is "/metrics".
     /// </summary>
     public string MapPath { get; set; } = Defaults.MapPath;
 
     /// <summary>
-    ///     Https certificate
+    /// The HTTPS certificate.
     /// </summary>
     public X509Certificate2 Certificate { get; set; }
 
     /// <summary>
-    ///     Collector Registry instance
+    /// The <see cref="ICollectorRegistry"/> instance to use for metric collection.
     /// </summary>
     public ICollectorRegistry CollectorRegistry { get; set; }
 
     /// <summary>
-    ///     Use default collectors(dotnet and process stats)
+    /// Whether to register default collectors. Default is <c>true</c>.
     /// </summary>
     public bool UseDefaultCollectors { get; set; } = true;
 
     /// <summary>
-    ///     Charset of text response.
+    /// The text encoding for response content.
     /// </summary>
     public Encoding ResponseEncoding { get; set; }
 
     /// <summary>
-    ///     Metric prefix for Default collectors
+    /// Metric name prefix for default collectors.
     /// </summary>
     public string MetricPrefixName { get; set; } = string.Empty;
 }