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
@@ -10,8 +10,7 @@ namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Site;
/// non-positive value has a documented fall-back-to-30s contract.
/// </summary>
/// <remarks>
/// <c>DatabasePath</c> is intentionally NOT covered here (arch-review remediation
/// WP1.2): it defaults to <c>""</c> (no CWD-relative default — mirrors
/// <c>DatabasePath</c> is intentionally NOT covered here (arch-review remediation): it defaults to <c>""</c> (no CWD-relative default — mirrors
/// <c>LocalDb:Path</c>), but this validator runs on both Central and Site
/// composition roots via <c>ValidateOnStart</c>, and only Site nodes ever resolve
/// the writer. The Site-only requirement is enforced pre-host by
@@ -20,6 +19,7 @@ namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Site;
/// </remarks>
public class SqliteAuditWriterOptionsValidatorTests
{
/// <summary>Verifies that the default options pass validation.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
@@ -29,6 +29,7 @@ public class SqliteAuditWriterOptionsValidatorTests
Assert.True(validator.Validate(null, new SqliteAuditWriterOptions()).Succeeded);
}
/// <summary>Verifies that a channel capacity of zero fails validation.</summary>
[Fact]
public void ZeroChannelCapacity_Fails()
{
@@ -39,6 +40,7 @@ public class SqliteAuditWriterOptionsValidatorTests
f => f.Contains(nameof(SqliteAuditWriterOptions.ChannelCapacity), StringComparison.Ordinal));
}
/// <summary>Verifies that a batch size of zero fails validation.</summary>
[Fact]
public void ZeroBatchSize_Fails()
{
@@ -49,6 +51,7 @@ public class SqliteAuditWriterOptionsValidatorTests
f => f.Contains(nameof(SqliteAuditWriterOptions.BatchSize), StringComparison.Ordinal));
}
/// <summary>Verifies that a flush interval of zero fails validation.</summary>
[Fact]
public void ZeroFlushInterval_Fails()
{
@@ -59,6 +62,8 @@ public class SqliteAuditWriterOptionsValidatorTests
f => f.Contains(nameof(SqliteAuditWriterOptions.FlushIntervalMs), StringComparison.Ordinal));
}
/// <summary>Verifies that a non-positive backlog poll interval still passes validation.</summary>
/// <param name="value">The non-positive poll interval, in milliseconds, to validate.</param>
[Theory]
[InlineData(0)]
[InlineData(-1)]