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
@@ -10,6 +10,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.AbCip.Tests;
public sealed class AbCipHostProbeTests
{
/// <summary>Verifies that GetHostStatuses returns one entry per configured device.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task GetHostStatuses_returns_one_entry_per_device()
{
@@ -31,6 +32,7 @@ public sealed class AbCipHostProbeTests
}
/// <summary>Verifies that a successful probe read transitions the host state to Running.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Probe_with_successful_read_transitions_to_Running()
{
@@ -58,6 +60,7 @@ public sealed class AbCipHostProbeTests
}
/// <summary>Verifies that a failed probe read transitions the host state to Stopped.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Probe_with_read_failure_transitions_to_Stopped()
{
@@ -87,6 +90,7 @@ public sealed class AbCipHostProbeTests
}
/// <summary>Verifies that the probe is disabled when the Enabled option is false.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Probe_disabled_when_Enabled_is_false()
{
@@ -108,6 +112,7 @@ public sealed class AbCipHostProbeTests
}
/// <summary>Verifies that the probe is skipped when ProbeTagPath is null.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Probe_skipped_when_ProbeTagPath_is_null()
{
@@ -125,6 +130,7 @@ public sealed class AbCipHostProbeTests
}
/// <summary>Verifies that the probe loops across multiple devices independently.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Probe_loops_across_multiple_devices_independently()
{
@@ -162,6 +168,7 @@ public sealed class AbCipHostProbeTests
// ---- IPerCallHostResolver ----
/// <summary>Verifies that ResolveHost returns the declared device for a known tag.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ResolveHost_returns_declared_device_for_known_tag()
{
@@ -186,6 +193,7 @@ public sealed class AbCipHostProbeTests
}
/// <summary>Verifies that ResolveHost falls back to the first device for an unknown tag reference.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ResolveHost_falls_back_to_first_device_for_unknown_reference()
{
@@ -200,6 +208,7 @@ public sealed class AbCipHostProbeTests
}
/// <summary>Verifies that ResolveHost falls back to the driver instance ID when no devices are configured.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ResolveHost_falls_back_to_DriverInstanceId_when_no_devices()
{
@@ -210,6 +219,7 @@ public sealed class AbCipHostProbeTests
}
/// <summary>Verifies that ResolveHost for a UDT member walks to the synthesized definition.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ResolveHost_for_UDT_member_walks_to_synthesised_definition()
{