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
@@ -20,6 +20,7 @@ public class ApiMethodTraceAllCallsTests : TestKit, IDisposable
private readonly ServiceCollection _services = new ServiceCollection().AddTestConfigurationTransaction();
private readonly IInboundApiRepository _apiRepo = Substitute.For<IInboundApiRepository>();
/// <summary>Initializes the test class with a stubbed inbound API repository and test services.</summary>
public ApiMethodTraceAllCallsTests()
{
_services.AddScoped(_ => _apiRepo);
@@ -35,8 +36,10 @@ public class ApiMethodTraceAllCallsTests : TestKit, IDisposable
new(new AuthenticatedUser("designer", "Designer", new[] { "Designer" }, Array.Empty<string>()),
command, Guid.NewGuid().ToString("N"));
/// <inheritdoc />
void IDisposable.Dispose() => Shutdown();
/// <summary>Verifies that commands default to untraced when built with the five-argument constructor.</summary>
[Fact]
public void Commands_DefaultToUntraced_ForTheFiveArgConstructor()
{
@@ -45,6 +48,7 @@ public class ApiMethodTraceAllCallsTests : TestKit, IDisposable
Assert.False(new ApiMethod("m", "return 1;").TraceAllCalls);
}
/// <summary>Verifies that creating a method with the trace-all-calls flag persists it and echoes it in the result.</summary>
[Fact]
public void Create_WithTraceAllCalls_PersistsTheFlag_AndEchoesItInTheResult()
{
@@ -60,6 +64,7 @@ public class ApiMethodTraceAllCallsTests : TestKit, IDisposable
Assert.Contains("\"traceAllCalls\":true", response.JsonData.Replace(" ", ""));
}
/// <summary>Verifies that updating with an explicit false clears the trace-all-calls flag.</summary>
[Fact]
public void Update_WithExplicitFalse_ClearsTheFlag()
{
@@ -72,6 +77,7 @@ public class ApiMethodTraceAllCallsTests : TestKit, IDisposable
Assert.False(existing.TraceAllCalls);
}
/// <summary>Verifies that an update that omits the flag leaves the stored value unchanged.</summary>
[Fact]
public void Update_OmittingTheFlag_LeavesTheStoredValueUnchanged()
{