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
@@ -22,6 +22,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that an unknown reference maps to BadNodeIdUnknown status.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Unknown_reference_maps_to_BadNodeIdUnknown()
{
@@ -35,6 +36,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that a tag on an unknown device maps to BadNodeIdUnknown status.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Tag_on_unknown_device_maps_to_BadNodeIdUnknown()
{
@@ -52,6 +54,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that a successful DInt read returns Good status with the correct value.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Successful_DInt_read_returns_Good_with_value()
{
@@ -71,6 +74,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that repeated reads reuse the runtime without reinitializing.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Repeat_read_reuses_runtime_without_reinitialise()
{
@@ -88,6 +92,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that non-zero libplctag status is mapped via AbCipStatusMapper.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task NonZero_libplctag_status_maps_via_AbCipStatusMapper()
{
@@ -103,6 +108,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that an exception during read surfaces BadCommunicationError status.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Exception_during_read_surfaces_BadCommunicationError()
{
@@ -119,6 +125,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that batched reads preserve order and per-tag status.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Batched_reads_preserve_order_and_per_tag_status()
{
@@ -144,6 +151,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that a successful read marks health as Healthy.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Successful_read_marks_health_Healthy()
{
@@ -158,6 +166,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that tag creation parameters are built correctly from device and profile.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task TagCreateParams_are_built_from_device_and_profile()
{
@@ -176,6 +185,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that cancellation propagates from read operations.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Cancellation_propagates_from_read()
{
@@ -194,6 +204,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that ShutdownAsync disposes each tag runtime.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task ShutdownAsync_disposes_each_tag_runtime()
{
@@ -211,6 +222,7 @@ public sealed class AbCipDriverReadTests
}
/// <summary>Verifies that initialization failure disposes the tag and surfaces communication error.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Initialize_failure_disposes_tag_and_surfaces_communication_error()
{