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
@@ -4,10 +4,11 @@ using Serilog.Events;
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>
/// WP-14: Tests for Serilog structured logging with enriched properties.
/// Tests for Serilog structured logging with enriched properties.
/// </summary>
public class SerilogTests
{
/// <summary>Verifies that the Serilog logger enriches events with node properties.</summary>
[Fact]
public void SerilogLogger_EnrichesWithNodeProperties()
{
@@ -35,6 +36,7 @@ public class SerilogTests
Assert.Equal("\"Site\"", logEvent.Properties["NodeRole"].ToString());
}
/// <summary>Verifies that the logger enriches events with a site id of Central for the central role.</summary>
[Fact]
public void SerilogLogger_CentralRole_EnrichesSiteIdAsCentral()
{
@@ -63,8 +65,11 @@ public class SerilogTests
/// </summary>
public class InMemorySink : Serilog.Core.ILogEventSink
{
/// <summary>Gets the log events captured so far.</summary>
public List<LogEvent> LogEvents { get; } = new();
/// <summary>Stores the log event for later assertions.</summary>
/// <param name="logEvent">The log event to capture.</param>
public void Emit(LogEvent logEvent)
{
LogEvents.Add(logEvent);