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 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Kpi;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Components.Shared;
/// <summary>
/// bUnit tests for <see cref="KpiTrendChart"/> (M6 K12) — the reusable
/// bUnit tests for <see cref="KpiTrendChart"/> — the reusable
/// dependency-free SVG trend chart. Coverage pins the three render states
/// (multi-point chart, unavailable placeholder, single-sample note), the stable
/// <c>data-test</c> slug, and the coordinate-math edge guards (all-equal
@@ -22,6 +22,7 @@ public class KpiTrendChartTests : BunitContext
new KpiSeriesPoint(Base.AddMinutes(10), 2.0),
};
/// <summary>Verifies that an available series with three points renders a polyline, a title and a data-test attribute.</summary>
[Fact]
public void Available_WithThreePoints_RendersPolylineTitleAndDataTest()
{
@@ -38,6 +39,7 @@ public class KpiTrendChartTests : BunitContext
Assert.Contains("<title>", markup);
}
/// <summary>Verifies that a unit is appended to the rendered value labels.</summary>
[Fact]
public void Available_WithUnit_AppendsUnitToValueLabels()
{
@@ -51,6 +53,7 @@ public class KpiTrendChartTests : BunitContext
Assert.Contains("max 4 s", cut.Markup);
}
/// <summary>Verifies that an unavailable series renders an em dash placeholder and the error text without a polyline.</summary>
[Fact]
public void Unavailable_RendersEmDashPlaceholderAndError_NoPolyline()
{
@@ -66,6 +69,7 @@ public class KpiTrendChartTests : BunitContext
Assert.DoesNotContain("<polyline", markup);
}
/// <summary>Verifies that null points render the placeholder without a polyline.</summary>
[Fact]
public void NullPoints_RendersPlaceholder_NoPolyline()
{
@@ -79,6 +83,7 @@ public class KpiTrendChartTests : BunitContext
Assert.DoesNotContain("<polyline", markup);
}
/// <summary>Verifies that a single point renders the single-sample state without a polyline and does not throw.</summary>
[Fact]
public void SinglePoint_RendersSingleSampleState_NoPolyline_DoesNotThrow()
{
@@ -92,6 +97,7 @@ public class KpiTrendChartTests : BunitContext
Assert.DoesNotContain("<polyline", markup);
}
/// <summary>Verifies that points with identical timestamps render a polyline without throwing.</summary>
[Fact]
public void AllEqualTimestamps_DoesNotThrow_AndRendersPolyline()
{
@@ -114,6 +120,7 @@ public class KpiTrendChartTests : BunitContext
Assert.DoesNotContain("Infinity", markup);
}
/// <summary>Verifies that all-zero values render a flat polyline without throwing.</summary>
[Fact]
public void AllZeroValues_DoesNotThrow_AndRendersFlatPolyline()
{
@@ -136,6 +143,9 @@ public class KpiTrendChartTests : BunitContext
Assert.DoesNotContain("Infinity", markup);
}
/// <summary>Verifies that a chart title is converted to a stable data-test slug.</summary>
/// <param name="title">The chart title to slugify.</param>
/// <param name="expectedDataTest">The expected data-test slug.</param>
[Theory]
[InlineData("Queue Depth", "kpi-trend-queue-depth")]
[InlineData("Oldest Pending (s)", "kpi-trend-oldest-pending-s")]