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
@@ -21,6 +21,7 @@ public sealed class LocalDbBacklogSustainedTests
{
private const long Threshold = 1000;
/// <summary>Verifies that a backlog above the threshold starts the above-threshold clock.</summary>
[Fact]
public void BacklogAboveThreshold_StartsTheClock()
{
@@ -32,6 +33,7 @@ public sealed class LocalDbBacklogSustainedTests
Assert.Equal(start, aggregator.GetSiteState("site-a")!.LocalDbBacklogAboveSince);
}
/// <summary>Verifies that a backlog that stays above the threshold keeps the original start instant.</summary>
[Fact]
public void BacklogStayingAbove_KeepsTheOriginalStartInstant()
{
@@ -47,6 +49,7 @@ public sealed class LocalDbBacklogSustainedTests
Assert.Equal(start, aggregator.GetSiteState("site-a")!.LocalDbBacklogAboveSince);
}
/// <summary>Verifies that a backlog at or below the threshold clears the clock.</summary>
[Fact]
public void BacklogAtOrBelowThreshold_ClearsTheClock()
{
@@ -61,6 +64,7 @@ public sealed class LocalDbBacklogSustainedTests
Assert.Null(aggregator.GetSiteState("site-a")!.LocalDbBacklogAboveSince);
}
/// <summary>Verifies that a backlog exactly at the threshold does not start the clock.</summary>
[Fact]
public void BacklogExactlyAtThreshold_DoesNotStartTheClock()
{
@@ -73,6 +77,7 @@ public sealed class LocalDbBacklogSustainedTests
Assert.Null(aggregator.GetSiteState("site-a")!.LocalDbBacklogAboveSince);
}
/// <summary>Verifies that an unreplicated site reporting a null backlog never accumulates an anchor.</summary>
[Fact]
public void UnreplicatedSite_NeverAccumulatesAnAnchor()
{
@@ -88,6 +93,7 @@ public sealed class LocalDbBacklogSustainedTests
Assert.Null(aggregator.GetSiteState("site-b")!.LocalDbBacklogAboveSince);
}
/// <summary>Verifies that a null backlog in the middle of a climb leaves the anchor untouched.</summary>
[Fact]
public void NullBacklogMidClimb_LeavesTheAnchorUntouched()
{
@@ -104,6 +110,7 @@ public sealed class LocalDbBacklogSustainedTests
Assert.Equal(start, aggregator.GetSiteState("site-a")!.LocalDbBacklogAboveSince);
}
/// <summary>Verifies that the very first report for a new site can start the clock.</summary>
[Fact]
public void FirstReportForANewSite_CanStartTheClock()
{
@@ -117,6 +124,7 @@ public sealed class LocalDbBacklogSustainedTests
Assert.Equal(start, aggregator.GetSiteState("brand-new")!.LocalDbBacklogAboveSince);
}
/// <summary>Verifies that the backlog threshold is configurable.</summary>
[Fact]
public void ThresholdIsConfigurable()
{
@@ -127,6 +135,7 @@ public sealed class LocalDbBacklogSustainedTests
Assert.NotNull(aggregator.GetSiteState("site-a")!.LocalDbBacklogAboveSince);
}
/// <summary>Verifies that a stale out-of-order report does not disturb the anchor.</summary>
[Fact]
public void StaleReport_DoesNotDisturbTheAnchor()
{