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
@@ -55,6 +55,8 @@ public sealed class LocalDbSitePairConvergenceTests : LocalDbSitePairHarness
// ---- scenarios --------------------------------------------------------------------
/// <summary>Verifies that a tracking row written on node A becomes readable on node B.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task TrackingRow_WrittenOnA_BecomesReadableOnB()
{
@@ -65,6 +67,8 @@ public sealed class LocalDbSitePairConvergenceTests : LocalDbSitePairHarness
"the tracking row written on node A to appear on node B");
}
/// <summary>Verifies that a tracking row written on node B becomes readable on node A.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task TrackingRow_WrittenOnB_BecomesReadableOnA()
{
@@ -77,6 +81,8 @@ public sealed class LocalDbSitePairConvergenceTests : LocalDbSitePairHarness
"the tracking row written on node B to appear on node A");
}
/// <summary>Verifies that the same operation updated on both nodes converges to a single winning value.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SameOperation_UpdatedOnBothNodes_ConvergesToOneWinner()
{
@@ -104,6 +110,8 @@ public sealed class LocalDbSitePairConvergenceTests : LocalDbSitePairHarness
Assert.Contains(winner, new[] { "Delivered", "Parked" });
}
/// <summary>Verifies that events logged on both nodes converge to their union with no id collisions.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EventsLoggedOnBothNodes_ConvergeToTheUnion_WithNoIdCollisions()
{
@@ -125,6 +133,8 @@ public sealed class LocalDbSitePairConvergenceTests : LocalDbSitePairHarness
"both nodes to hold the union of all 10 events");
}
/// <summary>Verifies that a peer that goes offline and rejoins catches up on everything it missed.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task PeerOffline_ThenRejoins_CatchesUpOnEverythingItMissed()
{