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:
@@ -1,7 +1,7 @@
|
||||
namespace ZB.MOM.WW.ScadaBridge.SiteCallAudit;
|
||||
|
||||
/// <summary>
|
||||
/// Configuration options for the Site Call Audit (#22): stuck-call detection +
|
||||
/// Configuration options for the Site Call Audit: stuck-call detection +
|
||||
/// KPI windowing for the read-side, plus the cadence/retention knobs for the
|
||||
/// two central-singleton schedulers — the periodic per-site reconciliation
|
||||
/// pull (self-heal for lost telemetry) and the daily terminal-row purge.
|
||||
@@ -27,7 +27,7 @@ public class SiteCallAuditOptions
|
||||
public TimeSpan KpiInterval { get; set; } = TimeSpan.FromMinutes(1);
|
||||
|
||||
/// <summary>
|
||||
/// Task 5 (#22): Ask timeout for the central→site Retry/Discard relay. When
|
||||
/// Ask timeout for the central→site Retry/Discard relay. When
|
||||
/// the owning site does not ack a <c>RetryParkedOperation</c> /
|
||||
/// <c>DiscardParkedOperation</c> within this window — site offline, no
|
||||
/// ClusterClient route, or central buffering deliberately absent — the relay
|
||||
@@ -47,14 +47,14 @@ public class SiteCallAuditOptions
|
||||
/// </summary>
|
||||
public TimeSpan RelayTimeout { get; set; } = TimeSpan.FromSeconds(10);
|
||||
|
||||
// ── Reconciliation tick (#22): periodic per-site self-heal pull ──
|
||||
// ── Reconciliation tick: periodic per-site self-heal pull ──
|
||||
|
||||
/// <summary>
|
||||
/// Period of the reconciliation tick. Each tick visits every known site
|
||||
/// once, pulls changed <c>SiteCall</c> rows since a per-site cursor, and
|
||||
/// upserts them idempotently — the documented self-heal when best-effort
|
||||
/// push telemetry is lost. Default 5 minutes, matching the sibling
|
||||
/// <c>SiteAuditReconciliationOptions</c> (#23) cadence. Clamped to at least
|
||||
/// <c>SiteAuditReconciliationOptions</c> cadence. Clamped to at least
|
||||
/// <see cref="MinReconciliationInterval"/> via <see cref="ReconciliationInterval"/>.
|
||||
/// </summary>
|
||||
public TimeSpan ReconciliationInterval { get; set; } = TimeSpan.FromMinutes(5);
|
||||
@@ -95,7 +95,7 @@ public class SiteCallAuditOptions
|
||||
? MinReconciliationInterval
|
||||
: ReconciliationInterval;
|
||||
|
||||
// ── Purge scheduler (#22): daily terminal-row purge ──
|
||||
// ── Purge scheduler: daily terminal-row purge ──
|
||||
|
||||
/// <summary>
|
||||
/// Period of the purge tick. Each tick drops terminal <c>SiteCalls</c> rows
|
||||
|
||||
Reference in New Issue
Block a user