docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Comment/XML-doc changes only:
- add summaries to ~10k test methods, fixtures, fakes and helpers
  (+ <param> on theories, <returns> on async Task methods,
  <inheritdoc/> on interface implementations the checker can resolve)
- strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N,
  #NN, Component-0NN) from comments, keeping the explanatory text;
  reword false positives in comments only
- real docs on fakes implementing BCL/library interfaces
  (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime)
- reword the last 5 src/ false positives (CWE-1236, failures-1,
  year-0001, M365)

Only non-comment edits: four one-line nested classes split across lines
so members can carry docs. Build 0 errors / 0 warnings.
This commit is contained in:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -7,13 +7,14 @@ namespace ZB.MOM.WW.ScadaBridge.HealthMonitoring.Tests;
/// <remarks>
/// The skip used to be a single boot Warning and nothing else, so a node that lost its whole
/// self-heal path went on reporting itself perfectly healthy. The field is tri-state and the
/// three cases must stay distinct: null = not reported (central self-report, or a pre-row-73
/// three cases must stay distinct: null = not reported (central self-report, or a older
/// site build), true = running, false = skipped because no <c>IDeploymentConfigFetcher</c>
/// was available. Collapsing null into false would badge every site the moment central is
/// upgraded ahead of them.
/// </remarks>
public class StartupReconcilerHealthFieldTests
{
/// <summary>Verifies the case: collect Report, never Told, leaves The Field Null.</summary>
[Fact]
public void CollectReport_NeverTold_LeavesTheFieldNull()
{
@@ -26,6 +27,7 @@ public class StartupReconcilerHealthFieldTests
Assert.Null(report.StartupReconcilerActive);
}
/// <summary>Verifies the case: collect Report, reconciler Spawned, reports True.</summary>
[Fact]
public void CollectReport_ReconcilerSpawned_ReportsTrue()
{
@@ -36,6 +38,7 @@ public class StartupReconcilerHealthFieldTests
Assert.True(collector.CollectReport("TestSite").StartupReconcilerActive);
}
/// <summary>Verifies the case: collect Report, reconciler Skipped, reports False, not Null.</summary>
[Fact]
public void CollectReport_ReconcilerSkipped_ReportsFalse_NotNull()
{
@@ -50,6 +53,7 @@ public class StartupReconcilerHealthFieldTests
Assert.False(report.StartupReconcilerActive);
}
/// <summary>Verifies the case: collect Report, is Point In Time, not Drained On Collect.</summary>
[Fact]
public void CollectReport_IsPointInTime_NotDrainedOnCollect()
{
@@ -64,6 +68,7 @@ public class StartupReconcilerHealthFieldTests
Assert.False(second.StartupReconcilerActive);
}
/// <summary>Verifies the case: set Startup Reconciler Active, is Not Write Once.</summary>
[Fact]
public void SetStartupReconcilerActive_IsNotWriteOnce()
{