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
@@ -12,6 +12,8 @@ namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Central;
/// </summary>
public class AuditLogPurgeOptionsValidatorTests
{
/// <summary>Verifies that the default options are valid.</summary>
/// <returns>The result.</returns>
[Fact]
public void DefaultOptions_AreValid()
{
@@ -19,6 +21,8 @@ public class AuditLogPurgeOptionsValidatorTests
Assert.True(validator.Validate(null, new AuditLogPurgeOptions()).Succeeded);
}
/// <summary>Verifies that a zero interval in hours fails validation.</summary>
/// <returns>The result.</returns>
[Fact]
public void ZeroIntervalHours_Fails()
{
@@ -29,6 +33,8 @@ public class AuditLogPurgeOptionsValidatorTests
f => f.Contains(nameof(AuditLogPurgeOptions.IntervalHours), StringComparison.Ordinal));
}
/// <summary>Verifies that a zero channel purge batch size fails validation.</summary>
/// <returns>The result.</returns>
[Fact]
public void ZeroChannelPurgeBatchSize_Fails()
{
@@ -40,6 +46,8 @@ public class AuditLogPurgeOptionsValidatorTests
f => f.Contains(nameof(AuditLogPurgeOptions.ChannelPurgeBatchSizeConfigured), StringComparison.Ordinal));
}
/// <summary>Verifies that a zero maintenance command timeout fails validation.</summary>
/// <returns>The result.</returns>
[Fact]
public void ZeroMaintenanceCommandTimeout_Fails()
{