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
@@ -51,6 +51,8 @@ public class GrpcStreamBatchingIntegrationTests(ITestOutputHelper output) : Test
// ── Round trip: batched frames deliver every event, in order ────────────────
/// <summary>Verifies that a negotiated stream round-trips every event through the wire in order.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task NegotiatedStream_RoundTripsEveryEventThroughTheWire_InOrder()
{
@@ -95,6 +97,8 @@ public class GrpcStreamBatchingIntegrationTests(ITestOutputHelper output) : Test
// ── Latency cost of the default window ─────────────────────────────────────
/// <summary>Verifies that the default batching window keeps per-event latency far below the threshold.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DefaultWindow_KeepsPerEventLatencyFarBelowTheThreshold()
{
@@ -163,6 +167,8 @@ public class GrpcStreamBatchingIntegrationTests(ITestOutputHelper output) : Test
// ── Version skew: OLD central ↔ NEW site ───────────────────────────────────
/// <summary>Verifies that an old central talking to a new site never receives a batch frame.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task OldCentral_AgainstNewSite_NeverReceivesABatchFrame()
{
@@ -189,7 +195,7 @@ public class GrpcStreamBatchingIntegrationTests(ITestOutputHelper output) : Test
var wire = SnapshotThroughTheWire(frames);
// One event per frame, and — checked at the byte level, since that is what the
// old peer's parser sees — never the field-4 batch tag.
// old peer's parser sees — never the field 4 batch tag.
Assert.Equal(total, wire.Count);
Assert.All(wire, f =>
Assert.Equal(SiteStreamEvent.EventOneofCase.AttributeChanged, f.EventCase));
@@ -198,6 +204,7 @@ public class GrpcStreamBatchingIntegrationTests(ITestOutputHelper output) : Test
GC.KeepAlive(server);
}
/// <summary>Verifies that the batch frame rides field 4, which a pre-batching parser would drop silently.</summary>
[Fact]
public void BatchFrameRidesFieldFour_WhichAPreBatchingParserWouldDropSilently()
{
@@ -232,6 +239,8 @@ public class GrpcStreamBatchingIntegrationTests(ITestOutputHelper output) : Test
// ── Version skew: NEW central ↔ OLD site ───────────────────────────────────
/// <summary>Verifies that a new central talking to an old site still receives every event.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task NewCentral_AgainstOldSite_StillReceivesEveryEvent()
{