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
@@ -8,7 +8,7 @@ namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Tests.Maintenance;
/// <summary>
/// Integration tests for <see cref="AuditLogRepository.BackfillSourceNodeAsync"/>
/// (M5.6 T5 — SourceNode sentinel backfill).
/// (SourceNode sentinel backfill).
///
/// <para>
/// These tests exercise the real <see cref="AuditLogRepository"/> against a
@@ -21,6 +21,8 @@ public class BackfillSourceNodeTests : IClassFixture<MsSqlMigrationFixture>
{
private readonly MsSqlMigrationFixture _fixture;
/// <summary>Initializes the test class with the shared MSSQL migration fixture.</summary>
/// <param name="fixture">The shared MSSQL migration fixture.</param>
public BackfillSourceNodeTests(MsSqlMigrationFixture fixture)
{
_fixture = fixture;
@@ -83,6 +85,8 @@ VALUES
// 1. SetsNullRowsBeforeThreshold
// ------------------------------------------------------------------
/// <summary>Verifies that the backfill sets rows with a null source node that are before the threshold.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task BackfillSourceNode_SetsNullRowsBeforeThreshold()
{
@@ -118,6 +122,8 @@ VALUES
// 2. LeavesNonNullRowsUntouched
// ------------------------------------------------------------------
/// <summary>Verifies that the backfill leaves rows that already have a source node untouched.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task BackfillSourceNode_LeavesNonNullRowsUntouched()
{
@@ -144,6 +150,8 @@ VALUES
// 3. Idempotent_SecondRunUpdatesZeroRows
// ------------------------------------------------------------------
/// <summary>Verifies that the backfill is idempotent, so a second run updates zero rows.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task BackfillSourceNode_Idempotent_SecondRunUpdatesZeroRows()
{
@@ -181,6 +189,8 @@ VALUES
// 4. CustomSentinelIsWritten
// ------------------------------------------------------------------
/// <summary>Verifies that a custom sentinel value is written.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task BackfillSourceNode_CustomSentinel_IsWritten()
{
@@ -206,6 +216,8 @@ VALUES
// 5. ArgumentValidation
// ------------------------------------------------------------------
/// <summary>Verifies that an empty sentinel throws.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BackfillSourceNode_EmptySentinel_Throws()
{
@@ -222,6 +234,8 @@ VALUES
() => repo.BackfillSourceNodeAsync("", DateTime.UtcNow, 1000));
}
/// <summary>Verifies that a zero batch size throws.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BackfillSourceNode_ZeroBatchSize_Throws()
{