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
@@ -10,13 +10,14 @@ using ZB.MOM.WW.ScadaBridge.Host.Actors;
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>
/// WP-15: Tests for DeadLetterMonitorActor.
/// Tests for DeadLetterMonitorActor.
/// </summary>
public class DeadLetterMonitorTests : TestKit
{
private readonly ILogger<DeadLetterMonitorActor> _logger =
NullLoggerFactory.Instance.CreateLogger<DeadLetterMonitorActor>();
/// <summary>Verifies that a new dead-letter monitor starts with a count of zero.</summary>
[Fact]
public void DeadLetterMonitor_StartsWithZeroCount()
{
@@ -28,6 +29,7 @@ public class DeadLetterMonitorTests : TestKit
Assert.Equal(0, response.Count);
}
/// <summary>Verifies that the monitor count increments when a dead letter is published.</summary>
[Fact]
public void DeadLetterMonitor_IncrementsOnDeadLetter()
{
@@ -50,6 +52,8 @@ public class DeadLetterMonitorTests : TestKit
});
}
/// <summary>Verifies that a dead-letter storm logs at most the per-window warning limit while still counting every dead letter.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DeadLetterStorm_LogsAtMostWindowLimit_ButCountsAll()
{
@@ -77,6 +81,7 @@ public class DeadLetterMonitorTests : TestKit
$"expected <= {DeadLetterMonitorActor.MaxWarningsPerWindow + 1} warnings, got {warnings}");
}
/// <summary>Verifies that the dead-letter count accumulates across multiple dead letters.</summary>
[Fact]
public void DeadLetterMonitor_CountAccumulates()
{