docs: backfill XML documentation across 756 files
v2-ci / build (push) Failing after 1m43s
v2-ci / unit-tests (tests/Core/ZB.MOM.WW.OtOpcUa.Cluster.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.ControlPlane.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Runtime.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Security.Tests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Has been skipped

Adds <summary>, <param>, <typeparam>, and <inheritdoc/> tags to public
members surfaced by commentchecker — resolves 5,847 of 5,869 issues
(99.6%) across three /fixdocs passes.
This commit is contained in:
Joseph Doherty
2026-05-28 08:10:17 -04:00
parent f9fc7dd2e1
commit 64e3fbe035
756 changed files with 9876 additions and 96 deletions
@@ -7,12 +7,14 @@ using BrowseResult = ZB.MOM.WW.OtOpcUa.Client.Shared.Models.BrowseResult;
namespace ZB.MOM.WW.OtOpcUa.Client.UI.Tests;
/// <summary>Tests for the BrowseTreeViewModel class.</summary>
public class BrowseTreeViewModelTests
{
private readonly SynchronousUiDispatcher _dispatcher;
private readonly FakeOpcUaClientService _service;
private readonly BrowseTreeViewModel _vm;
/// <summary>Initializes a new instance of the BrowseTreeViewModelTests class.</summary>
public BrowseTreeViewModelTests()
{
_service = new FakeOpcUaClientService
@@ -27,6 +29,7 @@ public class BrowseTreeViewModelTests
_vm = new BrowseTreeViewModel(_service, _dispatcher);
}
/// <summary>Verifies that LoadRootsAsync populates root nodes.</summary>
[Fact]
public async Task LoadRootsAsync_PopulatesRootNodes()
{
@@ -37,6 +40,7 @@ public class BrowseTreeViewModelTests
_vm.RootNodes[1].DisplayName.ShouldBe("Node2");
}
/// <summary>Verifies that LoadRootsAsync browses with null parent.</summary>
[Fact]
public async Task LoadRootsAsync_BrowsesWithNullParent()
{
@@ -46,6 +50,7 @@ public class BrowseTreeViewModelTests
_service.LastBrowseParentNodeId.ShouldBeNull();
}
/// <summary>Verifies that Clear removes all root nodes.</summary>
[Fact]
public void Clear_RemovesAllRootNodes()
{
@@ -55,6 +60,7 @@ public class BrowseTreeViewModelTests
_vm.RootNodes.ShouldBeEmpty();
}
/// <summary>Verifies that nodes with children have a placeholder.</summary>
[Fact]
public async Task LoadRootsAsync_NodeWithChildren_HasPlaceholder()
{
@@ -66,6 +72,7 @@ public class BrowseTreeViewModelTests
nodeWithChildren.Children[0].IsPlaceholder.ShouldBeTrue();
}
/// <summary>Verifies that nodes without children have no placeholder.</summary>
[Fact]
public async Task LoadRootsAsync_NodeWithoutChildren_HasNoPlaceholder()
{
@@ -76,6 +83,7 @@ public class BrowseTreeViewModelTests
leafNode.Children.ShouldBeEmpty();
}
/// <summary>Verifies that first tree node expand triggers child browse.</summary>
[Fact]
public async Task TreeNode_FirstExpand_TriggersChildBrowse()
{
@@ -105,6 +113,7 @@ public class BrowseTreeViewModelTests
parent.Children[0].DisplayName.ShouldBe("Child1");
}
/// <summary>Verifies that second tree node expand does not browse again.</summary>
[Fact]
public async Task TreeNode_SecondExpand_DoesNotBrowseAgain()
{
@@ -133,6 +142,7 @@ public class BrowseTreeViewModelTests
_service.BrowseCallCount.ShouldBe(browseCountAfterFirst);
}
/// <summary>Verifies that IsLoading transitions during browse.</summary>
[Fact]
public async Task TreeNode_IsLoading_TransitionsDuringBrowse()
{