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
@@ -18,7 +18,7 @@ using DebugViewPage = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Deploymen
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Deployment;
/// <summary>
/// Regression tests for the Debug View render coalescing (arch-review WP2.4). Every streamed
/// Regression tests for the Debug View render coalescing. Every streamed
/// event used to marshal onto the circuit dispatcher and call <c>StateHasChanged</c> on its
/// own, so a chatty instance drove one full render — and two full composition-tree rebuilds —
/// per value change. Events are now buffered and applied once per ~250 ms window: a burst
@@ -60,7 +60,10 @@ public class DebugViewRenderCoalescingTests : BunitContext
private sealed class StubAuthStateProvider : AuthenticationStateProvider
{
private readonly AuthenticationState _state;
/// <summary>Initializes the provider with the authentication state to return.</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);
}
@@ -78,6 +81,7 @@ public class DebugViewRenderCoalescingTests : BunitContext
new AttributeValueChanged("Inst-1", name, name, value, "Good", DateTimeOffset.UtcNow),
});
/// <summary>Verifies that a burst of events triggers a single render while every event is still applied.</summary>
[Fact]
public void BurstOfEvents_RendersOnce_ButAppliesEveryEvent()
{
@@ -99,6 +103,7 @@ public class DebugViewRenderCoalescingTests : BunitContext
Assert.InRange(renders, 1, 5);
}
/// <summary>Verifies that repeated updates to one tag collapse to the latest value.</summary>
[Fact]
public void RepeatedUpdatesToOneTag_CollapseToTheLatestValue()
{
@@ -115,6 +120,7 @@ public class DebugViewRenderCoalescingTests : BunitContext
Assert.Equal(49, applied.Value);
}
/// <summary>Verifies that an event arriving after a flush still arms a new coalescing window.</summary>
[Fact]
public void EventArrivingAfterAFlush_StillArmsANewWindow()
{
@@ -130,6 +136,7 @@ public class DebugViewRenderCoalescingTests : BunitContext
cut.WaitForState(() => dict.Count == 2, TimeSpan.FromSeconds(5));
}
/// <summary>Verifies that events arriving after disposal are dropped without throwing.</summary>
[Fact]
public void EventsAfterDispose_AreDroppedWithoutThrowing()
{