chore: add XML documentation for public APIs

Adds XML documentation comments for the main public DebugProbe to improve IntelliSense and package usability for consumers.

Author: georgidhristov

DebugProbe.AspNetCore/DebugProbe.AspNetCore.csproj

@@ -4,8 +4,8 @@
 		<TargetFramework>net8.0</TargetFramework>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
-
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
+		<NoWarn>1591</NoWarn>
 
 		<PackageId>DebugProbe.AspNetCore</PackageId>
 		<Version>1.4.1-preview.2</Version>

DebugProbe.AspNetCore/Extensions/DebugProbeExtensions.cs

@@ -13,16 +13,20 @@
 
 namespace DebugProbe.AspNetCore.Extensions;
 
+/// <summary>
+/// Extension methods for configuring DebugProbe.
+/// </summary>
 public static class DebugProbeExtensions
 {
     private static readonly HttpClient Http = new()
     {
         Timeout = TimeSpan.FromSeconds(5)
     };
 
-    public static IServiceCollection AddDebugProbe(
-        this IServiceCollection services,
-        Action<DebugProbeOptions>? configure = null)
+    /// <summary>
+    /// Enables the DebugProbe middleware and dashboard.
+    /// </summary>
+    public static IServiceCollection AddDebugProbe(this IServiceCollection services, Action<DebugProbeOptions>? configure = null)
     {
         var options = new DebugProbeOptions();
         configure?.Invoke(options);
@@ -33,6 +37,9 @@ public static IServiceCollection AddDebugProbe(
         return services;
     }
 
+    /// <summary>
+    /// Registers DebugProbe services.
+    /// </summary>
     public static IApplicationBuilder UseDebugProbe(this IApplicationBuilder app)
     {
         app.UseMiddleware<DebugProbeMiddleware>();
@@ -188,6 +195,4 @@ public static IApplicationBuilder UseDebugProbe(this IApplicationBuilder app)
 
         return app;
     }
-
-   
 }

DebugProbe.AspNetCore/Middleware/DebugProbeMiddleware.cs

@@ -43,12 +43,18 @@ public class DebugProbeMiddleware
     private readonly RequestDelegate _next;
     private readonly DebugProbeOptions _options;
 
+    /// <summary>
+    /// Initializes a new instance of the middleware.
+    /// </summary>
     public DebugProbeMiddleware(RequestDelegate next, DebugProbeOptions options)
     {
         _next = next;
         _options = options;
     }
 
+    /// <summary>
+    /// Processes the current HTTP request.
+    /// </summary>
     public async Task Invoke(HttpContext context, DebugEntryStore store)
     {
         var path = context.Request.Path.Value ?? string.Empty;

DebugProbe.AspNetCore/Options/DebugProbeOptions.cs

@@ -1,13 +1,27 @@
 namespace DebugProbe.AspNetCore.Options;
 
+/// <summary>
+/// Configuration options for DebugProbe.
+/// </summary>
 public class DebugProbeOptions
 {
+    /// <summary>
+    /// Maximum number of stored entries.
+    /// </summary>
     public int MaxEntries { get; set; } = 20;
 
+    /// <summary>
+    /// Maximum captured request or response body size in kilobytes.
+    /// </summary>
     public int MaxBodyCaptureSizeKb { get; set; } = 256;
 
+    /// <summary>
+    /// Allows compare requests to local or private network targets.
+    /// </summary>
     public bool AllowLocalCompareTargets { get; set; }
 
+    /// <summary>
+    /// Additional request paths to ignore.
+    /// </summary>
     public string[] IgnorePaths { get; set; } = [];
-
 }

DebugProbe.AspNetCore/Storage/DebugEntryStore.cs

@@ -9,15 +9,19 @@
 namespace DebugProbe.AspNetCore.Storage;
 
 /// <summary>
-/// In-memory store for DebugEntry instances with a configurable size limit.
+/// Stores captured DebugProbe entries in memory.
 /// </summary>
 public class DebugEntryStore
 {
+    /// <summary>
+    /// Gets environment information for the current application.
+    /// </summary>
     public DebugEnvironment Environment { get; }
 
     private readonly ConcurrentQueue<DebugEntry> _queue = new();
     private readonly int _limit;
 
+
     public DebugEntryStore(DebugProbeOptions options)
     {
         _limit = options.MaxEntries;