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
@@ -12,6 +12,7 @@ public sealed class TwinCATCapabilityTests
// ---- ITagDiscovery ----
/// <summary>Verifies that DiscoverAsync emits pre-declared tags.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DiscoverAsync_emits_pre_declared_tags()
{
@@ -39,6 +40,7 @@ public sealed class TwinCATCapabilityTests
// ---- ISubscribable ----
/// <summary>Verifies that Subscribe initial poll raises OnDataChange.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Subscribe_initial_poll_raises_OnDataChange()
{
@@ -66,6 +68,7 @@ public sealed class TwinCATCapabilityTests
}
/// <summary>Verifies that ShutdownAsync cancels active subscriptions.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ShutdownAsync_cancels_active_subscriptions()
{
@@ -97,6 +100,7 @@ public sealed class TwinCATCapabilityTests
// ---- IHostConnectivityProbe ----
/// <summary>Verifies that GetHostStatuses returns entry per device.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task GetHostStatuses_returns_entry_per_device()
{
@@ -115,6 +119,7 @@ public sealed class TwinCATCapabilityTests
}
/// <summary>Verifies that Probe transitions to Running on successful probe.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Probe_transitions_to_Running_on_successful_probe()
{
@@ -142,6 +147,7 @@ public sealed class TwinCATCapabilityTests
}
/// <summary>Verifies that Probe transitions to Stopped on probe failure.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Probe_transitions_to_Stopped_on_probe_failure()
{
@@ -169,6 +175,7 @@ public sealed class TwinCATCapabilityTests
}
/// <summary>Verifies that Probe is disabled when Enabled is false.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Probe_disabled_when_Enabled_is_false()
{
@@ -188,6 +195,7 @@ public sealed class TwinCATCapabilityTests
// ---- IPerCallHostResolver ----
/// <summary>Verifies that ResolveHost returns declared device for known tag.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ResolveHost_returns_declared_device_for_known_tag()
{
@@ -212,6 +220,7 @@ public sealed class TwinCATCapabilityTests
}
/// <summary>Verifies that ResolveHost falls back to first device for unknown reference.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ResolveHost_falls_back_to_first_device_for_unknown_ref()
{
@@ -226,6 +235,7 @@ public sealed class TwinCATCapabilityTests
}
/// <summary>Verifies that ResolveHost falls back to unresolved sentinel when no devices.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ResolveHost_falls_back_to_unresolved_sentinel_when_no_devices()
{
@@ -253,39 +263,26 @@ public sealed class TwinCATCapabilityTests
/// <summary>Gets the list of variables added to the address space.</summary>
public List<(string BrowseName, DriverAttributeInfo Info)> Variables { get; } = new();
/// <summary>Adds a folder with the specified browse name and display name.</summary>
/// <param name="browseName">The browse name of the folder.</param>
/// <param name="displayName">The display name of the folder.</param>
/// <returns>This builder instance.</returns>
/// <inheritdoc />
public IAddressSpaceBuilder Folder(string browseName, string displayName)
{ Folders.Add((browseName, displayName)); return this; }
/// <summary>Adds a variable with the specified browse name, display name, and attribute info.</summary>
/// <param name="browseName">The browse name of the variable.</param>
/// <param name="displayName">The display name of the variable.</param>
/// <param name="info">The driver attribute information for the variable.</param>
/// <returns>A variable handle for the added variable.</returns>
/// <inheritdoc />
public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo info)
{ Variables.Add((browseName, info)); return new Handle(info.FullName); }
/// <summary>Adds a property to a variable.</summary>
/// <param name="_">The property name.</param>
/// <param name="__">The property data type.</param>
/// <param name="___">The property value.</param>
/// <inheritdoc />
public void AddProperty(string _, DriverDataType __, object? ___) { }
private sealed class Handle(string fullRef) : IVariableHandle
{
/// <summary>Gets the full reference name of the variable.</summary>
/// <inheritdoc />
public string FullReference => fullRef;
/// <summary>Marks the variable as an alarm condition.</summary>
/// <param name="info">The alarm condition information.</param>
/// <returns>An alarm condition sink.</returns>
/// <inheritdoc />
public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info) => new NullSink();
}
private sealed class NullSink : IAlarmConditionSink {
/// <summary>Called when an alarm transitions.</summary>
/// <param name="args">The alarm event arguments.</param>
/// <inheritdoc />
public void OnTransition(AlarmEventArgs args) { } }
}
}