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
@@ -9,6 +9,7 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Entities;
/// </summary>
public class NotificationEntityTests
{
/// <summary>Verifies that the constructor sets the expected default values.</summary>
[Fact]
public void Constructor_SetsDefaults()
{
@@ -21,10 +22,11 @@ public class NotificationEntityTests
Assert.Equal("SiteA", n.SourceSiteId);
}
/// <summary>Verifies that OriginExecutionId defaults to null and can be set.</summary>
[Fact]
public void OriginExecutionId_DefaultsToNull_AndIsSettable()
{
// Audit Log #23: OriginExecutionId carries the originating script
// OriginExecutionId carries the originating script
// execution's id from the site so the dispatcher can echo it onto
// NotifyDeliver rows. Null for notifications submitted before the
// column existed; settable from the NotificationSubmit message.
@@ -36,6 +38,7 @@ public class NotificationEntityTests
Assert.Equal(executionId, n.OriginExecutionId);
}
/// <summary>Verifies that OriginParentExecutionId defaults to null and can be set.</summary>
[Fact]
public void OriginParentExecutionId_DefaultsToNull_AndIsSettable()
{
@@ -51,6 +54,7 @@ public class NotificationEntityTests
Assert.Equal(parentExecutionId, n.OriginParentExecutionId);
}
/// <summary>Verifies that SourceNode defaults to null and can be set.</summary>
[Fact]
public void SourceNode_DefaultsToNull_AndIsSettable()
{
@@ -65,6 +69,7 @@ public class NotificationEntityTests
Assert.Equal("node-a", n.SourceNode);
}
/// <summary>Verifies that the constructor throws for null arguments.</summary>
[Fact]
public void Constructor_NullArguments_Throw()
{