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
@@ -70,6 +70,8 @@ public class SiteStreamEventBatcherTests
// ── Size cap ────────────────────────────────────────────────────────────────
/// <summary>Verifies that a backlog is split into frames of at most the maximum event count.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SizeCap_SplitsABacklogIntoFramesOfAtMostMaxEvents()
{
@@ -89,6 +91,8 @@ public class SiteStreamEventBatcherTests
Assert.Equal(Enumerable.Range(0, 250), run.Frames.SelectMany(Seqs));
}
/// <summary>Verifies that a size cap of one emits plain per-event frames, the unnegotiated shape.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SizeCapOfOne_EmitsPlainPerEventFrames_TheUnnegotiatedShape()
{
@@ -112,6 +116,8 @@ public class SiteStreamEventBatcherTests
// ── Time cap ────────────────────────────────────────────────────────────────
/// <summary>Verifies that an underfull batch is closed when the batching window elapses.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task TimeCap_ClosesAnUnderfullBatchWhenTheWindowElapses()
{
@@ -152,6 +158,8 @@ public class SiteStreamEventBatcherTests
$"batch closed after {elapsed.TotalMilliseconds:0.0} ms, before the {window.TotalMilliseconds:0} ms window");
}
/// <summary>Verifies that a lone event on a quiet stream is never delayed by the batching window.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LoneEventOnAQuietStream_IsNeverDelayedByTheWindow()
{
@@ -187,6 +195,8 @@ public class SiteStreamEventBatcherTests
// ── Flush on stream close ───────────────────────────────────────────────────
/// <summary>Verifies that completing the writer flushes the in-flight batch before the pump returns.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WriterCompletion_FlushesTheInFlightBatchBeforeReturning()
{
@@ -213,6 +223,8 @@ public class SiteStreamEventBatcherTests
Assert.Equal([0, 1], Seqs(run.Frames[0]));
}
/// <summary>Verifies that completing the writer with nothing buffered returns without emitting a frame.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WriterCompletionWithNothingBuffered_ReturnsWithoutEmitting()
{
@@ -225,6 +237,8 @@ public class SiteStreamEventBatcherTests
Assert.Empty(run.Frames);
}
/// <summary>Verifies that cancellation ends the pump with an operation-canceled exception.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Cancellation_EndsThePumpWithOperationCanceled()
{
@@ -243,6 +257,8 @@ public class SiteStreamEventBatcherTests
// ── Ordering ────────────────────────────────────────────────────────────────
/// <summary>Verifies that event ordering is preserved across many batches while producers race.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Ordering_IsPreservedAcrossManyBatchesUnderAProducerRace()
{
@@ -273,6 +289,8 @@ public class SiteStreamEventBatcherTests
// ── Frame shape ─────────────────────────────────────────────────────────────
/// <summary>Verifies that a batch frame carries the correlation id once and blanks it on the inner events.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BatchFrame_CarriesTheCorrelationIdOnceAndBlanksItOnInnerEvents()
{
@@ -292,6 +310,8 @@ public class SiteStreamEventBatcherTests
Assert.All(frame.Batch.Events, e => Assert.Equal(string.Empty, e.CorrelationId));
}
/// <summary>Verifies that per-event timestamps survive batching.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task PerEventTimestampsSurviveBatching()
{