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
@@ -10,6 +10,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests;
[Trait("Category", "Unit")]
public sealed class ModbusByteOrderTests
{
/// <summary>Verifies that Int32 values decode correctly with ByteSwap (BADC) byte order.</summary>
[Fact]
public void Int32_ByteSwap_decodes_BADC_layout()
{
@@ -21,6 +22,7 @@ public sealed class ModbusByteOrderTests
ModbusDriver.DecodeRegister(bytes, tag).ShouldBe(0x12345678);
}
/// <summary>Verifies that Int32 values decode correctly with FullReverse (DCBA) byte order.</summary>
[Fact]
public void Int32_FullReverse_decodes_DCBA_layout()
{
@@ -32,6 +34,8 @@ public sealed class ModbusByteOrderTests
ModbusDriver.DecodeRegister(bytes, tag).ShouldBe(0x12345678);
}
/// <summary>Verifies that Float32 values roundtrip correctly with all byte orders.</summary>
/// <param name="order">The byte order to test.</param>
[Theory]
[InlineData(ModbusByteOrder.BigEndian)]
[InlineData(ModbusByteOrder.WordSwap)]
@@ -45,6 +49,8 @@ public sealed class ModbusByteOrderTests
ModbusDriver.DecodeRegister(wire, tag).ShouldBe(3.14159f);
}
/// <summary>Verifies that Float64 values roundtrip correctly with all byte orders.</summary>
/// <param name="order">The byte order to test.</param>
[Theory]
[InlineData(ModbusByteOrder.BigEndian)]
[InlineData(ModbusByteOrder.WordSwap)]
@@ -58,6 +64,8 @@ public sealed class ModbusByteOrderTests
ModbusDriver.DecodeRegister(wire, tag).ShouldBe(2.718281828459045d);
}
/// <summary>Verifies that Int32 values roundtrip correctly with all byte orders.</summary>
/// <param name="order">The byte order to test.</param>
[Theory]
[InlineData(ModbusByteOrder.BigEndian)]
[InlineData(ModbusByteOrder.WordSwap)]