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
@@ -3,7 +3,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types;
namespace ZB.MOM.WW.ScadaBridge.Commons.Entities.Audit;
/// <summary>
/// Central operational state row for a cached call (Site Call Audit #22, Audit Log #23 M3).
/// Central operational state row for a cached call.
/// One row per <see cref="TrackedOperationId"/> in the <c>SiteCalls</c> table — append-once
/// then monotonic status update. Status transitions are forward-only
/// (<c>Submitted → Forwarded → Attempted → Delivered|Failed|Parked|Discarded</c>); an
@@ -1,7 +1,7 @@
namespace ZB.MOM.WW.ScadaBridge.Commons.Entities.Deployment;
/// <summary>
/// WP-8: Stores the deployed configuration snapshot for an instance.
/// Stores the deployed configuration snapshot for an instance.
/// Captured at deploy time; compared against template-derived (live flattened) config for staleness detection.
/// </summary>
public class DeployedConfigSnapshot
@@ -50,7 +50,7 @@ public class DeploymentRecord
public string? ErrorMessage { get; set; }
/// <summary>
/// WP-4: Optimistic concurrency token for deployment status updates.
/// Optimistic concurrency token for deployment status updates.
/// </summary>
public byte[] RowVersion { get; set; } = [];
@@ -2,7 +2,7 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Entities.Kpi;
/// <summary>
/// A single point-in-time KPI measurement in the central KPI-history backbone
/// (M6 "KPI History &amp; Trends"). One row per (Source, Metric, Scope, ScopeKey)
/// ("KPI History &amp; Trends"). One row per (Source, Metric, Scope, ScopeKey)
/// captured by the recorder singleton at a sampling instant — a tall / EAV row in
/// the central <c>KpiSample</c> table.
/// </summary>
@@ -48,7 +48,7 @@ public class Notification
public string? SourceScript { get; set; }
/// <summary>
/// The originating script execution's <c>ExecutionId</c> (Audit Log #23). Carried from
/// The originating script execution's <c>ExecutionId</c>. Carried from
/// the site on the <see cref="Commons.Messages.Notification.NotificationSubmit"/> so the
/// central dispatcher can stamp the same id onto its <c>NotifyDeliver</c> audit rows,
/// correlating them with the site-emitted <c>NotifySend</c> row. Null for notifications
@@ -57,7 +57,7 @@ public class Notification
public Guid? OriginExecutionId { get; set; }
/// <summary>
/// The originating routed script execution's <c>ParentExecutionId</c> (Audit Log #23).
/// The originating routed script execution's <c>ParentExecutionId</c>.
/// Carried from the site on the <see cref="Commons.Messages.Notification.NotificationSubmit"/>
/// so the central dispatcher can stamp the same parent id onto its <c>NotifyDeliver</c>
/// audit rows, correlating them with the site-emitted <c>NotifySend</c> row. Null for
@@ -1,10 +1,10 @@
namespace ZB.MOM.WW.ScadaBridge.Commons.Entities.Schemas;
/// <summary>
/// A reusable, named JSON-Schema library entry (M9 template-level JSON-Schema library,
/// Task T32a). Schemas are referenced from inbound-API / template schema definitions via a
/// <c>{"$ref":"lib:Name"}</c> pointer resolved against this library (the resolver lands in
/// T32b). One row per named schema in the central <c>SharedSchemas</c> MS SQL table.
/// A reusable, named JSON-Schema library entry (template-level JSON-Schema library).
/// Schemas are referenced from inbound-API / template schema definitions via a
/// <c>{"$ref":"lib:Name"}</c> pointer resolved against this library. One row per
/// named schema in the central <c>SharedSchemas</c> MS SQL table.
/// </summary>
/// <remarks>
/// Persistence-ignorant POCO; the EF Core mapping lives in the Configuration Database
@@ -2,7 +2,7 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Entities.SecuredWrites;
/// <summary>
/// Central operational state row for a two-person ("secured") write through its
/// lifecycle (M7 OPC UA / MxGateway UX, Task T14b). One row per pending write in the
/// lifecycle. One row per pending write in the
/// central <c>PendingSecuredWrites</c> MS SQL table — append-once at submission then
/// mutated as the request is approved/rejected and executed against the target.
/// </summary>