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
@@ -16,6 +16,9 @@ public class SiteCallAuditOptionsValidatorTests
private static ValidateOptionsResult Validate(SiteCallAuditOptions options) =>
new SiteCallAuditOptionsValidator().Validate(Options.DefaultName, options);
/// <summary>Verifies that the reconciliation batch size is valid only up to the RPC ceiling.</summary>
/// <param name="size">The reconciliation batch size under test.</param>
/// <param name="valid">Whether the batch size is expected to pass validation.</param>
[Theory]
[InlineData(1, true)]
[InlineData(2000, true)]
@@ -24,6 +27,7 @@ public class SiteCallAuditOptionsValidatorTests
public void ReconciliationBatchSize_MatchesRpcCeiling(int size, bool valid)
=> Assert.Equal(valid, Validate(new SiteCallAuditOptions { ReconciliationBatchSize = size }).Succeeded);
/// <summary>Verifies that the default options are valid.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
@@ -31,6 +35,7 @@ public class SiteCallAuditOptionsValidatorTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that a zero stuck-age threshold is rejected.</summary>
[Fact]
public void ZeroStuckAgeThreshold_IsRejected()
{
@@ -39,6 +44,7 @@ public class SiteCallAuditOptionsValidatorTests
Assert.Contains("StuckAgeThreshold", result.FailureMessage);
}
/// <summary>Verifies that a zero KPI interval is rejected.</summary>
[Fact]
public void ZeroKpiInterval_IsRejected()
{
@@ -47,6 +53,7 @@ public class SiteCallAuditOptionsValidatorTests
Assert.Contains("KpiInterval", result.FailureMessage);
}
/// <summary>Verifies that a zero relay timeout is rejected.</summary>
[Fact]
public void ZeroRelayTimeout_IsRejected()
{
@@ -55,6 +62,7 @@ public class SiteCallAuditOptionsValidatorTests
Assert.Contains("RelayTimeout", result.FailureMessage);
}
/// <summary>Verifies that a zero reconciliation interval is rejected.</summary>
[Fact]
public void ZeroReconciliationInterval_IsRejected()
{
@@ -63,6 +71,7 @@ public class SiteCallAuditOptionsValidatorTests
Assert.Contains("ReconciliationInterval", result.FailureMessage);
}
/// <summary>Verifies that a zero reconciliation batch size is rejected.</summary>
[Fact]
public void ZeroReconciliationBatchSize_IsRejected()
{
@@ -71,6 +80,7 @@ public class SiteCallAuditOptionsValidatorTests
Assert.Contains("ReconciliationBatchSize", result.FailureMessage);
}
/// <summary>Verifies that a zero purge interval is rejected.</summary>
[Fact]
public void ZeroPurgeInterval_IsRejected()
{
@@ -79,6 +89,7 @@ public class SiteCallAuditOptionsValidatorTests
Assert.Contains("PurgeInterval", result.FailureMessage);
}
/// <summary>Verifies that zero retention days is rejected.</summary>
[Fact]
public void ZeroRetentionDays_IsRejected()
{