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.Communication.Grpc;
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests.Protos;
/// <summary>
/// Wire-format round-trip tests for the Audit Log (#23) M3 cached-telemetry
/// Wire-format round-trip tests for the Audit Log cached-telemetry
/// proto messages (<see cref="SiteCallOperationalDto"/>,
/// <see cref="CachedTelemetryPacket"/>, <see cref="CachedTelemetryBatch"/>).
/// Locks the additive contract the central dual-write transaction depends on.
@@ -23,6 +23,7 @@ public class CachedTelemetryProtoTests
SourceSiteId = "site-1",
};
/// <summary>Verifies that a <c>SiteCallOperationalDto</c> round trip preserves all fields.</summary>
[Fact]
public void SiteCallOperationalDto_RoundTrip_PreservesAllFields()
{
@@ -66,6 +67,7 @@ public class CachedTelemetryProtoTests
Assert.Equal(original.TerminalAtUtc, deserialized.TerminalAtUtc);
}
/// <summary>Verifies that the terminal timestamp is absent when the call is not terminal.</summary>
[Fact]
public void SiteCallOperationalDto_TerminalAt_AbsentWhenNotTerminal()
{
@@ -91,6 +93,7 @@ public class CachedTelemetryProtoTests
Assert.Null(deserialized.TerminalAtUtc);
}
/// <summary>Verifies that the nullable HTTP status is absent by default.</summary>
[Fact]
public void SiteCallOperationalDto_NullableHttpStatus_AbsentByDefault()
{
@@ -116,6 +119,7 @@ public class CachedTelemetryProtoTests
Assert.Null(deserialized.HttpStatus);
}
/// <summary>Verifies that a <c>CachedTelemetryPacket</c> round trip preserves its nested entities.</summary>
[Fact]
public void CachedTelemetryPacket_RoundTrip_PreservesNestedEntities()
{
@@ -161,6 +165,7 @@ public class CachedTelemetryProtoTests
Assert.Equal(operationalDto.LastError, deserialized.Operational.LastError);
}
/// <summary>Verifies that an empty <c>CachedTelemetryBatch</c> round trip yields no packets.</summary>
[Fact]
public void CachedTelemetryBatch_Empty_RoundTrip_Yields_EmptyPackets()
{