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
@@ -23,6 +23,7 @@ public sealed class FocasReadWriteTests
// ---- Read ----
/// <summary>Verifies that an unknown reference maps to BadNodeIdUnknown.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Unknown_reference_maps_to_BadNodeIdUnknown()
{
@@ -34,6 +35,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that a successful PMC read returns a Good status value.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Successful_PMC_read_returns_Good_value()
{
@@ -48,6 +50,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that parameter reads route through the FocasAddress Parameter kind.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Parameter_read_routes_through_FocasAddress_Parameter_kind()
{
@@ -62,6 +65,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that macro reads route through the FocasAddress Macro kind.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Macro_read_routes_through_FocasAddress_Macro_kind()
{
@@ -75,6 +79,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that repeated reads reuse the connection.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Repeat_read_reuses_connection()
{
@@ -91,6 +96,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that FOCAS error statuses map correctly via the status mapper.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task FOCAS_error_status_maps_via_status_mapper()
{
@@ -109,6 +115,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that a read exception surfaces BadCommunicationError.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Read_exception_surfaces_BadCommunicationError()
{
@@ -123,6 +130,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that a connection failure disposes the client and surfaces BadCommunicationError.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Connect_failure_disposes_client_and_surfaces_BadCommunicationError()
{
@@ -137,6 +145,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that batched reads preserve order across different address areas.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Batched_reads_preserve_order_across_areas()
{
@@ -164,6 +173,7 @@ public sealed class FocasReadWriteTests
// ---- Write ----
/// <summary>Verifies that a non-writable tag write is rejected with BadNotWritable.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Non_writable_tag_rejected_with_BadNotWritable()
{
@@ -177,6 +187,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that a successful write logs the address, type, and value.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Successful_write_logs_address_type_value()
{
@@ -195,6 +206,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that write status codes map correctly via the FocasStatusMapper.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Write_status_code_maps_via_FocasStatusMapper()
{
@@ -214,6 +226,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that batched writes preserve order across different outcomes.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Batch_write_preserves_order_across_outcomes()
{
@@ -243,6 +256,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that cancellation signals are propagated.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Cancellation_propagates()
{
@@ -260,6 +274,7 @@ public sealed class FocasReadWriteTests
}
/// <summary>Verifies that ShutdownAsync disposes the client.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task ShutdownAsync_disposes_client()
{