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.Notifications;
/// <summary>
/// End-to-end coverage for the central Notification Report page's Retry / Discard
/// actions on parked notifications (Notification Outbox #21).
/// actions on parked notifications (Notification Outbox).
///
/// <para>
/// Each test seeds its own <c>Parked</c> row directly into the running cluster's
@@ -34,6 +34,8 @@ public class NotificationActionTests
private readonly PlaywrightFixture _fixture;
/// <summary>Initializes the test class with the shared Playwright fixture.</summary>
/// <param name="fixture">The shared Playwright fixture.</param>
public NotificationActionTests(PlaywrightFixture fixture)
{
_fixture = fixture;
@@ -94,6 +96,8 @@ public class NotificationActionTests
return (page, row);
}
/// <summary>Verifies that retrying a parked notification shows an outcome toast.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task Retry_ParkedNotification_ShowsOutcomeToast()
{
@@ -133,6 +137,8 @@ public class NotificationActionTests
}
}
/// <summary>Verifies that discarding a parked notification shows an outcome toast.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task Discard_ParkedNotification_ShowsOutcomeToast()
{
@@ -179,6 +185,7 @@ public class NotificationActionTests
/// than widening — the marker isolates the pair from ambient cluster rows, and the
/// subject keyword discriminates between them.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task FilterCombination_StatusPlusList_NarrowsToMatch()
{
@@ -237,6 +244,7 @@ public class NotificationActionTests
/// close affordances are wired to the same <c>CloseDetail</c> handler; this exercises
/// each path independently (open → X-close → reopen → footer-close).
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task DetailModal_OpenOnDblClick_CloseViaXAndFooter()
{
@@ -308,6 +316,7 @@ public class NotificationActionTests
/// docker cluster carries no override — so a Retrying row back-dated 15 min passes both
/// the repository's StuckOnly SQL predicate and the page's <c>IsStuck</c> derivation.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task StuckOnlyFilter_NarrowsToStuckRows()
{
@@ -384,6 +393,7 @@ public class NotificationActionTests
/// disables both pager buttons — so the button-state assertions never race the in-flight
/// query.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task Pagination_PageNumberNextAndPrev_TraversesPages()
{
@@ -413,7 +423,7 @@ public class NotificationActionTests
await page.Locator("button.btn-primary:has-text('Query')").ClickAsync();
await page.WaitForLoadStateAsync(LoadState.NetworkIdle);
// Pager locators (M10 OffsetPager). Previous/Next are the pager's data-test
// Pager locators (OffsetPager). Previous/Next are the pager's data-test
// hooks (the page header's Refresh button is also a .btn-outline-secondary.btn-sm,
// so we no longer scope by text). The summary span carries the page/total readout
// ("Page {N} of {Y} · {Total} total").