docs: complete XML doc comments via fixdocs (2757 to 131 findings)

Add missing <returns>/<param>/<summary>/<typeparam> tags and clean up misused inheritdoc across 481 files so the documented API surface is complete. Documentation-only (zero code lines changed). The 131 remaining findings are inheritdoc-style warnings deliberately left to preserve hand-written implementation rationale (plan-decision notes, race-condition explanations).
2026-06-03 12:34:34 -04:00
parent c6d9b20d9f
commit bd6c0b4d3d
481 changed files with 2550 additions and 1668 deletions
@@ -15,6 +15,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 public sealed class DL205BcdQuirkTests(ModbusSimulatorFixture sim)
 {
    /// <summary>Verifies DL205 binary-coded-decimal register decodes as decimal value 1234.</summary>
+    /// <returns>A task that represents the asynchronous test.</returns>
    [Fact]
    public async Task DL205_BCD16_decodes_HR1072_as_decimal_1234()
    {
@@ -15,6 +15,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 public sealed class DL205CoilMappingTests(ModbusSimulatorFixture sim)
 {
    /// <summary>Verifies that DirectLOGIC Y0 output maps to Modbus coil 2048.</summary>
+    /// <returns>A task that represents the asynchronous test.</returns>
    [Fact]
    public async Task DL260_Y0_maps_to_coil_2048()
    {
@@ -42,6 +43,7 @@ public sealed class DL205CoilMappingTests(ModbusSimulatorFixture sim)
    }

    /// <summary>Verifies that DirectLOGIC C0 relay maps to Modbus coil 3072.</summary>
+    /// <returns>A task that represents the asynchronous test.</returns>
    [Fact]
    public async Task DL260_C0_maps_to_coil_3072()
    {
@@ -69,6 +71,7 @@ public sealed class DL205CoilMappingTests(ModbusSimulatorFixture sim)
    }

    /// <summary>Verifies that a scratch DirectLOGIC C relay supports write and read operations.</summary>
+    /// <returns>A task that represents the asynchronous test.</returns>
    [Fact]
    public async Task DL260_scratch_Crelay_supports_write_then_read()
    {
@@ -17,6 +17,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 public sealed class DL205ExceptionCodeTests(ModbusSimulatorFixture sim)
 {
    /// <summary>Verifies that DL205 FC03 reads at unmapped registers return BadOutOfRange status.</summary>
+    /// <returns>A task that represents the asynchronous test operation.</returns>
    [Fact]
    public async Task DL205_FC03_at_unmapped_register_returns_BadOutOfRange()
    {
@@ -17,6 +17,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 public sealed class DL205FloatCdabQuirkTests(ModbusSimulatorFixture sim)
 {
    /// <summary>Verifies that DL205 float32 CDAB word order correctly decodes 1.5f from HR1056.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [Fact]
    public async Task DL205_Float32_CDAB_decodes_1_5f_from_HR1056()
    {
@@ -26,6 +26,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 public sealed class DL205SmokeTests(ModbusSimulatorFixture sim)
 {
    /// <summary>Verifies that DL205 roundtrip write then read of holding register succeeds.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [Fact]
    public async Task DL205_roundtrip_write_then_read_of_holding_register()
    {
@@ -24,6 +24,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 public sealed class DL205StringQuirkTests(ModbusSimulatorFixture sim)
 {
    /// <summary>Verifies that DL205 low-byte-first string packing correctly decodes "Hello" from HR1040.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
    [Fact]
    public async Task DL205_string_low_byte_first_decodes_Hello_from_HR1040()
    {
@@ -17,6 +17,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests.DL205;
 public sealed class DL205VMemoryQuirkTests(ModbusSimulatorFixture sim)
 {
    /// <summary>Verifies that DL205 V2000 user memory octal address resolves to PDU address 0x0400.</summary>
+    /// <returns>A task that represents the asynchronous test operation.</returns>
    [Fact]
    public async Task DL205_V2000_user_memory_resolves_to_PDU_0x0400_marker()
    {
@@ -53,6 +54,7 @@ public sealed class DL205VMemoryQuirkTests(ModbusSimulatorFixture sim)
    }

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