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,7 +3,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types;
namespace ZB.MOM.WW.ScadaBridge.HealthMonitoring.Tests;
/// <summary>
/// Bundle E (M6-T6) regression coverage. The site-side audit-log SQLite writer
/// Regression coverage. The site-side audit-log SQLite writer
/// exposes a backlog snapshot (<c>SiteAuditBacklogSnapshot</c>) via the
/// <c>ISiteAuditQueue.GetBacklogStatsAsync</c> surface. A periodic
/// <c>SiteAuditBacklogReporter</c> hosted service polls that snapshot and
@@ -18,6 +18,7 @@ public class SiteAuditBacklogMetricTests
{
private readonly SiteHealthCollector _collector = new();
/// <summary>Verifies that a report collected after an update includes the backlog.</summary>
[Fact]
public void Update_Then_CollectReport_IncludesBacklog()
{
@@ -33,6 +34,7 @@ public class SiteAuditBacklogMetricTests
Assert.Equal(snapshot, report.SiteAuditBacklog);
}
/// <summary>Verifies that the report payload includes the site audit backlog as null by default.</summary>
[Fact]
public void Report_Payload_Includes_SiteAuditBacklog_AsNullByDefault()
{
@@ -43,6 +45,7 @@ public class SiteAuditBacklogMetricTests
Assert.Null(report.SiteAuditBacklog);
}
/// <summary>Verifies that collecting a report does not reset the site audit backlog.</summary>
[Fact]
public void CollectReport_DoesNotReset_SiteAuditBacklog()
{
@@ -64,6 +67,7 @@ public class SiteAuditBacklogMetricTests
Assert.Equal(snapshot, second.SiteAuditBacklog);
}
/// <summary>Verifies that updating with a null snapshot throws an argument-null exception.</summary>
[Fact]
public void Update_With_Null_Throws_ArgumentNullException()
{