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
@@ -3,10 +3,11 @@ using ZB.MOM.WW.ScadaBridge.Commons.Messages.RemoteQuery;
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
/// <summary>
/// WP-1: Tests that message contracts have correlation IDs and proper structure.
/// Tests that message contracts have correlation IDs and proper structure.
/// </summary>
public class MessageContractTests
{
/// <summary>Verifies that the event log query request has a correlation id.</summary>
[Fact]
public void EventLogQueryRequest_HasCorrelationId()
{
@@ -16,6 +17,7 @@ public class MessageContractTests
Assert.Equal("corr-456", msg.CorrelationId);
}
/// <summary>Verifies that the event log query response has a correlation id.</summary>
[Fact]
public void EventLogQueryResponse_HasCorrelationId()
{
@@ -25,6 +27,7 @@ public class MessageContractTests
Assert.Equal("corr-456", msg.CorrelationId);
}
/// <summary>Verifies that the parked message query request has a correlation id.</summary>
[Fact]
public void ParkedMessageQueryRequest_HasCorrelationId()
{
@@ -34,6 +37,7 @@ public class MessageContractTests
Assert.Equal("corr-789", msg.CorrelationId);
}
/// <summary>Verifies that the parked message query response has a correlation id.</summary>
[Fact]
public void ParkedMessageQueryResponse_HasCorrelationId()
{
@@ -43,6 +47,7 @@ public class MessageContractTests
Assert.Equal("corr-789", msg.CorrelationId);
}
/// <summary>Verifies that every message pattern exists as a record type.</summary>
[Fact]
public void AllMessagePatterns_ExistAsRecordTypes()
{