docs: backfill XML documentation across 756 files

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.
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 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 [Trait("Device", "DL205")]
 public sealed class DL205BcdQuirkTests(ModbusSimulatorFixture sim)
 {
+    /// <summary>Verifies DL205 binary-coded-decimal register decodes as decimal value 1234.</summary>
    [Fact]
    public async Task DL205_BCD16_decodes_HR1072_as_decimal_1234()
    {
@@ -14,6 +14,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 [Trait("Device", "DL205")]
 public sealed class DL205CoilMappingTests(ModbusSimulatorFixture sim)
 {
+    /// <summary>Verifies that DirectLOGIC Y0 output maps to Modbus coil 2048.</summary>
    [Fact]
    public async Task DL260_Y0_maps_to_coil_2048()
    {
@@ -40,6 +41,7 @@ public sealed class DL205CoilMappingTests(ModbusSimulatorFixture sim)
        results[0].Value.ShouldBe(true, "dl205.json seeds coil 2048 (Y0) = ON");
    }

+    /// <summary>Verifies that DirectLOGIC C0 relay maps to Modbus coil 3072.</summary>
    [Fact]
    public async Task DL260_C0_maps_to_coil_3072()
    {
@@ -66,6 +68,7 @@ public sealed class DL205CoilMappingTests(ModbusSimulatorFixture sim)
        results[0].Value.ShouldBe(true, "dl205.json seeds coil 3072 (C0) = ON");
    }

+    /// <summary>Verifies that a scratch DirectLOGIC C relay supports write and read operations.</summary>
    [Fact]
    public async Task DL260_scratch_Crelay_supports_write_then_read()
    {
@@ -16,6 +16,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 [Trait("Device", "DL205")]
 public sealed class DL205ExceptionCodeTests(ModbusSimulatorFixture sim)
 {
+    /// <summary>Verifies that DL205 FC03 reads at unmapped registers return BadOutOfRange status.</summary>
    [Fact]
    public async Task DL205_FC03_at_unmapped_register_returns_BadOutOfRange()
    {
@@ -16,6 +16,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 [Trait("Device", "DL205")]
 public sealed class DL205FloatCdabQuirkTests(ModbusSimulatorFixture sim)
 {
+    /// <summary>Verifies that DL205 float32 CDAB word order correctly decodes 1.5f from HR1056.</summary>
    [Fact]
    public async Task DL205_Float32_CDAB_decodes_1_5f_from_HR1056()
    {
@@ -27,6 +27,10 @@ public static class DL205Profile
    /// <summary>Value the smoke test writes then reads back to assert round-trip integrity.</summary>
    public const short SmokeHoldingValue = 1234;

+    /// <summary>Builds Modbus driver options for the DL205 test profile.</summary>
+    /// <param name="host">The host or IP address of the Modbus device.</param>
+    /// <param name="port">The port number of the Modbus device.</param>
+    /// <returns>Configured Modbus driver options for DL205.</returns>
    public static ModbusDriverOptions BuildOptions(string host, int port) => new()
    {
        Host = host,
@@ -25,6 +25,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 [Trait("Device", "DL205")]
 public sealed class DL205SmokeTests(ModbusSimulatorFixture sim)
 {
+    /// <summary>Verifies that DL205 roundtrip write then read of holding register succeeds.</summary>
    [Fact]
    public async Task DL205_roundtrip_write_then_read_of_holding_register()
    {
@@ -23,6 +23,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 [Trait("Device", "DL205")]
 public sealed class DL205StringQuirkTests(ModbusSimulatorFixture sim)
 {
+    /// <summary>Verifies that DL205 low-byte-first string packing correctly decodes "Hello" from HR1040.</summary>
    [Fact]
    public async Task DL205_string_low_byte_first_decodes_Hello_from_HR1040()
    {
@@ -16,6 +16,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 [Trait("Device", "DL205")]
 public sealed class DL205VMemoryQuirkTests(ModbusSimulatorFixture sim)
 {
+    /// <summary>Verifies that DL205 V2000 user memory octal address resolves to PDU address 0x0400.</summary>
    [Fact]
    public async Task DL205_V2000_user_memory_resolves_to_PDU_0x0400_marker()
    {
@@ -51,6 +52,7 @@ public sealed class DL205VMemoryQuirkTests(ModbusSimulatorFixture sim)
        results[0].Value.ShouldBe((ushort)0x2000, "dl205.json seeds HR[0x0400] with marker 0x2000 (= V2000 value)");
    }

+    /// <summary>Verifies that DL205 V40400 system memory address resolves to PDU address 0x2100.</summary>
    [Fact]
    public async Task DL205_V40400_system_memory_resolves_to_PDU_0x2100_marker()
    {
@@ -21,6 +21,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 [Trait("Device", "DL205")]
 public sealed class DL205XInputTests(ModbusSimulatorFixture sim)
 {
+    /// <summary>Verifies that DL260 X20 octal maps to discrete input 16 and reads the ON state.</summary>
    [Fact]
    public async Task DL260_X20_octal_maps_to_DiscreteInput_16_and_reads_ON()
    {