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,6 +4,7 @@ namespace ZB.MOM.WW.ScadaBridge.DelmiaNotifier.Tests;
public class ArgParserTests
{
/// <summary>Verifies that all short flags are parsed into the payload.</summary>
[Fact]
public void Parses_all_flags()
{
@@ -17,6 +18,7 @@ public class ArgParserTests
Assert.Equal("op", r.Payload.Username);
}
/// <summary>Verifies that long-form flags are parsed into the payload.</summary>
[Fact]
public void Parses_long_flags()
{
@@ -26,6 +28,7 @@ public class ArgParserTests
Assert.Equal("x", r.Payload.DownloadPath);
}
/// <summary>Verifies that omitting a required flag returns an error.</summary>
[Fact]
public void Missing_required_returns_error()
{
@@ -34,6 +37,7 @@ public class ArgParserTests
Assert.Contains("partnumber", r.Error, System.StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that optional flags may be omitted without error.</summary>
[Fact]
public void Optional_flags_may_be_omitted()
{
@@ -43,6 +47,7 @@ public class ArgParserTests
Assert.Null(r.Payload.JobStepNumber);
}
/// <summary>Verifies that an unknown flag returns an error.</summary>
[Fact]
public void Unknown_flag_returns_error()
{
@@ -50,6 +55,7 @@ public class ArgParserTests
Assert.False(r.Ok);
}
/// <summary>Verifies that a flag without a value returns an error.</summary>
[Fact]
public void Flag_without_value_returns_error()
{