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
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.InboundApi;
namespace ZB.MOM.WW.ScadaBridge.InboundAPI.Tests;
/// <summary>
/// M9-T32b runtime regression: the InboundAPI RUNTIME validators
/// Runtime regression: the InboundAPI RUNTIME validators
/// (<see cref="ParameterValidator"/> / <see cref="ReturnValueValidator"/>) must
/// resolve <c>{"$ref":"lib:Name"}</c> library references through the same seam the
/// deploy-time path uses. Before this fix the runtime validators called the
@@ -31,6 +31,7 @@ public class SchemaRefRuntimeValidationTests
// ── ParameterValidator: $ref in parameter definitions ─────────────────────
/// <summary>Verifies that the parameter validator resolves a valid library reference and validates against it.</summary>
[Fact]
public void ParameterValidator_ValidLibRef_ResolvesAndValidates()
{
@@ -60,6 +61,7 @@ public class SchemaRefRuntimeValidationTests
Assert.DoesNotContain("definitions in method configuration", bad.ErrorMessage);
}
/// <summary>Verifies that the parameter validator returns a clear invalid result naming a dangling library reference.</summary>
[Fact]
public void ParameterValidator_DanglingLibRef_ReturnsClearInvalidNamingTheRef()
{
@@ -78,6 +80,7 @@ public class SchemaRefRuntimeValidationTests
Assert.Contains("GoneLib", result.ErrorMessage!, StringComparison.Ordinal);
}
/// <summary>Verifies that the parameter validator behaves unchanged without a resolver when there is no reference.</summary>
[Fact]
public void ParameterValidator_NoRef_UnchangedWithoutResolver()
{
@@ -96,6 +99,7 @@ public class SchemaRefRuntimeValidationTests
// ── ReturnValueValidator: $ref in return definition ───────────────────────
/// <summary>Verifies that the return value validator resolves a valid library reference and validates against it.</summary>
[Fact]
public void ReturnValueValidator_ValidLibRef_ResolvesAndValidates()
{
@@ -121,6 +125,7 @@ public class SchemaRefRuntimeValidationTests
Assert.DoesNotContain("definition in method configuration", bad.ErrorMessage);
}
/// <summary>Verifies that the return value validator returns a clear invalid result naming a dangling library reference.</summary>
[Fact]
public void ReturnValueValidator_DanglingLibRef_ReturnsClearInvalidNamingTheRef()
{
@@ -135,6 +140,7 @@ public class SchemaRefRuntimeValidationTests
Assert.Contains("GoneReturn", result.ErrorMessage, StringComparison.Ordinal);
}
/// <summary>Verifies that the return value validator behaves unchanged without a resolver when there is no reference.</summary>
[Fact]
public void ReturnValueValidator_NoRef_UnchangedWithoutResolver()
{