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.CentralUI.Services;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Design;
/// <summary>
/// M9-T31 (+#261 follow-up): the raw-JSON escape hatch in
/// The raw-JSON escape hatch in
/// <see cref="ParameterValueForm"/> (the fallback for an unresolved <c>$ref</c> /
/// unknown-type node) is a Monaco <c>json</c> editor wired with THAT FIELD's own
/// sub-schema — not the whole root object schema — so each field's editor
@@ -22,6 +22,7 @@ public class ParameterValueFormMonacoSchemaTests : BunitContext
{
private readonly ISchemaLibraryQueryService _library = Substitute.For<ISchemaLibraryQueryService>();
/// <summary>Initializes a new instance of the <see cref="ParameterValueFormMonacoSchemaTests"/> class.</summary>
public ParameterValueFormMonacoSchemaTests()
{
// The escape-hatch surface renders a MonacoEditor whose JS interop is not
@@ -33,6 +34,7 @@ public class ParameterValueFormMonacoSchemaTests : BunitContext
Services.AddSingleton(_library);
}
/// <summary>Verifies the case: escape Hatch, renders Monaco Json Editor, not Plain Textarea.</summary>
[Fact]
public void EscapeHatch_RendersMonacoJsonEditor_NotPlainTextarea()
{
@@ -57,6 +59,7 @@ public class ParameterValueFormMonacoSchemaTests : BunitContext
Assert.Empty(cut.FindAll("textarea"));
}
/// <summary>Verifies the case: escape Hatch, monaco Editor, receives Field Sub Schema, not Root Schema.</summary>
[Fact]
public void EscapeHatch_MonacoEditor_ReceivesFieldSubSchema_NotRootSchema()
{
@@ -106,6 +109,7 @@ public class ParameterValueFormMonacoSchemaTests : BunitContext
Assert.DoesNotContain("$ref", jsonSchema!);
}
/// <summary>Verifies the case: escape Hatch, with Resolvable Sibling Object, scopes Field Editor To Its Own Fragment.</summary>
[Fact]
public void EscapeHatch_WithResolvableSiblingObject_ScopesFieldEditorToItsOwnFragment()
{
@@ -143,6 +147,7 @@ public class ParameterValueFormMonacoSchemaTests : BunitContext
Assert.DoesNotContain("\"id\"", jsonSchema!);
}
/// <summary>Verifies the case: multiple Escape Hatch Fields, each Editor Receives Its Own Field Fragment, not Root Schema.</summary>
[Fact]
public void MultipleEscapeHatchFields_EachEditorReceivesItsOwnFieldFragment_NotRootSchema()
{
@@ -182,6 +187,7 @@ public class ParameterValueFormMonacoSchemaTests : BunitContext
}
}
/// <summary>Verifies the case: multiple Escape Hatch Fields, do Not Leak AResolvable Siblings Shape.</summary>
[Fact]
public void MultipleEscapeHatchFields_DoNotLeakAResolvableSiblingsShape()
{