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
@@ -28,6 +28,8 @@ namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// </remarks>
public class ServiceProviderValidationOptionsTests
{
/// <summary>Verifies that applying the options in development enables both scope and build validation.</summary>
/// <returns>The result.</returns>
[Fact]
public void Apply_InDevelopment_EnablesBothValidations()
{
@@ -39,6 +41,8 @@ public class ServiceProviderValidationOptionsTests
Assert.True(options.ValidateOnBuild);
}
/// <summary>Verifies that applying the options outside development turns both validations off.</summary>
/// <returns>The result.</returns>
[Fact]
public void Apply_OutsideDevelopment_LeavesBothValidationsOff()
{
@@ -65,6 +69,7 @@ public class CentralServiceProviderValidationTests : IDisposable
private readonly CentralDbTestEnvironment _dbEnv;
private WebApplicationFactory<Program>? _factory;
/// <summary>Initializes a new instance of the <c>CentralServiceProviderValidationTests</c> class.</summary>
public CentralServiceProviderValidationTests()
{
_previousEnv = Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");
@@ -72,6 +77,7 @@ public class CentralServiceProviderValidationTests : IDisposable
_dbEnv = new CentralDbTestEnvironment();
}
/// <summary>Releases the resources held by this instance.</summary>
public void Dispose()
{
try
@@ -169,6 +175,7 @@ public class SiteServiceProviderValidationTests : IDisposable
private readonly string _tempAuditDbPath;
private WebApplication? _host;
/// <summary>Initializes a new instance of the <c>SiteServiceProviderValidationTests</c> class.</summary>
public SiteServiceProviderValidationTests()
{
_tempDbPath = Path.Combine(Path.GetTempPath(), $"sb_scopeval_{Guid.NewGuid()}.db");
@@ -177,6 +184,7 @@ public class SiteServiceProviderValidationTests : IDisposable
_tempAuditDbPath = Path.Combine(Path.GetTempPath(), $"sb_scopeval_audit_{Guid.NewGuid()}.db");
}
/// <summary>Releases the resources held by this instance.</summary>
public void Dispose()
{
(_host as IDisposable)?.Dispose();
@@ -186,6 +194,8 @@ public class SiteServiceProviderValidationTests : IDisposable
}
}
/// <summary>Verifies that the site composition root builds with scope validation enabled.</summary>
/// <returns>The result.</returns>
[Fact]
public void Site_CompositionRoot_BuildsWithScopeValidationEnabled()
{