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
@@ -17,6 +17,7 @@ public class DataConnectionFormTests : BunitContext
{
private readonly ISiteRepository _siteRepo = Substitute.For<ISiteRepository>();
/// <summary>Initializes the test context and registers the substitute services the form requires.</summary>
public DataConnectionFormTests()
{
Services.AddSingleton(_siteRepo);
@@ -51,6 +52,7 @@ public class DataConnectionFormTests : BunitContext
return Render<DataConnectionForm>();
}
/// <summary>Verifies that the protocol dropdown is rendered on create and offers both protocols.</summary>
[Fact]
public void ProtocolDropdown_IsRendered_OnCreate_WithBothProtocols()
{
@@ -64,6 +66,8 @@ public class DataConnectionFormTests : BunitContext
Assert.Contains("MxGateway", optionTexts);
}
/// <summary>Verifies that saving an MxGateway connection persists typed JSON with the MxGateway protocol.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Save_MxGateway_PersistsTypedJsonAndProtocolMxGateway()
{
@@ -103,6 +107,8 @@ public class DataConnectionFormTests : BunitContext
doc.RootElement.GetProperty("endpoint").GetString());
}
/// <summary>Verifies that saving an invalid primary URL does not call the repository.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Save_InvalidPrimaryUrl_DoesNotCallRepo()
{
@@ -126,6 +132,8 @@ public class DataConnectionFormTests : BunitContext
Assert.Contains("Endpoint URL must be a valid", cut.Markup);
}
/// <summary>Verifies that saving a valid configuration persists typed JSON with the OPC UA protocol.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Save_ValidConfig_PersistsTypedJsonAndProtocolOpcUa()
{