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
@@ -32,6 +32,7 @@ public class StaleInstanceProbeTests
private string _currentHash = "sha256:first";
private int _flattenCount;
/// <summary>Initializes a new instance of the <c>StaleInstanceProbeTests</c> class.</summary>
public StaleInstanceProbeTests()
{
// Process-static memo: start every test from a clean slate.
@@ -51,6 +52,8 @@ public class StaleInstanceProbeTests
private StaleInstanceProbe CreateProbe() => new(_pipeline, _watermark);
/// <summary>Verifies that peer edit with independent watermark is observed by warm active probe.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task PeerEdit_WithIndependentWatermark_IsObservedByWarmActiveProbe()
{
@@ -62,6 +65,8 @@ public class StaleInstanceProbeTests
Assert.Equal("sha256:peer-edit", await active.GetCurrentRevisionHashAsync(InstanceId));
}
/// <summary>Verifies that unchanged watermark still reflattens authoritatively.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UnchangedWatermark_StillReflattensAuthoritatively()
{
@@ -79,6 +84,7 @@ public class StaleInstanceProbeTests
/// flattening input without an owning template id — data-connection saves and
/// bundle imports both rely on it. It must invalidate the memo.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BumpAll_InvalidatesTheMemo()
{
@@ -97,6 +103,8 @@ public class StaleInstanceProbeTests
Assert.Equal(3, _flattenCount);
}
/// <summary>Verifies that bump instance invalidates the memo for that instance.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BumpInstance_InvalidatesTheMemoForThatInstance()
{
@@ -110,7 +118,7 @@ public class StaleInstanceProbeTests
}
/// <summary>
/// P7-4: a non-structural template edit landing DURING the flatten must not be
/// A non-structural template edit landing DURING the flatten must not be
/// captured as if it were already included.
///
/// <para>
@@ -130,6 +138,7 @@ public class StaleInstanceProbeTests
/// which is correct, since that is the graph the flatten actually saw.
/// </para>
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task TemplateEditedDuringFlatten_InvalidatesTheMemo_RatherThanPinningTheStaleHash()
{