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.Commons.Messages.RemoteQuery;
namespace ZB.MOM.WW.ScadaBridge.SiteEventLogging.Tests;
/// <summary>
/// Regression tests for SiteEventLogging-010: the actor message contract of
/// Regression tests for the actor message contract of
/// <see cref="EventLogHandlerActor"/> was previously untested.
/// </summary>
public class EventLogHandlerActorTests : TestKit
@@ -14,11 +14,15 @@ public class EventLogHandlerActorTests : TestKit
private sealed class FakeQueryService : IEventLogQueryService
{
private readonly Func<EventLogQueryRequest, EventLogQueryResponse> _handler;
/// <summary>Gets the most recent query request received.</summary>
public EventLogQueryRequest? LastRequest { get; private set; }
/// <summary>Initializes the fake with a handler that produces query responses.</summary>
/// <param name="handler">The function that answers each query request.</param>
public FakeQueryService(Func<EventLogQueryRequest, EventLogQueryResponse> handler)
=> _handler = handler;
/// <inheritdoc />
public EventLogQueryResponse ExecuteQuery(EventLogQueryRequest request)
{
LastRequest = request;
@@ -49,6 +53,7 @@ public class EventLogHandlerActorTests : TestKit
ErrorMessage: success ? null : "boom",
Timestamp: DateTimeOffset.UtcNow);
/// <summary>Verifies that the actor replies to the sender with the query response.</summary>
[Fact]
public void Actor_RepliesToSender_WithQueryResponse()
{
@@ -65,6 +70,7 @@ public class EventLogHandlerActorTests : TestKit
Assert.Same(request, fake.LastRequest);
}
/// <summary>Verifies that the actor passes a query-service error response on to the sender.</summary>
[Fact]
public void Actor_PropagatesQueryServiceErrorResponse_ToSender()
{