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,6 +4,7 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Tests;
public class DeploymentFetchTokenTests
{
/// <summary>Verifies that generate, returns url safe token of adequate length.</summary>
[Fact]
public void Generate_ReturnsUrlSafeTokenOfAdequateLength()
{
@@ -14,6 +15,7 @@ public class DeploymentFetchTokenTests
Assert.DoesNotContain('/', token);
}
/// <summary>Verifies that generate, two calls return different values.</summary>
[Fact]
public void Generate_TwoCallsReturnDifferentValues()
{
@@ -23,6 +25,7 @@ public class DeploymentFetchTokenTests
Assert.NotEqual(a, b);
}
/// <summary>Verifies that constant time equals, same token, returns true.</summary>
[Fact]
public void ConstantTimeEquals_SameToken_ReturnsTrue()
{
@@ -31,6 +34,7 @@ public class DeploymentFetchTokenTests
Assert.True(DeploymentFetchToken.ConstantTimeEquals(token, token));
}
/// <summary>Verifies that constant time equals, token with suffix, returns false.</summary>
[Fact]
public void ConstantTimeEquals_TokenWithSuffix_ReturnsFalse()
{
@@ -39,6 +43,7 @@ public class DeploymentFetchTokenTests
Assert.False(DeploymentFetchToken.ConstantTimeEquals(token, token + "x"));
}
/// <summary>Verifies that constant time equals, both empty, returns true.</summary>
[Fact]
public void ConstantTimeEquals_BothEmpty_ReturnsTrue()
{