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
@@ -14,6 +14,7 @@ public class SubscriptionsViewModelTests
private readonly FakeOpcUaClientService _service;
private readonly SubscriptionsViewModel _vm;
/// <summary>Initializes test instance with fake services.</summary>
public SubscriptionsViewModelTests()
{
_service = new FakeOpcUaClientService();
@@ -21,6 +22,7 @@ public class SubscriptionsViewModelTests
_vm = new SubscriptionsViewModel(_service, dispatcher);
}
/// <summary>Verifies that AddSubscriptionCommand cannot execute when disconnected.</summary>
[Fact]
public void AddSubscriptionCommand_CannotExecute_WhenDisconnected()
{
@@ -29,6 +31,7 @@ public class SubscriptionsViewModelTests
_vm.AddSubscriptionCommand.CanExecute(null).ShouldBeFalse();
}
/// <summary>Verifies that AddSubscriptionCommand cannot execute without a node ID.</summary>
[Fact]
public void AddSubscriptionCommand_CannotExecute_WhenNoNodeId()
{
@@ -37,6 +40,7 @@ public class SubscriptionsViewModelTests
_vm.AddSubscriptionCommand.CanExecute(null).ShouldBeFalse();
}
/// <summary>Verifies that AddSubscriptionCommand adds a new subscription to the active list.</summary>
[Fact]
public async Task AddSubscriptionCommand_AddsItem()
{
@@ -53,6 +57,7 @@ public class SubscriptionsViewModelTests
_service.SubscribeCallCount.ShouldBe(1);
}
/// <summary>Verifies that RemoveSubscriptionCommand removes selected subscription.</summary>
[Fact]
public async Task RemoveSubscriptionCommand_RemovesItem()
{
@@ -68,6 +73,7 @@ public class SubscriptionsViewModelTests
_service.UnsubscribeCallCount.ShouldBe(1);
}
/// <summary>Verifies that RemoveSubscriptionCommand cannot execute without selection.</summary>
[Fact]
public void RemoveSubscriptionCommand_CannotExecute_WhenNoSelection()
{
@@ -76,6 +82,7 @@ public class SubscriptionsViewModelTests
_vm.RemoveSubscriptionCommand.CanExecute(null).ShouldBeFalse();
}
/// <summary>Verifies that DataChanged event updates the matching subscription row.</summary>
[Fact]
public async Task DataChanged_UpdatesMatchingRow()
{
@@ -90,6 +97,7 @@ public class SubscriptionsViewModelTests
_vm.ActiveSubscriptions[0].Status.ShouldNotBeNull();
}
/// <summary>Verifies that DataChanged event does not update non-matching subscription rows.</summary>
[Fact]
public async Task DataChanged_DoesNotUpdateNonMatchingRow()
{
@@ -103,6 +111,7 @@ public class SubscriptionsViewModelTests
_vm.ActiveSubscriptions[0].Value.ShouldBeNull();
}
/// <summary>Verifies that Clear removes all subscriptions.</summary>
[Fact]
public void Clear_RemovesAllSubscriptions()
{
@@ -115,6 +124,7 @@ public class SubscriptionsViewModelTests
_vm.SubscriptionCount.ShouldBe(0);
}
/// <summary>Verifies that Teardown unregisters the event handler.</summary>
[Fact]
public void Teardown_UnhooksEventHandler()
{
@@ -128,12 +138,14 @@ public class SubscriptionsViewModelTests
_vm.ActiveSubscriptions[0].Value.ShouldBeNull();
}
/// <summary>Verifies that default interval is 1000 milliseconds.</summary>
[Fact]
public void DefaultInterval_Is1000()
{
_vm.NewInterval.ShouldBe(1000);
}
/// <summary>Verifies that AddSubscriptionForNodeAsync adds a subscription.</summary>
[Fact]
public async Task AddSubscriptionForNodeAsync_AddsSubscription()
{
@@ -147,6 +159,7 @@ public class SubscriptionsViewModelTests
_service.SubscribeCallCount.ShouldBe(1);
}
/// <summary>Verifies that AddSubscriptionForNodeAsync skips duplicate subscriptions.</summary>
[Fact]
public async Task AddSubscriptionForNodeAsync_SkipsDuplicate()
{
@@ -159,6 +172,7 @@ public class SubscriptionsViewModelTests
_service.SubscribeCallCount.ShouldBe(1);
}
/// <summary>Verifies that AddSubscriptionForNodeAsync does nothing when disconnected.</summary>
[Fact]
public async Task AddSubscriptionForNodeAsync_DoesNothing_WhenDisconnected()
{
@@ -170,6 +184,7 @@ public class SubscriptionsViewModelTests
_service.SubscribeCallCount.ShouldBe(0);
}
/// <summary>Verifies that GetSubscribedNodeIds returns all active subscription node IDs.</summary>
[Fact]
public async Task GetSubscribedNodeIds_ReturnsActiveNodeIds()
{
@@ -184,6 +199,7 @@ public class SubscriptionsViewModelTests
ids.ShouldContain("ns=2;s=Node2");
}
/// <summary>Verifies that RestoreSubscriptionsAsync subscribes to all provided node IDs.</summary>
[Fact]
public async Task RestoreSubscriptionsAsync_SubscribesAllNodes()
{
@@ -195,6 +211,7 @@ public class SubscriptionsViewModelTests
_service.SubscribeCallCount.ShouldBe(2);
}
/// <summary>Verifies that ValidateAndWriteAsync returns true on successful write.</summary>
[Fact]
public async Task ValidateAndWriteAsync_SuccessReturnsTrue()
{
@@ -209,6 +226,7 @@ public class SubscriptionsViewModelTests
_service.WriteCallCount.ShouldBe(1);
}
/// <summary>Verifies that ValidateAndWriteAsync returns false when value parsing fails.</summary>
[Fact]
public async Task ValidateAndWriteAsync_ParseFailureReturnsFalse()
{
@@ -223,6 +241,7 @@ public class SubscriptionsViewModelTests
_service.WriteCallCount.ShouldBe(0);
}
/// <summary>Verifies that ValidateAndWriteAsync returns false when write fails.</summary>
[Fact]
public async Task ValidateAndWriteAsync_WriteFailureReturnsFalse()
{
@@ -236,6 +255,7 @@ public class SubscriptionsViewModelTests
message.ShouldContain("Access denied");
}
/// <summary>Verifies that ValidateAndWriteAsync returns false when status is bad.</summary>
[Fact]
public async Task ValidateAndWriteAsync_BadStatusReturnsFalse()
{
@@ -249,6 +269,7 @@ public class SubscriptionsViewModelTests
message.ShouldContain("Write failed");
}
/// <summary>Verifies that AddSubscriptionRecursiveAsync subscribes a variable directly.</summary>
[Fact]
public async Task AddSubscriptionRecursiveAsync_SubscribesVariableDirectly()
{
@@ -260,6 +281,7 @@ public class SubscriptionsViewModelTests
_vm.ActiveSubscriptions[0].NodeId.ShouldBe("ns=2;s=Var1");
}
/// <summary>Verifies that AddSubscriptionRecursiveAsync browses objects and subscribes variable children.</summary>
[Fact]
public async Task AddSubscriptionRecursiveAsync_BrowsesObjectAndSubscribesVariableChildren()
{
@@ -311,6 +333,7 @@ public class SubscriptionsViewModelTests
_vm.StatusMessage.ShouldContain("Bad node id");
}
/// <summary>Verifies that AddSubscriptionRecursiveAsync recurses through nested objects.</summary>
[Fact]
public async Task AddSubscriptionRecursiveAsync_RecursesNestedObjects()
{