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).
This commit is contained in:
Joseph Doherty
2026-06-03 12:34:34 -04:00
parent c6d9b20d9f
commit bd6c0b4d3d
481 changed files with 2550 additions and 1668 deletions
@@ -64,6 +64,7 @@ public sealed class ExceptionInjectionTests(ModbusSimulatorFixture sim)
/// <param name="address">The Modbus register address to read.</param>
/// <param name="expectedStatus">The expected OPC UA status code.</param>
/// <param name="scenario">Scenario description for assertion messages.</param>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Theory]
[InlineData(1000, StatusBadNotSupported, "exc 0x01 (Illegal Function) -> BadNotSupported")]
[InlineData(1001, StatusBadOutOfRange, "exc 0x02 (Illegal Data Address) -> BadOutOfRange")]
@@ -82,6 +83,7 @@ public sealed class ExceptionInjectionTests(ModbusSimulatorFixture sim)
}
/// <summary>Verifies that reads at non-injected addresses return Good status.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task FC03_read_at_non_injected_address_returns_Good()
{
@@ -98,6 +100,7 @@ public sealed class ExceptionInjectionTests(ModbusSimulatorFixture sim)
/// <param name="address">The Modbus register address to write.</param>
/// <param name="expectedStatus">The expected OPC UA status code.</param>
/// <param name="scenario">Scenario description for assertion messages.</param>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Theory]
[InlineData(2000, StatusBadDeviceFailure, "exc 0x04 on FC06 -> BadDeviceFailure (CPU in PROGRAM mode)")]
[InlineData(2001, StatusBadDeviceFailure, "exc 0x06 on FC06 -> BadDeviceFailure (Server Busy)")]