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
@@ -6,7 +6,7 @@ using ZB.MOM.WW.ScadaBridge.SiteRuntime.Streaming;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Streaming;
/// <summary>
/// WP2.6d: the hosted reporter must lift <see cref="SiteStreamManager.AlarmPublishDroppedCount"/>
/// The hosted reporter must lift <see cref="SiteStreamManager.AlarmPublishDroppedCount"/>
/// onto the site health report via <see cref="ISiteHealthCollector"/>. Uses the real
/// collector (mirrors <c>ScriptSchedulerStatsReporterTests</c> — NSubstitute is not
/// referenced by this test project). The queue's own drop-counting mechanism is verified
@@ -16,8 +16,11 @@ namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Streaming;
/// </summary>
public class SiteStreamAlarmDropReporterTests : TestKit, IDisposable
{
/// <inheritdoc />
void IDisposable.Dispose() => Shutdown();
/// <summary>Verifies that reporter pushes alarm drop count to collector.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Reporter_PushesAlarmDropCountToCollector()
{