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
@@ -5,7 +5,7 @@ namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
/// <summary>
/// Tests for the <c>table</c> output formatter of the <c>scadabridge audit query</c>
/// subcommand (Audit Log #23 M8-T6): header rendering, long-field truncation, the
/// subcommand: header rendering, long-field truncation, the
/// empty-result-set case, and null-actor handling.
/// </summary>
public class AuditTableFormatterTests
@@ -18,6 +18,7 @@ public class AuditTableFormatterTests
.ToList();
}
/// <summary>Verifies that the table renders a header row with the expected columns.</summary>
[Fact]
public void Table_RendersHeaderRow_WithExpectedColumns()
{
@@ -38,6 +39,7 @@ public class AuditTableFormatterTests
}
}
/// <summary>Verifies that a long target is truncated with an ellipsis.</summary>
[Fact]
public void Table_TruncatesLongTarget_WithEllipsis()
{
@@ -57,6 +59,7 @@ public class AuditTableFormatterTests
Assert.DoesNotContain(longTarget, text);
}
/// <summary>Verifies that an empty result set renders only the header or a no-rows message.</summary>
[Fact]
public void Table_EmptyResultSet_RendersHeaderOnly_OrNoRowsMessage()
{
@@ -73,6 +76,7 @@ public class AuditTableFormatterTests
Assert.Contains("OccurredAtUtc", lines[0]);
}
/// <summary>Verifies that a null actor renders as a blank cell.</summary>
[Fact]
public void Table_NullActor_RendersBlank()
{
@@ -93,6 +97,7 @@ public class AuditTableFormatterTests
Assert.Contains("InboundApi", lines[1]);
}
/// <summary>Verifies that the header is emitted once per page and the data rows are aligned.</summary>
[Fact]
public void Table_HeaderEmittedOncePerPage_DataRowsAligned()
{