docs: Add XML documentation comments to API layer

Add missing XML doc comments to resolve CS1591 warnings:

  - SerilogConfiguration: Class comment

  - SwaggerConfiguration: Class and AddSwaggerDocumentation() method

  - ExceptionHandlingMiddleware: Constructor and InvokeAsync() method

  - RequestLoggingMiddleware: Placeholder class comment

  - TenantResolutionMiddleware: Placeholder class comment

  - Program: Partial class comment for integration test access

Result: 0 CS1591 warnings in DocumentOperator.API project
This commit is contained in:
2026-07-07 18:56:23 +02:00
parent 8b154e7378
commit 077eb1e017
6 changed files with 33 additions and 3 deletions

View File

@@ -3,7 +3,6 @@ using DocumentOperator.Infrastructure.Configuration;
using DocumentOperator.Application;
using DocumentOperator.Infrastructure;
using DocumentOperator.API.Middleware;
using DocumentOperator.API.Endpoints.v1;
using DocumentOperator.API.Configuration;
var builder = WebApplication.CreateBuilder(args);
@@ -41,6 +40,7 @@ try
builder.Services.AddApplication(); // Application Layer (MediatR, FluentValidation, Behaviors)
builder.Services.AddInfrastructure(); // Infrastructure Layer (DevExpress, Services)
builder.Services.AddControllers(); // Controllers (Controller-based API)
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerDocumentation();
@@ -67,9 +67,9 @@ try
app.UseHttpsRedirection();
// ========================================
// 6. Endpoints (Minimal API)
// 6. Endpoints (Controller-based API)
// ========================================
app.MapDocumentEndpoints(); // POST /api/v1/documents/validate
app.MapControllers(); // Maps all [ApiController] controllers
Log.Information("DocumentOperator API started successfully");
@@ -86,4 +86,8 @@ finally
}
// Make Program class accessible for Integration Tests
/// <summary>
/// Entry point class for the DocumentOperator API.
/// Made partial and public for integration test access.
/// </summary>
public partial class Program { }