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
@@ -12,6 +12,7 @@ public class ReadWriteViewModelTests
private readonly FakeOpcUaClientService _service;
private readonly ReadWriteViewModel _vm;
/// <summary>Initializes a new instance of the ReadWriteViewModelTests class.</summary>
public ReadWriteViewModelTests()
{
_service = new FakeOpcUaClientService
@@ -22,6 +23,7 @@ public class ReadWriteViewModelTests
_vm = new ReadWriteViewModel(_service, dispatcher);
}
/// <summary>Verifies that the read command cannot execute when disconnected.</summary>
[Fact]
public void ReadCommand_CannotExecute_WhenDisconnected()
{
@@ -30,6 +32,7 @@ public class ReadWriteViewModelTests
_vm.ReadCommand.CanExecute(null).ShouldBeFalse();
}
/// <summary>Verifies that the read command cannot execute when no node is selected.</summary>
[Fact]
public void ReadCommand_CannotExecute_WhenNoNodeSelected()
{
@@ -38,6 +41,7 @@ public class ReadWriteViewModelTests
_vm.ReadCommand.CanExecute(null).ShouldBeFalse();
}
/// <summary>Verifies that the read command can execute when connected and a node is selected.</summary>
[Fact]
public void ReadCommand_CanExecute_WhenConnectedAndNodeSelected()
{
@@ -46,6 +50,7 @@ public class ReadWriteViewModelTests
_vm.ReadCommand.CanExecute(null).ShouldBeTrue();
}
/// <summary>Verifies that the read command updates value and status.</summary>
[Fact]
public async Task ReadCommand_UpdatesValueAndStatus()
{
@@ -63,6 +68,7 @@ public class ReadWriteViewModelTests
(_service.ReadCallCount - countBefore).ShouldBe(1);
}
/// <summary>Verifies that auto-read fires on selection change when connected.</summary>
[Fact]
public void AutoRead_OnSelectionChange_WhenConnected()
{
@@ -74,6 +80,7 @@ public class ReadWriteViewModelTests
_service.ReadCallCount.ShouldBeGreaterThanOrEqualTo(1);
}
/// <summary>Verifies that null selection does not call the service.</summary>
[Fact]
public void NullSelection_DoesNotCallService()
{
@@ -83,6 +90,7 @@ public class ReadWriteViewModelTests
_service.ReadCallCount.ShouldBe(0);
}
/// <summary>Verifies that the write command updates write status.</summary>
[Fact]
public async Task WriteCommand_UpdatesWriteStatus()
{
@@ -100,6 +108,7 @@ public class ReadWriteViewModelTests
_service.LastWriteValue.ShouldBe("NewValue");
}
/// <summary>Verifies that the write command cannot execute when disconnected.</summary>
[Fact]
public void WriteCommand_CannotExecute_WhenDisconnected()
{
@@ -108,6 +117,7 @@ public class ReadWriteViewModelTests
_vm.WriteCommand.CanExecute(null).ShouldBeFalse();
}
/// <summary>Verifies that read command error sets error status.</summary>
[Fact]
public async Task ReadCommand_Error_SetsErrorStatus()
{
@@ -121,6 +131,7 @@ public class ReadWriteViewModelTests
_vm.CurrentStatus.ShouldContain("Error");
}
/// <summary>Verifies that clear resets all properties.</summary>
[Fact]
public void Clear_ResetsAllProperties()
{
@@ -140,6 +151,7 @@ public class ReadWriteViewModelTests
_vm.WriteStatus.ShouldBeNull();
}
/// <summary>Verifies that IsNodeSelected tracks the selected node ID.</summary>
[Fact]
public void IsNodeSelected_TracksSelectedNodeId()
{