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.
2026-07-07 11:03:26 -04:00
parent 67005ca4c0
commit 9cff87fe85
435 changed files with 2338 additions and 2547 deletions
@@ -6,7 +6,7 @@ using ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Entities;
 namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Configurations;

 /// <summary>
-/// Maps the C5 (Task 2.5) <see cref="AuditLogRow"/> persistence shape to the central
+/// Maps the <see cref="AuditLogRow"/> persistence shape to the central
 /// <c>dbo.AuditLog</c> table: the 10 canonical <c>ZB.MOM.WW.Audit.AuditEvent</c> columns
 /// (writable) plus six read-only, server-side <b>computed columns</b> derived from
 /// <c>DetailsJson</c> via <c>JSON_VALUE</c> — five PERSISTED (<c>Kind</c>/<c>Status</c>/
@@ -96,7 +96,7 @@ public class AuditLogEntityTypeConfiguration : IEntityTypeConfiguration<AuditLog
        builder.Property(e => e.Target)
            .HasMaxLength(256);

-        // SourceNode (Audit Log #23, SourceNode-stamping): node-local identifier of the
+        // SourceNode (SourceNode-stamping): node-local identifier of the
        // cluster member that produced the row (e.g. "node-a", "central-a"). NULL is
        // valid for reconciled rows from a retired node and for direct-write rows
        // produced before this feature shipped. ASCII — varchar(64), no unicode.
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Entities.InboundApi;

 namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Configurations;

-// Auth re-arch (C5): the SQL Server ApiKey entity was retired — inbound API keys now
+// The SQL Server ApiKey entity was retired — inbound API keys now
 // live in the shared ZB.MOM.WW.Auth.ApiKeys SQLite store. The former
 // ApiKeyConfiguration (and the ApiMethod.ApprovedApiKeyIds mapping) were removed; the
 // ApiKeys table + ApprovedApiKeyIds column are dropped by the RetireInboundApiKeyStore
@@ -5,8 +5,8 @@ using ZB.MOM.WW.ScadaBridge.Commons.Entities.Kpi;
 namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Configurations;

 /// <summary>
-/// Maps the <see cref="KpiSample"/> POCO to the central <c>KpiSample</c> table
-/// (M6 "KPI History &amp; Trends") — the tall / EAV row written by the recorder
+/// Maps the <see cref="KpiSample"/> POCO to the central <c>KpiSample</c> table —
+/// the tall / EAV row written by the recorder
 /// singleton. Operational history, NOT audit, so the table is non-partitioned,
 /// standard <c>[PRIMARY]</c> filegroup, no DB-role restriction.
 /// </summary>
@@ -87,7 +87,7 @@ public class SmsConfigurationConfiguration : IEntityTypeConfiguration<SmsConfigu

        // The non-parameter constructor seeds ConnectionTimeoutSeconds/MaxRetries/RetryDelay
        // with sensible defaults; mapping them as REQUIRED columns preserves round-trip
-        // fidelity for those values (S1 review note).
+        // fidelity for those values.
        builder.Property(s => s.ConnectionTimeoutSeconds)
            .IsRequired();

@@ -49,21 +49,21 @@ public class NotificationOutboxConfiguration : IEntityTypeConfiguration<Notifica

        builder.Property(n => n.SourceScript).HasMaxLength(200);

-        // SourceNode (Audit Log #23, SourceNode-stamping): node-local identifier of the
+        // SourceNode: node-local identifier of the
        // cluster member that produced the notification (e.g. "node-a", "central-a").
        // NULL is valid for rows that pre-date this feature. ASCII — varchar(64).
        // No index — KPIs are per-site on this table, not per-node; SourceNode is only
-        // echoed onto NotifyDeliver audit rows (#23) for cross-row correlation.
+        // echoed onto NotifyDeliver audit rows for cross-row correlation.
        builder.Property(n => n.SourceNode)
            .HasColumnType("varchar(64)")
            .HasMaxLength(64)
            .IsUnicode(false);

-        // OriginExecutionId (Audit Log #23): nullable uniqueidentifier carried from the
+        // OriginExecutionId: nullable uniqueidentifier carried from the
        // site so the dispatcher can echo it onto NotifyDeliver audit rows. No index —
        // it is never a query predicate on this table, only copied onto audit events.

-        // OriginParentExecutionId (Audit Log #23): nullable uniqueidentifier carried from
+        // OriginParentExecutionId: nullable uniqueidentifier carried from
        // the site — the routed run's parent ExecutionId — so the dispatcher can echo it
        // onto NotifyDeliver audit rows. No index — same rationale as OriginExecutionId.

@@ -6,7 +6,7 @@ namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Configurations;

 /// <summary>
 /// Maps the <see cref="PendingSecuredWrite"/> entity to the central
-/// <c>PendingSecuredWrites</c> table (M7 OPC UA / MxGateway UX, Task T14b).
+/// <c>PendingSecuredWrites</c> table.
 /// Operational (mutable) state — NOT audit — so the table is non-partitioned,
 /// standard <c>[PRIMARY]</c> filegroup, no DB-role restriction. Two named indexes
 /// back the Central UI's "pending in this status, newest first" and "writes for
@@ -26,7 +26,7 @@ public class LdapGroupMappingConfiguration : IEntityTypeConfiguration<LdapGroupM
        builder.HasIndex(m => m.LdapGroupName).IsUnique();

        // Seed default group mappings matching GLAuth test users.
-        // Role VALUES are the canonical six (Task 1.7): Administrator/Designer/
+        // Role VALUES are the canonical six: Administrator/Designer/
        // Deployer. The LDAP group NAMES (SCADA-Admins etc.) are unchanged —
        // only the role each group maps to was canonicalized.
        builder.HasData(
@@ -5,8 +5,8 @@ using ZB.MOM.WW.ScadaBridge.Commons.Entities.Schemas;
 namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Configurations;

 /// <summary>
-/// Maps the <see cref="SharedSchema"/> entity (M9 template-level JSON-Schema library,
-/// Task T32a). Mirrors <c>SharedScriptConfiguration</c>: surrogate key, a UNIQUE index on
+/// Maps the <see cref="SharedSchema"/> entity (template-level JSON-Schema library).
+/// Mirrors <c>SharedScriptConfiguration</c>: surrogate key, a UNIQUE index on
 /// <see cref="SharedSchema.Name"/>, a bounded <see cref="SharedSchema.Scope"/>, and an
 /// unbounded (<c>nvarchar(max)</c>) <see cref="SharedSchema.SchemaJson"/> body.
 /// Auto-discovered by <c>ApplyConfigurationsFromAssembly</c> in <c>ScadaBridgeDbContext</c>.
@@ -6,8 +6,8 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types;
 namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Configurations;

 /// <summary>
-/// Maps the <see cref="SiteCall"/> record to the central <c>SiteCalls</c> table
-/// (Site Call Audit #22, Audit Log #23 M3 Bundle B). Operational state — NOT audit —
+/// Maps the <see cref="SiteCall"/> record to the central <c>SiteCalls</c> table.
+/// Operational state — NOT audit —
 /// so the table is non-partitioned, standard <c>[PRIMARY]</c> filegroup, no DB-role
 /// restriction. Two named indexes back the Central UI's "from this site" and
 /// "in this status" queries.
@@ -63,7 +63,7 @@ public class SiteCallEntityTypeConfiguration : IEntityTypeConfiguration<SiteCall
        builder.Property(s => s.LastError)
            .HasMaxLength(1024);

-        // SourceNode (Audit Log #23, SourceNode-stamping): node-local identifier of the
+        // SourceNode (SourceNode-stamping): node-local identifier of the
        // cluster member that produced the call (e.g. "node-a", "central-a"). NULL is
        // valid for rows that pre-date this feature and for reconciled rows from a
        // retired node. ASCII — varchar(64). No index — Site Call Audit KPIs are
@@ -182,7 +182,7 @@ public class TemplateScriptConfiguration : IEntityTypeConfiguration<TemplateScri
        builder.Property(s => s.ReturnDefinition)
            .HasMaxLength(4000);

-        // M2.5 (#9): nullable per-script execution timeout (seconds). Null = use
+        // Nullable per-script execution timeout (seconds). Null = use
        // the site's global ScriptExecutionTimeoutSeconds default.
        builder.Property(s => s.ExecutionTimeoutSeconds)
            .IsRequired(false);