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
@@ -5,7 +5,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;
 namespace ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;

 /// <summary>
-/// Append-only data access for the central <c>AuditLog</c> table (Audit Log #23).
+/// Append-only data access for the central <c>AuditLog</c> table.
 /// </summary>
 /// <remarks>
 /// <para>
@@ -65,7 +65,7 @@ public interface IAuditLogRepository
    /// EventId uniqueness — required by <see cref="InsertIfNotExistsAsync"/> —
    /// can be enforced cheaply). SQL Server rejects
    /// <c>ALTER TABLE … SWITCH PARTITION</c> while a non-aligned unique index
-    /// is present, so the M6 implementation drops the index, creates a staging
+    /// is present, so the implementation drops the index, creates a staging
    /// table with byte-identical schema, switches the partition's data into
    /// staging, drops staging (discarding the rows), and rebuilds the unique
    /// index. The CATCH branch guarantees the index is rebuilt even on partial
@@ -88,7 +88,7 @@ public interface IAuditLogRepository
    Task<long> SwitchOutPartitionAsync(DateTime monthBoundary, CancellationToken ct = default);

    /// <summary>
-    /// M5.5 (T3) per-channel retention override purge. Deletes <c>AuditLog</c> rows for a
+    /// Per-channel retention override purge. Deletes <c>AuditLog</c> rows for a
    /// single <paramref name="channel"/> (matched against the canonical
    /// <c>Category</c> column — the bare channel name, e.g. <c>ApiOutbound</c>) whose
    /// <c>OccurredAtUtc</c> is strictly older than <paramref name="threshold"/>, in
@@ -128,7 +128,7 @@ public interface IAuditLogRepository
    /// boundaries whose partitions contain only rows with
    /// <see cref="AuditEvent.OccurredAtUtc"/> strictly older than
    /// <paramref name="threshold"/>. Boundaries whose partition is empty are
-    /// excluded (a no-op switch is wasted work). Used by the M6 purge actor
+    /// excluded (a no-op switch is wasted work). Used by the purge actor
    /// to enumerate retention-eligible months on every tick.
    /// </summary>
    /// <param name="threshold">Only partitions whose data is entirely older than this UTC datetime are returned.</param>
@@ -139,7 +139,7 @@ public interface IAuditLogRepository
        CancellationToken ct = default);

    /// <summary>
-    /// Audit Log (#23) M7 Bundle E (T13) — returns aggregate counts over the
+    /// Returns aggregate counts over the
    /// trailing <paramref name="window"/> driving the central Health
    /// dashboard's Audit KPI tiles.
    /// </summary>
@@ -185,7 +185,7 @@ public interface IAuditLogRepository
        CancellationToken ct = default);

    /// <summary>
-    /// Audit Log ParentExecutionId feature (Task 8) — given any
+    /// Audit Log ParentExecutionId feature — given any
    /// <paramref name="executionId"/> in an execution chain, returns the whole
    /// chain rooted at the topmost ancestor: one <see cref="ExecutionTreeNode"/>
    /// per distinct execution, summarising its <c>AuditLog</c> rows. The Central
@@ -239,7 +239,7 @@ public interface IAuditLogRepository
    Task<IReadOnlyList<string>> GetDistinctSourceNodesAsync(CancellationToken ct = default);

    /// <summary>
-    /// M5.6 (T5) one-time operational backfill: sets <c>SourceNode</c> to
+    /// One-time operational backfill: sets <c>SourceNode</c> to
    /// <paramref name="sentinel"/> on every row where <c>SourceNode IS NULL</c>
    /// and <c>OccurredAtUtc &lt; <paramref name="before"/></c>, in bounded
    /// batches of <paramref name="batchSize"/> rows, looping until no further
@@ -107,7 +107,7 @@ public interface IDeploymentManagerRepository
    /// <returns>A task representing the asynchronous operation.</returns>
    Task DeleteSystemArtifactDeploymentAsync(int id, CancellationToken cancellationToken = default);

-    // WP-8: DeployedConfigSnapshot
+    // DeployedConfigSnapshot
    /// <summary>
    /// Gets the deployed config snapshot for an instance.
    /// </summary>
@@ -17,7 +17,7 @@ public interface IExternalSystemRepository
    /// Returns the external system with the given name, or <c>null</c> if no such
    /// system exists. A name-keyed lookup so hot-path resolution (e.g. a script's
    /// <c>ExternalSystem.Call()</c>) does not have to fetch every system and filter
-    /// in memory on each call (ExternalSystemGateway-011).
+    /// in memory on each call.
    /// </summary>
    /// <param name="name">The external system name.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
@@ -68,7 +68,7 @@ public interface IExternalSystemRepository
    /// Returns the method with the given name belonging to the given external system,
    /// or <c>null</c> if no such method exists. A name-keyed lookup so hot-path
    /// resolution does not have to fetch every method of the system and filter in
-    /// memory on each call (ExternalSystemGateway-011).
+    /// memory on each call.
    /// </summary>
    /// <param name="externalSystemId">The external system ID.</param>
    /// <param name="methodName">The method name.</param>
@@ -121,8 +121,7 @@ public interface IExternalSystemRepository
    /// Returns the database connection definition with the given name, or <c>null</c>
    /// if no such connection exists. A name-keyed lookup so hot-path resolution (e.g.
    /// a script's <c>Database.Connection()</c> / <c>Database.CachedWrite()</c>) does
-    /// not have to fetch every connection and filter in memory on each call
-    /// (ExternalSystemGateway-011).
+    /// not have to fetch every connection and filter in memory on each call.
    /// </summary>
    /// <param name="name">The database connection name.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
@@ -4,7 +4,7 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;

 public interface IInboundApiRepository
 {
-    // ApiKey persistence retired (re-arch C5): inbound API keys live in the shared
+    // ApiKey persistence retired: inbound API keys live in the shared
    // ZB.MOM.WW.Auth.ApiKeys SQLite store, not the SQL Server configuration DB. The
    // former GetApiKeyByIdAsync / GetAllApiKeysAsync / GetApiKeyByValueAsync /
    // AddApiKeyAsync / UpdateApiKeyAsync / DeleteApiKeyAsync / GetApprovedKeysForMethodAsync
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Kpi;
 namespace ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;

 /// <summary>
-/// Data access for the central KPI-history backbone (M6 "KPI History &amp; Trends")
+/// Data access for the central KPI-history backbone ("KPI History &amp; Trends")
 /// — the tall / EAV <c>KpiSample</c> table in central MS SQL. Backs the recorder
 /// singleton's bulk write, the bucketed query path that feeds the reusable trend
 /// chart, and the retention purge. Implementation lives in the Configuration
@@ -3,10 +3,10 @@ using ZB.MOM.WW.ScadaBridge.Commons.Entities.SecuredWrites;
 namespace ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;

 /// <summary>
-/// Operational-state data access for the central <c>PendingSecuredWrites</c> table
-/// (M7 OPC UA / MxGateway UX, Task T14b). One row per pending two-person secured
+/// Operational-state data access for the central <c>PendingSecuredWrites</c> table.
+/// One row per pending two-person secured
 /// write; rows are inserted at submission and mutated as the request is decided and
-/// executed. Mirrors the <c>SiteCalls</c> (Site Call Audit #22) repository shape.
+/// executed. Mirrors the <c>SiteCalls</c> repository shape.
 /// </summary>
 public interface ISecuredWriteRepository
 {
@@ -58,8 +58,8 @@ public interface ISecuredWriteRepository
    /// <summary>
    /// Atomically flips a row from <c>Pending</c> to <c>Approved</c>, stamping the
    /// verifier identity, comment, and decision time, but ONLY if the row is still
-    /// <c>Pending</c>. This is the compare-and-swap guard for the two-verifier race
-    /// (M7 / T14b): two verifiers may approve the same write concurrently, but the
+    /// <c>Pending</c>. This is the compare-and-swap guard for the two-verifier race:
+    /// two verifiers may approve the same write concurrently, but the
    /// conditional <c>WHERE Status='Pending'</c> guarantees exactly one wins. The
    /// loser observes <c>false</c> and must not relay the write.
    /// </summary>
@@ -3,10 +3,10 @@ using ZB.MOM.WW.ScadaBridge.Commons.Entities.Schemas;
 namespace ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;

 /// <summary>
-/// Data access for the central <c>SharedSchemas</c> JSON-Schema library table
-/// (M9 template-level JSON-Schema library, Task T32a). One row per named schema; the
+/// Data access for the central <c>SharedSchemas</c> JSON-Schema library table.
+/// One row per named schema; the
 /// unique <see cref="SharedSchema.Name"/> is the lookup key used by the <c>lib:Name</c>
-/// <c>$ref</c> resolver (T32b).
+/// <c>$ref</c> resolver.
 /// </summary>
 public interface ISharedSchemaRepository
 {
@@ -5,15 +5,15 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;
 namespace ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;

 /// <summary>
-/// Operational-state data access for the central <c>SiteCalls</c> table
-/// (Site Call Audit #22, Audit Log #23 M3 Bundle B). One row per
+/// Operational-state data access for the central <c>SiteCalls</c> table.
+/// One row per
 /// <see cref="TrackedOperationId"/>; sites remain the source of truth and this
 /// table is an eventually-consistent mirror fed by best-effort gRPC telemetry
 /// plus periodic reconciliation pulls.
 /// </summary>
 /// <remarks>
 /// <para>
-/// Unlike the partitioned append-only <c>AuditLog</c> (M1), this table holds
+/// Unlike the partitioned append-only <c>AuditLog</c>, this table holds
 /// mutable operational state. <see cref="UpsertAsync"/> is insert-if-not-exists
 /// then monotonic update — a status update with rank less than or equal to the
 /// stored status is a silent no-op so out-of-order telemetry, duplicate gRPC
@@ -21,8 +21,8 @@ public interface ITemplateEngineRepository
    /// Bulk variant of <see cref="GetTemplateWithChildrenAsync(int, CancellationToken)"/>
    /// that fetches every template whose <see cref="Template.Name"/> matches one of
    /// <paramref name="names"/> in a single SQL/EF query, eager-loading
-    /// Attributes / Alarms / Scripts / Compositions. Resolves the Transport-008
-    /// N+1 in <c>BundleImporter.PreviewAsync</c> — names that don't match an
+    /// Attributes / Alarms / Scripts / Compositions. Resolves the N+1
+    /// in <c>BundleImporter.PreviewAsync</c> — names that don't match an
    /// existing template are omitted from the result rather than producing a
    /// null entry, so callers should look up by name into the returned list.
    /// </summary>