docs(comments): strip internal task/milestone/bundle bookkeeping from code comments

Remove project bookkeeping citations from shipped code comments across the
solution: hyphenated task IDs (WP-14, StoreAndForward-025), milestone/task/
issue refs (M3, Task 4, Audit Log #23, #21), Bundle X task-bundle labels,
and C/D/K/S/T phase labels.

Comment text only — no code logic, string/log literals, or XML-doc structure
changed. Genuine descriptions are preserved (only the citation is stripped),
and technical lookalikes are retained (UTF-8, SHA-256, T00:00:00, M365,
UTC-5, pre-C4/pre-C5 schema versions). Flagged by the new CommentChecker
TaskReferenceInComment / TrackingReferenceInComment checks plus targeted
grep passes; full solution builds clean, append-only guard tests pass.
This commit is contained in:
Joseph Doherty
2026-07-07 11:03:26 -04:00
parent 67005ca4c0
commit 9cff87fe85
435 changed files with 2338 additions and 2547 deletions
@@ -28,7 +28,7 @@ public static class ServiceCollectionExtensions
services.AddCascadingAuthenticationState();
// Resolves the current user's permitted site set from their SiteId claims
// so Deployment/Monitoring pages can enforce site scoping (CentralUI-002).
// so Deployment/Monitoring pages can enforce site scoping.
services.AddScoped<SiteScopeService>();
// Centralised dialog service: pages inject IDialogService and a single
@@ -36,7 +36,7 @@ public static class ServiceCollectionExtensions
// Components/Shared/IDialogService.cs.
services.AddScoped<IDialogService, DialogService>();
// Audit Log (#23 M7-T3): CentralUI facade over IAuditLogRepository so the
// CentralUI facade over IAuditLogRepository so the
// results grid can be tested with a stubbed query source.
//
// Registered with an explicit factory so the IServiceScopeFactory ctor is
@@ -49,11 +49,11 @@ public static class ServiceCollectionExtensions
sp.GetRequiredService<IServiceScopeFactory>(),
sp.GetRequiredService<ICentralHealthAggregator>()));
// Audit Log (#23 M7-T14 / Bundle F): server-side streaming CSV export.
// Server-side streaming CSV export.
// Backs the Audit Log page's Export button via GET /api/centralui/audit/export.
services.AddScoped<IAuditLogExportService, AuditLogExportService>();
// KPI History (M6, K11): CentralUI facade over IKpiHistoryRepository that
// CentralUI facade over IKpiHistoryRepository that
// fetches a raw series and reduces it with KpiSeriesBucketer for the trend chart.
//
// Registered with an explicit factory so the IServiceScopeFactory ctor is
@@ -66,21 +66,21 @@ public static class ServiceCollectionExtensions
sp.GetRequiredService<IServiceScopeFactory>(),
sp.GetRequiredService<IOptions<KpiHistoryOptions>>()));
// OPC UA Tag Browser (Task 14): facade over CommunicationService.BrowseNodeAsync
// OPC UA Tag Browser: facade over CommunicationService.BrowseNodeAsync
// that enforces the CentralUI-side Design-role trust boundary and translates
// transport failures into typed BrowseFailure results for the dialog.
services.AddScoped<IBrowseService, BrowseService>();
// Verify Endpoint (M7 T17): facade over CommunicationService.VerifyEndpointAsync
// Verify Endpoint: facade over CommunicationService.VerifyEndpointAsync
// that enforces the same CentralUI-side Design-role trust boundary as the browse
// service, serializes the in-progress endpoint config, and translates transport
// failures into typed VerifyEndpointResults. Backs the "Verify endpoint" button
// on the OPC UA endpoint editor (read-only connect probe, never trusts certs).
services.AddScoped<IEndpointVerificationService, EndpointVerificationService>();
// OPC UA Cert Management (M7 T17 / D6): facade over the three
// OPC UA Cert Management: facade over the three
// CommunicationService cert-trust relay methods. Enforces the CentralUI-side
// role trust boundary (D7: Trust + Remove require Administrator, List requires
// role trust boundary (Trust + Remove require Administrator, List requires
// Designer) and translates transport failures into typed CertTrustResults.
// Backs the "Trust certificate" button on the OPC UA endpoint editor and the
// connection-certificates management page (node-wide site PKI store).
@@ -93,7 +93,7 @@ public static class ServiceCollectionExtensions
// connection).
services.AddScoped<IBindingTester, BindingTester>();
// Operator Alarm Summary (M7 T13): read-only page that aggregates the
// Operator Alarm Summary: read-only page that aggregates the
// current alarms across a site's Enabled instances. The service fans out
// one debug snapshot per instance via IInstanceSnapshotClient — a thin
// facade over CommunicationService.RequestDebugSnapshotAsync (the same
@@ -101,7 +101,7 @@ public static class ServiceCollectionExtensions
services.AddScoped<IInstanceSnapshotClient, CommunicationInstanceSnapshotClient>();
services.AddScoped<IAlarmSummaryService, AlarmSummaryService>();
// Secured Writes (M7 T14b): dispatches the two-person secured-write commands
// Secured Writes: dispatches the two-person secured-write commands
// (submit / approve / reject / list) to the central ManagementActor through the
// in-process ManagementActorHolder seam — the same Ask path the HTTP /management
// endpoint uses. The server stays the single enforcer of role gating,
@@ -109,14 +109,14 @@ public static class ServiceCollectionExtensions
// and the append-only audit trail; the page only SUBMITS commands.
services.AddScoped<ISecuredWriteService, SecuredWriteService>();
// Connection live-status (M9-T25): projects the per-site health reports'
// Connection live-status: projects the per-site health reports'
// name-keyed connection statuses onto a connection-id → ConnectionHealth map
// so the design DataConnections page can render a live badge per connection
// node. Reuses the existing site→central health transport via
// ICentralHealthAggregator — no new plumbing.
services.AddScoped<IConnectionHealthQueryService, ConnectionHealthQueryService>();
// Move-data-connection (M9-T24b): dispatches MoveDataConnectionCommand to the
// Move-data-connection: dispatches MoveDataConnectionCommand to the
// central ManagementActor through the in-process ManagementActorHolder seam —
// the same Ask path the HTTP /management endpoint uses. The server stays the
// single enforcer of the Designer gate and every move guard (target exists, no
@@ -124,8 +124,8 @@ public static class ServiceCollectionExtensions
// the move dialog only SUBMITS the command and renders the returned outcome.
services.AddScoped<IDataConnectionMoveService, DataConnectionMoveService>();
// Schema Library (M9-T32c): authoring + read accessors for the reusable named
// JSON-Schema library (SharedSchema + ISharedSchemaRepository, T32a).
// Schema Library: authoring + read accessors for the reusable named
// JSON-Schema library (SharedSchema + ISharedSchemaRepository).
//
// ISchemaLibraryService dispatches the CRUD commands to the central
// ManagementActor through the in-process ManagementActorHolder seam — the same
@@ -134,21 +134,21 @@ public static class ServiceCollectionExtensions
// validation; the page only SUBMITS commands.
services.AddScoped<ISchemaLibraryService, SchemaLibraryService>();
// ISchemaLibraryQueryService is the READ counterpart that T30's schema-driven
// ISchemaLibraryQueryService is the READ counterpart that the schema-driven
// value-entry forms reuse to resolve {"$ref":"lib:Name"} pointers — a name →
// schema-JSON map backed by ISharedSchemaRepository over a fresh DI scope per
// query (mirroring the AuditLog / KPI query services, off the circuit-scoped
// DbContext). Read-only; no mutation goes through it.
services.AddScoped<ISchemaLibraryQueryService, SchemaLibraryQueryService>();
// Template inheritance preview (M9-T26b): a read-only facade that dispatches
// Template inheritance preview: a read-only facade that dispatches
// GetResolvedTemplateMembersCommand to the central ManagementActor through the
// in-process ManagementActorHolder seam (same Ask path as the HTTP /management
// endpoint). Powers the template editor's FULL transitively-inherited member set
// + base-changed staleness banner; never mutates rows, not on the deploy path.
services.AddScoped<ITemplateInheritanceQueryService, TemplateInheritanceQueryService>();
// SMS Notifications (S7): the NotificationListForm Type selector offers only the
// SMS Notifications: the NotificationListForm Type selector offers only the
// notification channels that actually have a registered delivery adapter. The
// catalog projects the registered INotificationDeliveryAdapter set (Email + SMS,
// registered scoped by AddNotificationOutbox into this same container) to its