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
@@ -5,7 +5,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Templates;
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests;
/// <summary>
/// Tests for the compact <c>template list</c>/<c>get</c> table projection (followup #6):
/// Tests for the compact <c>template list</c>/<c>get</c> table projection:
/// the full per-template attribute/alarm/script dumps are collapsed to counts so table
/// output is usable in a terminal, while the array/object shape is preserved.
///
@@ -48,6 +48,7 @@ public class TemplateTableProjectionTests
]
""";
/// <summary>Verifies that projecting an array drops the per-member arrays and keeps their counts.</summary>
[Fact]
public void ProjectSummary_Array_DropsMemberArraysAndKeepsCounts()
{
@@ -82,6 +83,7 @@ public class TemplateTableProjectionTests
Assert.Equal(JsonValueKind.Null, second.GetProperty("description").ValueKind);
}
/// <summary>Verifies that projecting a single object produces a compact object.</summary>
[Fact]
public void ProjectSummary_SingleObject_ProducesCompactObject()
{
@@ -167,6 +169,7 @@ public class TemplateTableProjectionTests
Assert.Equal(42, doc.RootElement.GetProperty("#attrs").GetInt32());
}
/// <summary>Verifies that non-JSON input is returned verbatim.</summary>
[Fact]
public void ProjectSummary_NonJson_ReturnedVerbatim()
{
@@ -174,6 +177,7 @@ public class TemplateTableProjectionTests
Assert.Equal(notJson, TemplateTableProjection.ProjectSummary(notJson));
}
/// <summary>Verifies that the summary projection is substantially smaller than the full dump.</summary>
[Fact]
public void ProjectSummary_IsSubstantiallySmallerThanFullDump()
{