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,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests;
/// <summary>
/// M7-B2 (T15): <see cref="StubOpcUaClient"/> serves a small canned address-space
/// Verifies that <see cref="StubOpcUaClient"/> serves a small canned address-space
/// tree so DCL browse/paging flows can be exercised without a live OPC UA server.
/// The stub also fakes BrowseNext continuation paging on <c>Folder1</c> so the
/// continuation-token round-trip is testable end-to-end against the contract.
@@ -21,6 +21,8 @@ public class StubOpcUaClientBrowseTests
return client;
}
/// <summary>Verifies that browsing the root returns two folders with no continuation token.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BrowseRoot_ReturnsTwoFolders_NoContinuation()
{
@@ -46,6 +48,8 @@ public class StubOpcUaClientBrowseTests
});
}
/// <summary>Verifies that browsing Folder1 without a token returns the first tag and a continuation token.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BrowseFolder1_NoToken_ReturnsTag1_AndContinuationToken()
{
@@ -61,6 +65,8 @@ public class StubOpcUaClientBrowseTests
Assert.False(only.HasChildren);
}
/// <summary>Verifies that browsing Folder1 with the continuation token returns the second tag and no further continuation.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BrowseFolder1_WithContinuationToken_ReturnsTag2_AndNoFurtherContinuation()
{
@@ -78,6 +84,8 @@ public class StubOpcUaClientBrowseTests
Assert.False(only.HasChildren);
}
/// <summary>Verifies that browsing a leaf node returns no children and no continuation token.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BrowseLeaf_ReturnsEmpty_NoContinuation()
{