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.CLI.Commands;
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
/// <summary>
/// Tests for the <c>audit-log</c> → <c>audit-config</c> rename (Audit Log #23 M8-T7):
/// Tests for the <c>audit-log</c> → <c>audit-config</c> rename:
/// the new name parses, the deprecated <c>audit-log</c> alias still resolves the full
/// subcommand tree and emits a stderr deprecation warning, and the renamed group does
/// not collide with the distinct <c>audit</c> group from Bundle A.
@@ -28,6 +28,7 @@ public class AuditConfigDeprecationTests
return root;
}
/// <summary>Verifies that the audit-config query command works.</summary>
[Fact]
public void AuditConfig_Query_Works()
{
@@ -37,6 +38,7 @@ public class AuditConfigDeprecationTests
Assert.Empty(parse.Errors);
}
/// <summary>Verifies that the legacy audit-log query command still works but emits a deprecation warning to stderr.</summary>
[Fact]
public void AuditLog_Query_StillWorks_ButEmitsDeprecationWarning_ToStderr()
{
@@ -54,6 +56,7 @@ public class AuditConfigDeprecationTests
Assert.Contains("audit-config", warning);
}
/// <summary>Verifies that no deprecation warning is emitted when the new command name is used.</summary>
[Fact]
public void DeprecationWarning_NotEmitted_ForNewName()
{
@@ -64,6 +67,7 @@ public class AuditConfigDeprecationTests
Assert.Equal("", stderr.ToString());
}
/// <summary>Verifies that no deprecation warning is emitted for an unrelated command.</summary>
[Fact]
public void DeprecationWarning_NotEmitted_ForUnrelatedCommand()
{
@@ -73,6 +77,7 @@ public class AuditConfigDeprecationTests
Assert.Equal("", stderr.ToString());
}
/// <summary>Verifies that the audit and audit-config groups are distinct commands that do not conflict.</summary>
[Fact]
public void Audit_And_AuditConfig_AreDistinctCommands_NoConflict()
{