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.
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -36,6 +36,8 @@ public class EventLogsTests

    private readonly PlaywrightFixture _fixture;

+    /// <summary>Initializes the test class with the Playwright fixture.</summary>
+    /// <param name="fixture">The Playwright browser fixture.</param>
    public EventLogsTests(PlaywrightFixture fixture)
    {
        _fixture = fixture;
@@ -46,6 +48,7 @@ public class EventLogsTests
    /// enabled once a site is selected from the site dropdown. Deterministic regardless
    /// of whether the site has any logged events.
    /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [SkippableFact]
    public async Task EventLogs_SearchGatedOnSiteSelection()
    {
@@ -76,6 +79,7 @@ public class EventLogsTests
    /// rows exist — a site may have zero logged events, and event logs are not seedable
    /// from central, so the empty-state render is itself the assertion in that case.
    /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [SkippableFact]
    public async Task EventLogs_Search_RendersTableOrEmptyState()
    {
@@ -50,6 +50,8 @@ public class HealthDashboardTests

    private readonly PlaywrightFixture _fixture;

+    /// <summary>Initializes the test class with the shared Playwright fixture.</summary>
+    /// <param name="fixture">The shared Playwright fixture.</param>
    public HealthDashboardTests(PlaywrightFixture fixture)
    {
        _fixture = fixture;
@@ -66,6 +68,7 @@ public class HealthDashboardTests
    /// rather than using a fixed sleep, so a fast cluster will pass quickly.
    /// </para>
    /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [SkippableFact]
    public async Task KpiTiles_ResolveToValues_NotDegradePlaceholder()
    {
@@ -83,10 +86,10 @@ public class HealthDashboardTests
        //
        //    Health.razor structure:
        //      <div class="d-flex ...">
-        //        <h6 class="text-muted mb-0">Notification Outbox</h6>  ← anchor
+        //        <h6 class="text-muted">Notification Outbox</h6>  ← anchor
        //        <a ...>View details →</a>
        //      </div>
-        //      <div class="row g-3 mb-3">            ← outboxSection (+sibling)
+        //      <div class="row g-3">          ← outboxSection (+sibling)
        //        <div class="col-..."><div class="card">Queue Depth</div></div>
        //        <div class="col-..."><div class="card">Stuck</div></div>
        //        <div class="col-..."><div class="card">Parked</div></div>
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Cluster;
 namespace ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Monitoring;

 /// <summary>
-/// E2E coverage for the M6 "KPI History &amp; Trends" feature (K17's spec slice):
+/// E2E coverage for the "KPI History &amp; Trends" feature:
 /// proves a <c>KpiTrendChart</c> trend section renders in the live Central UI.
 ///
 /// <para>
@@ -51,6 +51,8 @@ public class KpiTrendChartTests

    private readonly PlaywrightFixture _fixture;

+    /// <summary>Initializes the test class with the shared Playwright fixture.</summary>
+    /// <param name="fixture">The shared Playwright fixture that provides the browser and login helpers.</param>
    public KpiTrendChartTests(PlaywrightFixture fixture)
    {
        _fixture = fixture;
@@ -62,6 +64,7 @@ public class KpiTrendChartTests
    /// <c>kpi-trend-*</c> card is present, and (tolerantly) reports whether any
    /// polyline has been plotted yet.
    /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [SkippableFact]
    public async Task NotificationKpis_RendersTrendSection_WithKpiTrendCards()
    {
@@ -36,6 +36,8 @@ public class ParkedMessagesActionTests
 {
    private readonly PlaywrightFixture _fixture;

+    /// <summary>Initializes the tests with the shared Playwright fixture.</summary>
+    /// <param name="fixture">The Playwright fixture that supplies authenticated browser pages.</param>
    public ParkedMessagesActionTests(PlaywrightFixture fixture)
    {
        _fixture = fixture;
@@ -45,6 +47,7 @@ public class ParkedMessagesActionTests
    /// The Query button must be disabled on page load (no site selected) and become
    /// enabled once a site is selected from the site dropdown.
    /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [SkippableFact]
    public async Task QueryButton_DisabledUntilSiteSelected()
    {
@@ -67,6 +70,7 @@ public class ParkedMessagesActionTests
    /// The Clear button must be disabled on page load (no active filters) and become
    /// enabled once any filter is changed. Clicking Clear must re-disable it.
    /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [SkippableFact]
    public async Task ClearButton_DisabledUntilFilterSet_ThenResets()
    {
@@ -93,6 +97,7 @@ public class ParkedMessagesActionTests
    /// are present (the common case in a clean test environment — parked rows are not
    /// seedable from central), the test exits early as a tolerated no-op.
    /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [SkippableFact]
    public async Task SelectingParkedRow_RevealsBulkRetryDiscardBar_WhenRowsPresent()
    {
@@ -34,11 +34,15 @@ public class ParkedMessagesTests

    private readonly PlaywrightFixture _fixture;

+    /// <summary>Initializes the test class with the shared Playwright fixture.</summary>
+    /// <param name="fixture">The shared Playwright fixture.</param>
    public ParkedMessagesTests(PlaywrightFixture fixture)
    {
        _fixture = fixture;
    }

+    /// <summary>Verifies that querying the parked messages page for a site renders without hanging.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [SkippableFact]
    public async Task ParkedMessages_QueryForSite_RendersWithoutHang()
    {