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
@@ -14,6 +14,7 @@ public class SiteEventLogOptionsValidatorTests
private static ValidateOptionsResult Validate(SiteEventLogOptions options) =>
new SiteEventLogOptionsValidator().Validate(Options.DefaultName, options);
/// <summary>Verifies that the default options are valid.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
@@ -21,6 +22,7 @@ public class SiteEventLogOptionsValidatorTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that zero retention days is rejected.</summary>
[Fact]
public void ZeroRetentionDays_IsRejected()
{
@@ -30,6 +32,7 @@ public class SiteEventLogOptionsValidatorTests
Assert.Contains("RetentionDays", result.FailureMessage);
}
/// <summary>Verifies that a zero purge interval is rejected.</summary>
[Fact]
public void ZeroPurgeInterval_IsRejected()
{
@@ -39,6 +42,7 @@ public class SiteEventLogOptionsValidatorTests
Assert.Contains("PurgeInterval", result.FailureMessage);
}
/// <summary>Verifies that a maximum query page size below the default page size is rejected.</summary>
[Fact]
public void MaxQueryPageSize_BelowQueryPageSize_IsRejected()
{
@@ -50,6 +54,7 @@ public class SiteEventLogOptionsValidatorTests
// ── Register row 34: the per-tick purge ceiling ──
/// <summary>Verifies that a negative maximum of purged rows per tick is rejected.</summary>
[Fact]
public void NegativeMaxPurgedRowsPerTick_IsRejected()
{
@@ -61,6 +66,7 @@ public class SiteEventLogOptionsValidatorTests
Assert.Contains("MaxPurgedRowsPerTick", result.FailureMessage);
}
/// <summary>Verifies that a zero maximum of purged rows per tick (unlimited) is accepted.</summary>
[Fact]
public void ZeroMaxPurgedRowsPerTick_IsAccepted()
{
@@ -70,6 +76,7 @@ public class SiteEventLogOptionsValidatorTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that a zero purge catch-up interval is rejected.</summary>
[Fact]
public void ZeroPurgeCatchUpInterval_IsRejected()
{
@@ -80,6 +87,7 @@ public class SiteEventLogOptionsValidatorTests
Assert.Contains("PurgeCatchUpInterval", result.FailureMessage);
}
/// <summary>Verifies that a purge catch-up interval longer than the purge interval is rejected.</summary>
[Fact]
public void PurgeCatchUpInterval_LongerThanPurgeInterval_IsRejected()
{