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
@@ -8,7 +8,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Kpi;
namespace ZB.MOM.WW.ScadaBridge.SiteCallAudit.Kpi;
/// <summary>
/// Site Call Audit (#22) <see cref="IKpiSampleSource"/> for the M6 "KPI History
/// Site Call Audit <see cref="IKpiSampleSource"/> for the "KPI History
/// &amp; Trends" backbone. Each sampling pass the central recorder enumerates this
/// source and calls <see cref="CollectAsync"/>, which snapshots the same
/// point-in-time <c>SiteCalls</c> KPIs the live Health-dashboard tiles show —
@@ -35,10 +35,10 @@ namespace ZB.MOM.WW.ScadaBridge.SiteCallAudit.Kpi;
/// </remarks>
public sealed class SiteCallAuditKpiSampleSource : IKpiSampleSource
{
// ── Metric catalog (the M6-agreed metric-name strings for this source) ──
// ── Metric catalog (the agreed metric-name strings for this source) ──
// Declaration order matches the emission order in AddSnapshot. Charted metrics
// share the public Commons catalog so source + UI trend page key off one symbol
// (#178); the uncharted internal metrics stay private here.
// share the public Commons catalog so source + UI trend page key off one symbol;
// the uncharted internal metrics stay private here.
private const string MetricBuffered = KpiMetrics.SiteCallAudit.Buffered;
private const string MetricParked = KpiMetrics.SiteCallAudit.Parked;
private const string MetricFailedLastInterval = KpiMetrics.SiteCallAudit.FailedLastInterval;