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
@@ -5,7 +5,7 @@ using ZB.MOM.WW.ScadaBridge.Host.Services;
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>
/// #05-T14: unit tests for the in-process script-artifact change bus — delivery,
/// Unit tests for the in-process script-artifact change bus — delivery,
/// unsubscribe, and the swallow-and-log guard that keeps a faulting subscriber from
/// faulting the producer.
/// </summary>
@@ -17,6 +17,7 @@ public sealed class InProcessScriptArtifactChangeBusTests
private static ScriptArtifactsChanged Sample(string kind = ScriptArtifactKinds.ApiMethod) =>
new(kind, new[] { "M1" }, "Management", DateTimeOffset.UnixEpoch);
/// <summary>Verifies that publish delivers to all current subscribers.</summary>
[Fact]
public void Publish_delivers_to_all_current_subscribers()
{
@@ -33,6 +34,7 @@ public sealed class InProcessScriptArtifactChangeBusTests
Assert.Same(n, Assert.Single(b));
}
/// <summary>Verifies that disposing subscription stops delivery.</summary>
[Fact]
public void Disposing_subscription_stops_delivery()
{
@@ -47,6 +49,7 @@ public sealed class InProcessScriptArtifactChangeBusTests
Assert.Single(received); // only the pre-dispose publish landed.
}
/// <summary>Verifies that dispose is idempotent.</summary>
[Fact]
public void Dispose_is_idempotent()
{
@@ -61,6 +64,7 @@ public sealed class InProcessScriptArtifactChangeBusTests
Assert.Empty(received);
}
/// <summary>Verifies that a faulting subscriber does not prevent delivery to others nor throw.</summary>
[Fact]
public void A_faulting_subscriber_does_not_prevent_delivery_to_others_nor_throw()
{
@@ -76,6 +80,7 @@ public sealed class InProcessScriptArtifactChangeBusTests
Assert.Single(good);
}
/// <summary>Verifies that publish with no subscribers is a noop.</summary>
[Fact]
public void Publish_with_no_subscribers_is_a_noop()
{