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
@@ -5,14 +5,14 @@ using ZB.MOM.WW.Configuration;
namespace ZB.MOM.WW.ScadaBridge.KpiHistory;
/// <summary>
/// Composition root for the KPI History (#26, M6) component.
/// Composition root for the KPI History component.
/// </summary>
/// <remarks>
/// <para>
/// K3 scaffolds the component: it binds and validates
/// Scaffolds the component: it binds and validates
/// <see cref="KpiHistoryOptions"/>. The recorder actor itself is created via
/// <c>Props</c> in the Host on the active central node (K4/K5), not registered
/// here — mirroring the Notification Outbox (#21) singleton wiring.
/// <c>Props</c> in the Host on the active central node, not registered
/// here — mirroring the Notification Outbox singleton wiring.
/// </para>
/// </remarks>
public static class ServiceCollectionExtensions
@@ -21,7 +21,7 @@ public static class ServiceCollectionExtensions
public const string OptionsSection = "ScadaBridge:KpiHistory";
/// <summary>
/// Registers the KPI History (#26) component services: the validated
/// Registers the KPI History component services: the validated
/// <see cref="KpiHistoryOptions"/> binding. Idempotent re-registration of the
/// validator is handled by the shared <c>AddValidatedOptions</c> helper
/// (<c>TryAddEnumerable</c>); the options binding itself is call-once per