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
@@ -49,11 +49,13 @@ public sealed class ModbusCoalescingAutoRecoveryTests
default: return Task.FromResult(new byte[] { pdu[0], 0, 0 });
}
}
/// <inheritdoc />
/// <summary>Releases resources used by this transport instance.</summary>
/// <returns>A completed value task.</returns>
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
}
/// <summary>Verifies that the first failure falls back to per-tag reads in the same scan.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task First_Failure_Falls_Back_To_PerTag_Same_Scan()
{
@@ -82,6 +84,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
}
/// <summary>Verifies that the second scan skips coalesced reads of prohibited ranges.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Second_Scan_Skips_Coalesced_Read_Of_Prohibited_Range()
{
@@ -112,6 +115,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
}
/// <summary>Verifies that reprobe clears prohibition when the range becomes healthy.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Reprobe_Clears_Prohibition_When_Range_Becomes_Healthy()
{
@@ -142,6 +146,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
}
/// <summary>Verifies that reprobe leaves prohibition in place when the range is still bad.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Reprobe_Leaves_Prohibition_When_Range_Is_Still_Bad()
{
@@ -166,6 +171,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
}
/// <summary>Verifies that GetAutoProhibitedRanges surfaces an operator-visible snapshot.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task GetAutoProhibitedRanges_Surfaces_Operator_Visible_Snapshot()
{
@@ -199,6 +205,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
}
/// <summary>Verifies that tags outside prohibited ranges still coalesce.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Tags_Outside_Prohibited_Range_Still_Coalesce()
{