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
@@ -5,6 +5,7 @@ namespace ZB.MOM.WW.ScadaBridge.ClusterInfrastructure.Tests;
/// </summary>
public class ClusterOptionsTests
{
/// <summary>Verifies that a new options instance carries the expected default values.</summary>
[Fact]
public void DefaultValues_AreCorrect()
{
@@ -21,6 +22,7 @@ public class ClusterOptionsTests
Assert.True(options.DownIfAlone);
}
/// <summary>Verifies that the down-if-alone setting can be changed.</summary>
[Fact]
public void DownIfAlone_CanBeSet()
{
@@ -29,6 +31,7 @@ public class ClusterOptionsTests
Assert.False(options.DownIfAlone);
}
/// <summary>Verifies that the seed node list defaults to an empty list.</summary>
[Fact]
public void SeedNodes_DefaultsToEmptyList()
{
@@ -38,17 +41,18 @@ public class ClusterOptionsTests
Assert.Empty(options.SeedNodes);
}
// ClusterInfra-011: SectionName constant deleted — the previous test
// The SectionName constant was deleted — the previous test
// `SectionName_IsTheExpectedAppSettingsSection` is removed alongside it.
// The Host's SiteServiceRegistration / StartupValidator continue to
// reference the `"ScadaBridge:Cluster"` literal directly; reinstating the
// constant should happen when those Host binding sites can be updated in
// the same change.
/// <summary>Verifies that the options properties accept custom values.</summary>
[Fact]
public void Properties_CanBeSetToCustomValues()
{
// ClusterInfra-013: this test exercises the POCO property setters only —
// This test exercises the POCO property setters only —
// `SplitBrainResolverStrategy = "keep-majority"` and `MinNrOfMembers = 2`
// are values the design doc explicitly forbids in production
// (`keep-majority` causes total shutdown on a two-node partition;