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,13 +4,14 @@ using ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages;
/// <summary>
/// Regression tests for Commons-008 — <see cref="SetConnectionBindingsCommand"/>
/// Regression tests: <see cref="SetConnectionBindingsCommand"/>
/// previously declared its bindings as <c>IReadOnlyList&lt;(string, int)&gt;</c>.
/// A <c>ValueTuple</c> serializes as <c>Item1</c>/<c>Item2</c> and cannot evolve
/// additively (REQ-COM-5a). It is now a named <see cref="ConnectionBinding"/> record.
/// </summary>
public class ConnectionBindingSerializationTests
{
/// <summary>Verifies that connection binding serializes with named properties.</summary>
[Fact]
public void ConnectionBinding_SerializesWithNamedProperties()
{
@@ -26,6 +27,7 @@ public class ConnectionBindingSerializationTests
Assert.False(doc.RootElement.TryGetProperty("Item2", out _));
}
/// <summary>Verifies that set connection bindings command round trips through json.</summary>
[Fact]
public void SetConnectionBindingsCommand_RoundTripsThroughJson()
{
@@ -52,6 +54,7 @@ public class ConnectionBindingSerializationTests
Assert.Equal(original.Bindings, deserialized.Bindings);
}
/// <summary>Verifies that roundtrip preserves override when set.</summary>
[Fact]
public void Roundtrip_preserves_override_when_set()
{
@@ -65,6 +68,7 @@ public class ConnectionBindingSerializationTests
Assert.Equal("ns=2;s=Pump1.Speed", roundtripped!.DataSourceReferenceOverride);
}
/// <summary>Verifies that roundtrip defaults override to null when absent.</summary>
[Fact]
public void Roundtrip_defaults_override_to_null_when_absent()
{