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
@@ -11,7 +11,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
namespace ZB.MOM.WW.ScadaBridge.PerformanceTests.AuditLog;
/// <summary>
/// Bundle D (M5-T9) / C7 (Task 2.5) hot-path latency budget for
/// Hot-path latency budget for
/// <see cref="ScadaBridgeAuditRedactor"/>. The redactor sits between event
/// construction and persistence on every audit row — site SQLite hot-path and
/// central direct-write both — so it MUST stay out of the way of script-thread
@@ -47,7 +47,7 @@ public class HotPathLatencyTests
private const int WarmupIterations = 200;
private const int MeasureIterations = 2_000;
// C3/C7 (Task 2.5): the hot-path redactor is the canonical
// The hot-path redactor is the canonical
// ScadaBridgeAuditRedactor (IAuditRedactor) operating on the canonical record.
private static ScadaBridgeAuditRedactor Filter(AuditLogOptions opts) => new(
new StaticMonitor(opts),
@@ -231,9 +231,18 @@ public class HotPathLatencyTests
private sealed class StaticMonitor : IOptionsMonitor<AuditLogOptions>
{
private readonly AuditLogOptions _value;
/// <summary>Creates a monitor that always returns the given options.</summary>
/// <param name="value">The options instance to return.</param>
public StaticMonitor(AuditLogOptions value) => _value = value;
/// <summary>Gets the fixed options instance.</summary>
public AuditLogOptions CurrentValue => _value;
/// <summary>Returns the fixed options instance regardless of name.</summary>
/// <param name="name">The options name, ignored.</param>
/// <returns>The fixed options instance.</returns>
public AuditLogOptions Get(string? name) => _value;
/// <summary>Ignores the listener because the options never change.</summary>
/// <param name="listener">The change listener, ignored.</param>
/// <returns>Always <see langword="null"/>.</returns>
public IDisposable? OnChange(Action<AuditLogOptions, string?> listener) => null;
}
}