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
@@ -24,6 +24,7 @@ public class FlowTraceCollectorTests
AuditChannel.ScriptTrace, AuditKind.ScriptRun, AuditStatus.Delivered,
target: "S", requestSummary: details);
/// <summary>Verifies that add, when beyond cap, keeps first n and flags truncated.</summary>
[Fact]
public void Add_BeyondCap_KeepsFirstN_AndFlagsTruncated()
{
@@ -39,6 +40,7 @@ public class FlowTraceCollectorTests
Assert.Equal("499", snap[499].Target);
}
/// <summary>Verifies that snapshot, when is a copy, in emission order.</summary>
[Fact]
public void Snapshot_IsACopy_InEmissionOrder()
{
@@ -52,6 +54,8 @@ public class FlowTraceCollectorTests
Assert.Equal(new[] { "1", "2" }, c.Snapshot().Select(e => e.Target));
}
/// <summary>Verifies that concurrent adds, when never throw, and never exceed cap.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConcurrentAdds_NeverThrow_AndNeverExceedCap()
{
@@ -66,6 +70,7 @@ public class FlowTraceCollectorTests
Assert.True(c.Truncated);
}
/// <summary>Verifies that default cap, when is 500, and non-positive cap is rejected.</summary>
[Fact]
public void DefaultCap_Is500_AndNonPositiveCapIsRejected()
{
@@ -73,6 +78,7 @@ public class FlowTraceCollectorTests
Assert.Throws<ArgumentOutOfRangeException>(() => new FlowTraceCollector(0));
}
/// <summary>Verifies that complete, when closes the collector, later adds are ignored and never truncate.</summary>
[Fact]
public void Complete_ClosesTheCollector_LaterAddsAreIgnored_AndNeverTruncate()
{
@@ -198,6 +204,9 @@ public class FlowTraceCollectorTests
/// <summary>Upper-cases <c>DetailsJson</c> so a test can see the filtered copy land.</summary>
private sealed class UpperRedactor : IAuditRedactor
{
/// <summary>Applies the upper-casing redaction.</summary>
/// <param name="rawEvent">The raw event.</param>
/// <returns>The event with upper-cased details.</returns>
public AuditEvent Apply(AuditEvent rawEvent)
=> rawEvent with { DetailsJson = rawEvent.DetailsJson?.ToUpperInvariant() };
}