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:
@@ -8,7 +8,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
||||
namespace ZB.MOM.WW.ScadaBridge.KpiHistory;
|
||||
|
||||
/// <summary>
|
||||
/// Central cluster-singleton (M6 "KPI History & Trends", K4) that drives the
|
||||
/// Central cluster-singleton ("KPI History & Trends") that drives the
|
||||
/// KPI sampling backbone. On a periodic timer (default 60 s) it:
|
||||
/// <list type="number">
|
||||
/// <item>Stamps a single <c>capturedAtUtc</c> for the pass.</item>
|
||||
@@ -46,10 +46,10 @@ namespace ZB.MOM.WW.ScadaBridge.KpiHistory;
|
||||
/// async connection cleanup does not block.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Singleton wiring.</b> The <c>Props</c> is built in the Host (K5) on the
|
||||
/// <b>Singleton wiring.</b> The <c>Props</c> is built in the Host on the
|
||||
/// active central node with the constructor args resolved from DI — this actor
|
||||
/// has no knowledge of <c>Akka.Cluster.Tools</c>, mirroring the Notification
|
||||
/// Outbox (#21) singleton split.
|
||||
/// Outbox singleton split.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public class KpiHistoryRecorderActor : ReceiveActor, IWithTimers
|
||||
|
||||
Reference in New Issue
Block a user