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.CLI.Tests;
[Collection("Console")]
public class CommandHelpersTests
{
/// <summary>Verifies that a successful response in JSON format returns exit code zero.</summary>
[Fact]
public void HandleResponse_Success_JsonFormat_ReturnsZero()
{
@@ -21,6 +22,7 @@ public class CommandHelpersTests
Console.SetOut(new StreamWriter(Console.OpenStandardOutput()) { AutoFlush = true });
}
/// <summary>Verifies that a successful response with array data in table format returns exit code zero.</summary>
[Fact]
public void HandleResponse_Success_TableFormat_ArrayData_ReturnsZero()
{
@@ -41,6 +43,7 @@ public class CommandHelpersTests
Console.SetOut(new StreamWriter(Console.OpenStandardOutput()) { AutoFlush = true });
}
/// <summary>Verifies that a successful response with object data in table format returns exit code zero.</summary>
[Fact]
public void HandleResponse_Success_TableFormat_ObjectData_ReturnsZero()
{
@@ -61,6 +64,7 @@ public class CommandHelpersTests
Console.SetOut(new StreamWriter(Console.OpenStandardOutput()) { AutoFlush = true });
}
/// <summary>Verifies that an empty array in table format reports that there are no results.</summary>
[Fact]
public void HandleResponse_Success_TableFormat_EmptyArray_ShowsNoResults()
{
@@ -76,6 +80,7 @@ public class CommandHelpersTests
Console.SetOut(new StreamWriter(Console.OpenStandardOutput()) { AutoFlush = true });
}
/// <summary>Verifies that an error response returns exit code one.</summary>
[Fact]
public void HandleResponse_Error_ReturnsOne()
{
@@ -91,6 +96,7 @@ public class CommandHelpersTests
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
/// <summary>Verifies that an unauthorized response returns exit code two.</summary>
[Fact]
public void HandleResponse_Unauthorized_ReturnsTwo()
{
@@ -106,6 +112,7 @@ public class CommandHelpersTests
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
/// <summary>Verifies that an authentication failure response returns exit code one.</summary>
[Fact]
public void HandleResponse_AuthFailure_ReturnsOne()
{
@@ -121,6 +128,7 @@ public class CommandHelpersTests
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
/// <summary>Verifies that a connection failure response returns exit code one.</summary>
[Fact]
public void HandleResponse_ConnectionFailure_ReturnsOne()
{
@@ -136,6 +144,7 @@ public class CommandHelpersTests
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
/// <summary>Verifies that a timeout response returns exit code one.</summary>
[Fact]
public void HandleResponse_Timeout_ReturnsOne()
{