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
@@ -7,7 +7,7 @@ using ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests;
/// <summary>
/// Task 28: live smoke test for the OPC UA Alarms &amp; Conditions adapter
/// Live smoke test for the OPC UA Alarms &amp; Conditions adapter
/// (<see cref="OpcUaDataConnection"/> as <c>IAlarmSubscribableConnection</c>).
///
/// Round-trips against an alarm-capable OPC UA endpoint
@@ -28,6 +28,8 @@ public class OpcUaAlarmLiveSmokeTests
{
private const string EndpointUrl = "opc.tcp://localhost:50000";
/// <summary>Verifies that subscribing to alarms delivers a condition refresh snapshot.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task SubscribeAlarms_DeliversConditionRefreshSnapshot()
{
@@ -80,6 +82,8 @@ public class OpcUaAlarmLiveSmokeTests
}
}
/// <summary>Verifies that two boiler alarm sources keep distinct refresh scopes and epochs.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task TwoBoilerSources_KeepDistinctRefreshScopesAndEpochs()
{