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
@@ -6,7 +6,7 @@ using ZB.MOM.WW.ScadaBridge.SiteCallAudit;
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>
/// P5-5 (arch-review Low): <see cref="KpiRateFoldIntervalCrossValidator"/> is the
/// <see cref="KpiRateFoldIntervalCrossValidator"/> is the
/// boot-time guardrail for the "rate-fold interval triple" —
/// <see cref="KpiHistoryOptions.SampleInterval"/>,
/// <see cref="NotificationOutboxOptions.DeliveredKpiWindow"/>, and
@@ -30,6 +30,7 @@ public class KpiRateFoldIntervalCrossValidatorTests
return validator.Validate(Options.DefaultName, kpiHistoryOptions);
}
/// <summary>Verifies that the validator accepts all three values being equal at the documented defaults.</summary>
[Fact]
public void AllThreeEqual_AtDocumentedDefaults_IsValid()
{
@@ -39,6 +40,7 @@ public class KpiRateFoldIntervalCrossValidatorTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that the validator accepts all three values being equal at a common non-default value.</summary>
[Fact]
public void AllThreeEqual_AtANonDefaultCommonValue_IsValid()
{
@@ -51,6 +53,7 @@ public class KpiRateFoldIntervalCrossValidatorTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that the validator fails and names all three keys when the delivered KPI window diverges.</summary>
[Fact]
public void DeliveredKpiWindowDiverges_FailsAndNamesAllThreeKeys()
{
@@ -65,6 +68,7 @@ public class KpiRateFoldIntervalCrossValidatorTests
Assert.Contains("ScadaBridge:SiteCallAudit:KpiInterval", result.FailureMessage);
}
/// <summary>Verifies that the validator fails and names all three keys when the KPI interval diverges.</summary>
[Fact]
public void KpiIntervalDiverges_FailsAndNamesAllThreeKeys()
{
@@ -79,6 +83,7 @@ public class KpiRateFoldIntervalCrossValidatorTests
Assert.Contains("ScadaBridge:SiteCallAudit:KpiInterval", result.FailureMessage);
}
/// <summary>Verifies that the validator fails when both the delivered KPI window and the KPI interval diverge.</summary>
[Fact]
public void BothDeliveredKpiWindowAndKpiIntervalDiverge_Fails()
{