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
@@ -14,7 +14,7 @@ using DeploymentsPage = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Deploym
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Deployment;
/// <summary>
/// Regression tests for the Deployment Status push coalescing (arch-review WP2.4). The
/// Regression tests for the Deployment Status push coalescing. The
/// notifier fires per status write, so a multi-instance deploy produced a stampede of
/// reloads per circuit. The reload is leading-edge debounced: the first push after an
/// idle gap is still immediate, and a burst behind it collapses into one trailing reload.
@@ -57,7 +57,10 @@ public class DeploymentsReloadDebounceTests : BunitContext
private sealed class StubAuthStateProvider : AuthenticationStateProvider
{
private readonly AuthenticationState _state;
/// <summary>Initializes a new instance of the <see cref="StubAuthStateProvider"/> class with a fixed authentication state.</summary>
/// <param name="state">The authentication state to return.</param>
public StubAuthStateProvider(AuthenticationState state) => _state = state;
/// <inheritdoc />
public override Task<AuthenticationState> GetAuthenticationStateAsync()
=> Task.FromResult(_state);
}
@@ -67,6 +70,7 @@ public class DeploymentsReloadDebounceTests : BunitContext
_deployRepo.Received().QueryDeploymentListPageAsync(
Arg.Any<DeploymentListFilter>(), Arg.Any<int>(), Arg.Any<int>(), Arg.Any<CancellationToken>()));
/// <summary>Verifies that a burst of status writes collapses into far fewer page reloads.</summary>
[Fact]
public void BurstOfStatusWrites_CollapsesIntoFarFewerReloads()
{
@@ -93,6 +97,7 @@ public class DeploymentsReloadDebounceTests : BunitContext
Assert.InRange(reloads, 1, 4);
}
/// <summary>Verifies that the first push after an idle period reloads the page immediately.</summary>
[Fact]
public void FirstPushAfterIdle_ReloadsImmediately()
{
@@ -112,6 +117,7 @@ public class DeploymentsReloadDebounceTests : BunitContext
TimeSpan.FromMilliseconds(400));
}
/// <summary>Verifies that disposing the page during a coalesce window does not trigger a reload.</summary>
[Fact]
public void DisposeDuringACoalesceWindow_DoesNotReload()
{