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
@@ -11,7 +11,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
namespace ZB.MOM.WW.ScadaBridge.NotificationOutbox.Tests;
/// <summary>
/// M4 Bundle B (B1) — verifies <see cref="NotificationOutboxActor"/> accepts an
/// Verifies <see cref="NotificationOutboxActor"/> accepts an
/// <see cref="ICentralAuditWriter"/> at construction so subsequent bundle tasks
/// (B2/B3) can route attempt + terminal lifecycle events through the central
/// direct-write audit path.
@@ -32,8 +32,10 @@ public class NotificationOutboxActorAuditInjectionTests : TestKit
/// </summary>
private sealed class RecordingCentralAuditWriter : ICentralAuditWriter
{
/// <summary>Gets the audit events recorded by this writer.</summary>
public List<AuditEvent> Events { get; } = new();
/// <inheritdoc />
public Task WriteAsync(AuditEvent evt, CancellationToken ct = default)
{
lock (Events)
@@ -44,6 +46,7 @@ public class NotificationOutboxActorAuditInjectionTests : TestKit
}
}
/// <summary>Verifies that the actor can be constructed with an audit writer without throwing.</summary>
[Fact]
public void Actor_ConstructedWith_ICentralAuditWriter_NoException()
{
@@ -65,6 +68,7 @@ public class NotificationOutboxActorAuditInjectionTests : TestKit
}
}
/// <summary>Verifies that constructing the actor with a null audit writer throws.</summary>
[Fact]
public void Actor_NullAuditWriter_Throws()
{