docs(src): fix CommentChecker findings across src/ — 1,032 → 5 (all false positives)

Comment/XML-doc changes only, no code logic:
- strip project-tracking references (WP*, P*-*, row-NN, #NN, Task N) from
  comments, keeping the explanatory rationale
- add missing summaries, <param>, <returns>, <typeparam> and <inheritdoc/>
- replace misused <inheritdoc/> with real docs; where <inheritdoc/> was
  combined with useful remarks, move the rationale into // comments
- drop stale replicationActor <param> on DeploymentManagerActor ctor

Remaining 5 are false positives (CWE-1236 x2, failures-1, year-0001, M365).
Build 0 errors / 0 warnings.
This commit is contained in:
Joseph Doherty
2026-10-07 14:12:25 -04:00
parent 3a217b9484
commit 0ffd4bdbea
217 changed files with 1224 additions and 695 deletions
@@ -6,7 +6,7 @@ using ZB.MOM.WW.ScadaBridge.SiteEventLogging;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Scripts;
/// <summary>
/// WP3.2 (site_events volume policy — docs/plans/2026-08-15-site-events-policy-design.md):
/// Site_events volume policy (docs/plans/2026-08-15-site-events-policy-design.md):
/// accumulates per-(instance, script) run counters between flushes and emits ONE aggregate
/// "script" Info site event per interval instead of the two per-run Started/Completed rows
/// that were the dominant <c>site_events</c> writer. Registered as a process-wide singleton
@@ -54,6 +54,8 @@ public sealed class ScriptRunSummaryRecorder
Volatile.Read(ref _counters).GetOrAdd((instanceName, scriptName), static _ => new Counters());
/// <summary>Records that a script run began executing (past the shed-at-dequeue check).</summary>
/// <param name="instanceName">The instance the script belongs to.</param>
/// <param name="scriptName">The script that ran.</param>
public void RecordStarted(string instanceName, string scriptName)
{
var counters = GetOrAddCounters(instanceName, scriptName);
@@ -61,6 +63,9 @@ public sealed class ScriptRunSummaryRecorder
}
/// <summary>Records that a script run completed successfully.</summary>
/// <param name="instanceName">The instance the script belongs to.</param>
/// <param name="scriptName">The script that ran.</param>
/// <param name="durationMs">The run duration in milliseconds.</param>
public void RecordCompleted(string instanceName, string scriptName, long durationMs)
{
var counters = GetOrAddCounters(instanceName, scriptName);
@@ -69,6 +74,9 @@ public sealed class ScriptRunSummaryRecorder
}
/// <summary>Records that a script run threw an unhandled exception.</summary>
/// <param name="instanceName">The instance the script belongs to.</param>
/// <param name="scriptName">The script that ran.</param>
/// <param name="durationMs">The run duration in milliseconds.</param>
public void RecordFailed(string instanceName, string scriptName, long durationMs)
{
var counters = GetOrAddCounters(instanceName, scriptName);
@@ -80,6 +88,9 @@ public sealed class ScriptRunSummaryRecorder
/// Records that a script run timed out — including a run shed at dequeue (its deadline
/// was already spent queueing, so it never reached <see cref="RecordStarted"/>).
/// </summary>
/// <param name="instanceName">The instance the script belongs to.</param>
/// <param name="scriptName">The script that timed out.</param>
/// <param name="durationMs">The run duration in milliseconds.</param>
public void RecordTimedOut(string instanceName, string scriptName, long durationMs)
{
var counters = GetOrAddCounters(instanceName, scriptName);
@@ -202,7 +213,7 @@ public sealed class ScriptRunSummaryRecorder
return true;
}
// Built once per assembly (WP1.5 convention) rather than per flush.
// Built once per assembly rather than per flush.
private static readonly JsonSerializerOptions DetailsJsonOptions =
new() { PropertyNamingPolicy = JsonNamingPolicy.CamelCase };