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
@@ -13,6 +13,7 @@ public sealed class DriverResiliencePipelineBuilderTests
private static readonly DriverResilienceOptions TierAOptions = new() { Tier = DriverTier.A };
/// <summary>Verifies that read operations retry transient failures.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Read_Retries_Transient_Failures()
{
@@ -31,6 +32,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}
/// <summary>Verifies that write operations do not retry on failure.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Write_DoesNotRetry_OnFailure()
{
@@ -53,6 +55,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}
/// <summary>Verifies that alarm acknowledge operations do not retry on failure.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task AlarmAcknowledge_DoesNotRetry_OnFailure()
{
@@ -115,6 +118,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}
/// <summary>Verifies that a dead host does not open the breaker for a sibling host.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task DeadHost_DoesNotOpenBreaker_ForSiblingHost()
{
@@ -146,6 +150,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}
/// <summary>Verifies that the circuit breaker opens after the failure threshold on tier A.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task CircuitBreaker_Opens_AfterFailureThreshold_OnTierA()
{
@@ -171,6 +176,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}
/// <summary>Verifies that timeout cancels slow operations.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Timeout_Cancels_SlowOperation()
{
@@ -211,6 +217,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}
/// <summary>Verifies that cancellation is not retried.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Cancellation_IsNot_Retried()
{
@@ -232,6 +239,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}
/// <summary>Verifies that the tracker records failure on every retry.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Tracker_RecordsFailure_OnEveryRetry()
{
@@ -253,6 +261,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}
/// <summary>Verifies that the tracker stamps the breaker open when it trips.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Tracker_StampsBreakerOpen_WhenBreakerTrips()
{
@@ -277,6 +286,7 @@ public sealed class DriverResiliencePipelineBuilderTests
}
/// <summary>Verifies that the tracker isolates counters per host.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Tracker_IsolatesCounters_PerHost()
{