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
@@ -6,6 +6,7 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages;
public class AlarmStateChangedEnrichmentTests
{
/// <summary>Verifies that a default alarm state change is of the computed kind with auto-acknowledge.</summary>
[Fact]
public void Defaults_AreComputedKind_WithAutoAck()
{
@@ -17,6 +18,7 @@ public class AlarmStateChangedEnrichmentTests
Assert.Equal("", m.SourceReference);
}
/// <summary>Verifies that the computed factory maps priority and state onto the message.</summary>
[Fact]
public void Factory_ForComputed_MapsPriorityAndState()
{
@@ -28,6 +30,7 @@ public class AlarmStateChangedEnrichmentTests
// ── MES alarm-status API §6.4: additive AckTime ──
/// <summary>Verifies that the acknowledge time defaults to null when using the positional constructor.</summary>
[Fact]
public void AckTime_DefaultsToNull_OnThePositionalConstructor()
{
@@ -40,6 +43,7 @@ public class AlarmStateChangedEnrichmentTests
Assert.Null(m.AckTime); // …yet still no ack instant
}
/// <summary>Verifies that the acknowledge time round-trips through its init property.</summary>
[Fact]
public void AckTime_RoundTripsThroughTheInitProperty()
{