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
@@ -21,7 +21,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Templates;
namespace ZB.MOM.WW.ScadaBridge.Transport.IntegrationTests.Import;
/// <summary>
/// Integration tests for Area-by-name transport (Task 7): a source instance
/// Integration tests for Area-by-name transport: a source instance
/// assigned to an <see cref="Area"/> under its site must carry that area's NAME
/// through the exported bundle so the importer's <c>ResolveOrCreateAreaIdAsync</c>
/// machinery can resolve-or-create the equivalent area under the target site. This
@@ -36,6 +36,7 @@ public sealed class AreaTransportTests : IDisposable
{
private readonly ServiceProvider _provider;
/// <summary>Builds the service provider with an in-memory database and the Transport services.</summary>
public AreaTransportTests()
{
var services = new ServiceCollection();
@@ -60,12 +61,15 @@ public sealed class AreaTransportTests : IDisposable
_provider = services.BuildServiceProvider();
}
/// <summary>Releases the resources used by this instance.</summary>
public void Dispose() => _provider.Dispose();
/// <summary>Verifies that an instance's area travels by name and resolves under the target site.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Instance_Area_travels_by_name_and_resolves_under_target_site()
{
// ---- Seed a site + instance assigned to an Area "Line-1" ----
// ---- Seed a site + instance assigned to an Area "Line 1" ----
await using (var scope = _provider.CreateAsyncScope())
{
var ctx = scope.ServiceProvider.GetRequiredService<ScadaBridgeDbContext>();
@@ -161,7 +165,7 @@ public sealed class AreaTransportTests : IDisposable
}
// ---- Assert: the imported instance's AreaId resolves to an Area named
// "Line-1" under the target site (NOT null). ----
// "Line 1" under the target site (NOT null). ----
await using (var scope = _provider.CreateAsyncScope())
{
var ctx = scope.ServiceProvider.GetRequiredService<ScadaBridgeDbContext>();