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,8 @@ namespace ZB.MOM.WW.ScadaBridge.DelmiaNotifier.Tests;
public class HttpRecipeSenderTests
{
/// <summary>Verifies the case: DC7, explicit Standby Refusal, tries Second Url, but Generic503 Does Not.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DC7_ExplicitStandbyRefusal_TriesSecondUrl_ButGeneric503DoesNot()
{
@@ -27,6 +29,8 @@ public class HttpRecipeSenderTests
}
}
/// <summary>Verifies the case: DC7, applied Then Response Lost, does Not Replay.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DC7_AppliedThenResponseLost_DoesNotReplay()
{
@@ -39,8 +43,10 @@ public class HttpRecipeSenderTests
private sealed class StubHandler(Func<HttpRequestMessage, HttpResponseMessage> responder) : HttpMessageHandler
{
/// <summary>Gets the last HTTP request seen by this handler.</summary>
public HttpRequestMessage? LastRequest { get; private set; }
/// <inheritdoc />
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
LastRequest = request;
@@ -51,6 +57,8 @@ public class HttpRecipeSenderTests
private static readonly RecipeDownload Payload =
new() { MachineCode = "Z", DownloadPath = "x", WorkOrderNumber = "W", PartNumber = "P" };
/// <summary>Verifies the case: connect Failure, maps, to, connect Failed.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectFailure_maps_to_ConnectFailed()
{
@@ -62,6 +70,8 @@ public class HttpRecipeSenderTests
Assert.Equal(0, outcome.StatusCode);
}
/// <summary>Verifies the case: success, 200, parses, body, and, sends, header, and, path.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Success_200_parses_body_and_sends_header_and_path()
{
@@ -80,6 +90,8 @@ public class HttpRecipeSenderTests
Assert.Equal("http://a/api/DelmiaRecipeDownload", handler.LastRequest.RequestUri!.ToString());
}
/// <summary>Verifies the case: non2xx, is, connected, with, status.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Non2xx_is_Connected_with_status()
{