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,7 +6,7 @@ using ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Cluster;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Audit;
/// <summary>
/// Direct-SQL seeding helper for the Audit Log Playwright E2E tests (#23 M7-T16).
/// Direct-SQL seeding helper for the Audit Log Playwright E2E tests.
///
/// <para>
/// The Playwright suite runs against the live Docker cluster (the same one that
@@ -50,6 +50,25 @@ internal static class AuditDataSeeder
/// derive automatically. All optional fields are nullable so individual tests can shape
/// the row to whatever payload they need for their drawer/grid assertions.
/// </summary>
/// <param name="eventId">The unique event identifier.</param>
/// <param name="occurredAtUtc">When the event occurred, in UTC.</param>
/// <param name="channel">The audit channel.</param>
/// <param name="kind">The audit kind.</param>
/// <param name="status">The audit status.</param>
/// <param name="sourceSiteId">The originating site identifier, if any.</param>
/// <param name="target">The call target, if any.</param>
/// <param name="actor">The acting principal, if any.</param>
/// <param name="correlationId">The per-operation correlation identifier, if any.</param>
/// <param name="executionId">The per-run execution identifier, if any.</param>
/// <param name="parentExecutionId">The spawning execution identifier, if any.</param>
/// <param name="httpStatus">The HTTP status code, if any.</param>
/// <param name="durationMs">The duration in milliseconds, if any.</param>
/// <param name="errorMessage">The error message, if any.</param>
/// <param name="requestSummary">The request summary, if any.</param>
/// <param name="responseSummary">The response summary, if any.</param>
/// <param name="extra">Additional JSON details, if any.</param>
/// <param name="ct">A token to cancel the operation.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
public static async Task InsertAuditEventAsync(
Guid eventId,
DateTime occurredAtUtc,
@@ -135,6 +154,9 @@ VALUES
/// stuck row carrying a random GUID suffix does not collide with future
/// runs and tests should not fail teardown.
/// </summary>
/// <param name="targetPrefix">The target prefix identifying the rows to delete.</param>
/// <param name="ct">A token to cancel the operation.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
public static async Task DeleteByTargetPrefixAsync(string targetPrefix, CancellationToken ct = default)
{
try
@@ -158,6 +180,8 @@ VALUES
/// per-test setup on this; when the cluster is down the test fails with a
/// clear "MSSQL unavailable" message instead of an opaque SqlException.
/// </summary>
/// <param name="ct">A token to cancel the operation.</param>
/// <returns><c>true</c> if the database accepted a connection; otherwise <c>false</c>.</returns>
public static async Task<bool> IsAvailableAsync(CancellationToken ct = default)
{
try