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
@@ -5,7 +5,7 @@ using Microsoft.Extensions.Options;
namespace ZB.MOM.WW.ScadaBridge.SiteEventLogging.Tests;
/// <summary>
/// Regression tests for SiteEventLogging-006: the schema must index the columns the
/// Regression tests: the schema must index the columns the
/// query service filters on so common queries do not full-scan a 1 GB database.
/// </summary>
public class SchemaIndexTests : IDisposable
@@ -15,6 +15,7 @@ public class SchemaIndexTests : IDisposable
private readonly string _dbPath;
private readonly TestLocalDb _localDb;
/// <summary>Initializes a new instance of the <c>SchemaIndexTests</c> class.</summary>
public SchemaIndexTests()
{
_dbPath = Path.Combine(Path.GetTempPath(), $"test_index_{Guid.NewGuid()}.db");
@@ -26,6 +27,7 @@ public class SchemaIndexTests : IDisposable
_verifyConnection.Open();
}
/// <summary>Releases the resources used by this instance.</summary>
public void Dispose()
{
_verifyConnection.Dispose();
@@ -34,6 +36,7 @@ public class SchemaIndexTests : IDisposable
TestLocalDb.DeleteFiles(_dbPath);
}
/// <summary>Verifies that schema: has index on severity.</summary>
[Fact]
public void Schema_HasIndexOnSeverity()
{
@@ -47,6 +50,8 @@ public class SchemaIndexTests : IDisposable
Assert.Contains("idx_events_severity", indexes);
}
/// <summary>Verifies that severity filtered query, when uses index, not full scan.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SeverityFilteredQuery_UsesIndex_NotFullScan()
{