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:
+15
-1
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
|
||||
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// M7-B4 (T15): <see cref="StubOpcUaClient"/> searches its canned address-space
|
||||
/// <see cref="StubOpcUaClient"/> searches its canned address-space
|
||||
/// tree (root → Folder1/Folder2; Folder1 → Tag1/Tag2) so DCL address-space
|
||||
/// search flows can be exercised without a live OPC UA server. The stub fakes
|
||||
/// BrowseNext continuation paging on <c>Folder1</c>, so finding both Tag1 and
|
||||
@@ -21,6 +21,8 @@ public class StubOpcUaClientSearchTests
|
||||
return client;
|
||||
}
|
||||
|
||||
/// <summary>Verifies that search tag finds both tags with root relative paths.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Search_Tag_FindsBothTags_WithRootRelativePaths()
|
||||
{
|
||||
@@ -36,6 +38,8 @@ public class StubOpcUaClientSearchTests
|
||||
Assert.All(result.Matches, m => Assert.Contains("Tag", m.Node.DisplayName));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that search folder matches on display name and path.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Search_Folder_MatchesOnDisplayNameAndPath()
|
||||
{
|
||||
@@ -51,6 +55,8 @@ public class StubOpcUaClientSearchTests
|
||||
Assert.Equal(new[] { "/Folder1", "/Folder1/Tag1", "/Folder1/Tag2", "/Folder2" }, paths);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that search folder 2 matches only the folder by display name.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Search_Folder2_MatchesOnlyTheFolderByDisplayName()
|
||||
{
|
||||
@@ -66,6 +72,8 @@ public class StubOpcUaClientSearchTests
|
||||
Assert.Equal("Folder2", only.Node.DisplayName);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that search is case insensitive.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Search_IsCaseInsensitive()
|
||||
{
|
||||
@@ -76,6 +84,8 @@ public class StubOpcUaClientSearchTests
|
||||
Assert.Equal(2, result.Matches.Count);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that search max results one stops early with cap reached.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Search_MaxResultsOne_StopsEarly_WithCapReached()
|
||||
{
|
||||
@@ -88,6 +98,8 @@ public class StubOpcUaClientSearchTests
|
||||
Assert.Contains("Tag", only.Node.DisplayName);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that search empty query returns no matches.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Search_EmptyQuery_ReturnsNoMatches()
|
||||
{
|
||||
@@ -99,6 +111,8 @@ public class StubOpcUaClientSearchTests
|
||||
Assert.False(result.CapReached);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that search whitespace query returns no matches.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Search_WhitespaceQuery_ReturnsNoMatches()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user