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.CentralUI.PlaywrightTests.SiteCalls;
/// <summary>
/// Direct-SQL seeding helper for the Site Calls page Playwright E2E tests
/// (Site Call Audit #22, follow-ups Task 6).
/// (Site Call Audit).
///
/// <para>
/// The Site Calls page reads the central <c>SiteCalls</c> table through the
@@ -38,6 +38,19 @@ internal static class SiteCallDataSeeder
/// needs for its grid assertions. <c>TrackedOperationId</c> is stored as the
/// 36-character GUID string the entity mapping expects.
/// </summary>
/// <param name="trackedOperationId">The tracked operation id of the row.</param>
/// <param name="channel">The channel of the site call.</param>
/// <param name="target">The target of the site call.</param>
/// <param name="sourceSite">The identifier of the originating site.</param>
/// <param name="status">The status of the site call.</param>
/// <param name="retryCount">The retry count.</param>
/// <param name="createdAtUtc">The UTC creation time.</param>
/// <param name="updatedAtUtc">The UTC time of the last update.</param>
/// <param name="lastError">The last error message, if any.</param>
/// <param name="httpStatus">The HTTP status code of the last attempt, if any.</param>
/// <param name="terminalAtUtc">The UTC time the call reached a terminal status, 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 InsertSiteCallAsync(
Guid trackedOperationId,
string channel,
@@ -84,6 +97,9 @@ VALUES
/// starts with <paramref name="targetPrefix"/>. Swallows all errors — the
/// prefix carries a per-run GUID so the rows are unique to this test run.
/// </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
@@ -107,6 +123,8 @@ VALUES
/// setup on this so a downed cluster surfaces a clear message rather than an
/// opaque <see cref="SqlException"/>.
/// </summary>
/// <param name="ct">A token to cancel the operation.</param>
/// <returns>A task that resolves to <c>true</c> when the configuration database is reachable; otherwise <c>false</c>.</returns>
public static async Task<bool> IsAvailableAsync(CancellationToken ct = default)
{
try