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
@@ -2,12 +2,12 @@ namespace ZB.MOM.WW.ScadaBridge.DelmiaNotifier;
internal static class Program
{
/// <summary>Entry point: loads config, sends the recipe-download notification with failover across the configured base URLs, and reports the legacy YES/NO stdout contract.</summary>
/// <param name="args">Command-line arguments parsed into the recipe download payload.</param>
/// <returns>A task that resolves to the process exit code.</returns>
/// <summary>Stdout reason + log line when neither key source is set; one literal so the two cannot drift.</summary>
private const string ApiKeyNotConfigured = "API key not configured (SCADABRIDGE_API_KEY or ScadaBridge:ApiKey)";
/// <summary>Entry point: loads config, sends the recipe-download notification with failover across the configured base URLs, and reports the legacy YES/NO stdout contract.</summary>
/// <param name="args">Command-line arguments parsed into the recipe download payload.</param>
/// <returns>A task that resolves to the process exit code.</returns>
public static async Task<int> Main(string[] args)
{
var stdout = Console.Out;