docs: XML documentation pass across Domain, Service & API public surface - #105
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds XML documentation comments (
/// <summary>,<param>,<returns>,<inheritdoc />)across the entire public surface of the backend. This is a comments-only change —
zero logic was touched in any file. The goal is richer IntelliSense for the team and
auto-generated endpoint/model descriptions in Swagger UI.
Why
to no inline documentation.
GenerateDocumentationFileis enabled forDocAnalytics.DomainandDocAnalytics.Service,and Swagger is wired to pull XML from all
DocAnalytics.*.xmlassemblies — but the doc fileswere mostly empty of summaries.
What changed (by layer)
Domain (
DocAnalytics.Domain)ItemCategory, ActivityLog, AlertNotification, AlertRule, DocumentType, ErrorCatalog,
Site, Tenant, Transaction, User, UserSiteAccess, LoginAttempt, RefreshToken).
ITenantScoped,ICurrentUser— summaries explain the globalquery-filter / tenancy contract they enforce.
Service (
DocAnalytics.Service)Dashboard, Errors, Extraction, Files, Health, Invoices, Provisioning, Realtime, Storage, Uploads.
/// <inheritdoc />to avoid duplication.PagedResult<T>,OneOfAttribute,DateTimeExtensions) documented.API (
DocAnalytics.Api)PipelineHub,SignalRPipelineNotifier), Common (ApiResponse<T>,BaseController,CurrentUser), Auth (JwtSettings), Configuration (rate-limiting +security options/extensions), Extensions (
ApiServiceExtensions,ValidationExtensions),Middleware (exception handling, security headers, tenant/site), BackgroundServices
(
ExtractionWorker,AlertEvaluationBackgroundService), and the Swagger operation filter.Doc style
Consistent with an application (not a public library):
<summary>per public member — descriptive, not restating the name.<param>/<returns>where they add clarity (public methods, DI extensions, records)./// <inheritdoc />on interface implementations to keep a single source of truth.Verification
dotnet build -warnaserror:CS1591— build succeeds, zero warnings (proves everypublic member in the doc-file-emitting assemblies is documented).
(
AddSwaggerWithJwt→IncludeXmlCommentsacrossDocAnalytics.*.xml).Risk
Minimal — comments only. No changes to method signatures, control flow, DI registrations,
or runtime behavior.