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,6 +5,10 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Scripts;
/// <summary>Flow Debugger script entry (design 2026-09-08 §2): the monitored attribute of a ValueChange/Conditional trigger.</summary>
public class ScriptTriggerAttributeTests
{
/// <summary>Verifies the case: write Kinds, return The Monitored Attribute.</summary>
/// <param name="kind">The kind test input.</param>
/// <param name="config">The config test input.</param>
/// <param name="expected">The expected test input.</param>
[Theory]
[InlineData("ValueChange", """{"attributeName":"Level"}""", "Level")]
[InlineData("valuechange", """{"attribute":"Level"}""", "Level")]
@@ -17,6 +21,9 @@ public class ScriptTriggerAttributeTests
Assert.True(ScriptTriggerAttribute.IsWriteKind(kind));
}
/// <summary>Verifies the case: other Kinds, return False, even When The Config Names An Attribute.</summary>
/// <param name="kind">The kind test input.</param>
/// <param name="config">The config test input.</param>
[Theory]
[InlineData("Call", """{"attributeName":"Level"}""")]
[InlineData("Interval", """{"intervalMs":1000}""")]
@@ -30,6 +37,9 @@ public class ScriptTriggerAttributeTests
Assert.False(ScriptTriggerAttribute.IsWriteKind(kind));
}
/// <summary>Verifies the case: write Kind, without AReadable Attribute, returns False, but Is Still AWrite Kind.</summary>
/// <param name="kind">The kind test input.</param>
/// <param name="config">The config test input.</param>
[Theory]
[InlineData("ValueChange", null)]
[InlineData("ValueChange", "")]