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
@@ -39,6 +39,7 @@ public class ClusterClientContractLockTests
// (a) Old-shape payloads: newer trailing optional fields absent → defaults.
// ---------------------------------------------------------------------
/// <summary>Verifies that an old-shape <c>CreateDataConnectionCommand</c> without the newer trailing fields still deserializes.</summary>
[Fact]
public void CreateDataConnectionCommand_OldShape_WithoutNewerTrailingFields_Deserializes()
{
@@ -62,6 +63,7 @@ public class ClusterClientContractLockTests
Assert.Equal(0, cmd.FailoverRetryCount); // value-type missing field → default(int), not 3
}
/// <summary>Verifies that an old-shape <c>DeployInstanceCommand</c> without the fetch fields still deserializes.</summary>
[Fact]
public void DeployInstanceCommand_OldShape_WithoutFetchFields_Deserializes()
{
@@ -78,6 +80,7 @@ public class ClusterClientContractLockTests
Assert.Null(cmd.FetchToken); // default applied
}
/// <summary>Verifies that an old-shape <c>NotificationSubmit</c> without the execution correlation fields still deserializes.</summary>
[Fact]
public void NotificationSubmit_OldShape_WithoutExecutionCorrelationFields_Deserializes()
{
@@ -99,6 +102,7 @@ public class ClusterClientContractLockTests
// (b) Unknown fields from a newer peer are ignored (never throw).
// ---------------------------------------------------------------------
/// <summary>Verifies that an unknown field from a newer peer is ignored when deserializing <c>AttributeValueChanged</c>.</summary>
[Fact]
public void AttributeValueChanged_UnknownFieldFromNewerPeer_IsIgnored()
{
@@ -112,6 +116,7 @@ public class ClusterClientContractLockTests
Assert.Equal("Good", evt.Quality);
}
/// <summary>Verifies that an unknown field from a newer peer is ignored when deserializing <c>GetAttributeRequest</c>.</summary>
[Fact]
public void GetAttributeRequest_UnknownFieldFromNewerPeer_IsIgnored()
{
@@ -125,6 +130,7 @@ public class ClusterClientContractLockTests
Assert.Equal("a", req.AttributeName);
}
/// <summary>Verifies that an unknown field from a newer peer is ignored when deserializing <c>SetStaticAttributeCommand</c>.</summary>
[Fact]
public void SetStaticAttributeCommand_UnknownFieldFromNewerPeer_IsIgnored()
{
@@ -142,6 +148,7 @@ public class ClusterClientContractLockTests
// (c) Round-trip preserves values.
// ---------------------------------------------------------------------
/// <summary>Verifies that a <c>ManagementEnvelope</c> round trip preserves the correlation id and user.</summary>
[Fact]
public void ManagementEnvelope_RoundTrip_PreservesCorrelationIdAndUser()
{
@@ -159,6 +166,7 @@ public class ClusterClientContractLockTests
Assert.Equal(new[] { "site-1", "site-2" }, round.User.PermittedSiteIds);
}
/// <summary>Verifies that an <c>AttributeValueChanged</c> round trip preserves its values.</summary>
[Fact]
public void AttributeValueChanged_RoundTrip_PreservesValues()
{
@@ -175,6 +183,7 @@ public class ClusterClientContractLockTests
Assert.Equal(evt.Timestamp, round.Timestamp);
}
/// <summary>Verifies that a <c>CreateDataConnectionCommand</c> round trip preserves its values.</summary>
[Fact]
public void CreateDataConnectionCommand_RoundTrip_PreservesValues()
{