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
@@ -29,12 +29,17 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
private readonly PlaywrightFixture _fixture;
private readonly InstanceConfigureFixture _cfg;
/// <summary>Initializes the tests with the shared Playwright and instance configuration fixtures.</summary>
/// <param name="fixture">The shared Playwright browser fixture.</param>
/// <param name="cfg">The fixture that provides the instance under test.</param>
public InstanceConfigureTests(PlaywrightFixture fixture, InstanceConfigureFixture cfg)
{
_fixture = fixture;
_cfg = cfg;
}
/// <summary>Verifies that binding all attributes through the bulk select saves and persists the bindings.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task BindAllAttributes_SavesAndPersists()
{
@@ -81,6 +86,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// exactly one toast, then verifies the override persisted via a CLI <c>instance get</c>
/// read-back (not just the toast).
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task SaveOverride_RoundTrips()
{
@@ -124,6 +130,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// mutates the shared fixture instance's area, but is independent of the other tests (each
/// gets a fresh page and asserts only on its own effect).
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task SetArea_RoundTrips()
{
@@ -156,6 +163,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// page's error alert (<c>data-test='instance-error-alert'</c>) carrying the
/// <c>$"Instance #{Id} not found."</c> message built in <c>InstanceConfigure.OnInitializedAsync</c>.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task NotFoundInstance_ShowsErrorAlert()
{
@@ -191,6 +199,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// <c>finally</c>, leaving the instance override-free as found.
/// </para>
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task AlarmOverride_SetPriority_ThenClear_RoundTrips()
{
@@ -265,6 +274,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// is intentionally left blank so the only delta is the setpoint.
/// </para>
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task AlarmOverride_HiLoSetpoint_Merges()
{
@@ -323,6 +333,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// per-key diff. ValueMatch / RangeViolation / RateOfChange overrides whole-replace the inherited
/// trigger config (unlike HiLo, which merges).
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task AlarmOverride_NonHiLo_WholeReplaces()
{
@@ -384,6 +395,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// branch in <c>SaveOverrideFromModal</c> that fires before any server round-trip.
/// </para>
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task AlarmOverride_InvalidValue_ShowsError_StaysOpen()
{
@@ -431,6 +443,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// gone), no toast/badge appears, and CLI read-back confirms NO override was written for the alarm
/// — the in-flight edit was discarded.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task AlarmOverride_Cancel_DiscardsChanges()
{
@@ -474,6 +487,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// own clear path (distinct from the row-level Clear button covered by
/// <see cref="AlarmOverride_SetPriority_ThenClear_RoundTrips"/>).
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task AlarmOverride_ClearFromModal_RemovesOverride()
{
@@ -537,6 +551,7 @@ public sealed class InstanceConfigureTests : IClassFixture<InstanceConfigureFixt
/// <c>finally</c>, exactly as <see cref="AlarmOverride_SetPriority_ThenClear_RoundTrips"/> does.
/// </para>
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task AlarmOverride_MesReportable_RoundTrips()
{