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
@@ -17,6 +17,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Tests;
public sealed class GalaxyDriverAlarmSourceTests
{
/// <summary>Verifies that SubscribeAlarmsAsync starts the alarm feed and events fire on transition.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task SubscribeAlarmsAsync_starts_feed_and_event_fires_on_transition()
{
@@ -62,6 +63,7 @@ public sealed class GalaxyDriverAlarmSourceTests
}
/// <summary>Verifies that UnsubscribeAlarmsAsync stops event flow.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task UnsubscribeAlarmsAsync_stops_event_flow()
{
@@ -84,6 +86,7 @@ public sealed class GalaxyDriverAlarmSourceTests
}
/// <summary>Verifies that UnsubscribeAlarmsAsync throws for a foreign handle.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task UnsubscribeAlarmsAsync_throws_for_foreign_handle()
{
@@ -97,6 +100,7 @@ public sealed class GalaxyDriverAlarmSourceTests
}
/// <summary>Verifies that AcknowledgeAsync routes each request to the acknowledger.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task AcknowledgeAsync_routes_each_request_to_the_acknowledger()
{
@@ -119,6 +123,7 @@ public sealed class GalaxyDriverAlarmSourceTests
}
/// <summary>Verifies that AcknowledgeAsync falls back to SourceNodeId when ConditionId is empty.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task AcknowledgeAsync_falls_back_to_SourceNodeId_when_ConditionId_empty()
{
@@ -134,6 +139,7 @@ public sealed class GalaxyDriverAlarmSourceTests
}
/// <summary>Verifies that AcknowledgeAsync throws NotSupportedException without an acknowledger.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task AcknowledgeAsync_throws_NotSupported_without_acknowledger()
{
@@ -191,7 +197,7 @@ public sealed class GalaxyDriverAlarmSourceTests
/// <summary>Occurs when an alarm transition is emitted.</summary>
public event EventHandler<GalaxyAlarmTransition>? OnAlarmTransition;
/// <summary>Marks the feed as started.</summary>
/// <inheritdoc />
public void Start() => Started = true;
/// <summary>Emits an alarm transition to all subscribers.</summary>
@@ -210,12 +216,7 @@ public sealed class GalaxyDriverAlarmSourceTests
/// <summary>Gets the list of acknowledge calls recorded.</summary>
public List<(string AlarmRef, string Comment, string Operator)> Calls { get; } = [];
/// <summary>Records an acknowledge call.</summary>
/// <param name="alarmFullReference">The alarm full reference.</param>
/// <param name="comment">The acknowledgment comment.</param>
/// <param name="operatorUser">The operator user.</param>
/// <param name="cancellationToken">Cancellation token.</param>
/// <returns>A completed task.</returns>
/// <inheritdoc />
public Task AcknowledgeAsync(string alarmFullReference, string comment, string operatorUser, CancellationToken cancellationToken)
{
Calls.Add((alarmFullReference, comment, operatorUser));
@@ -226,7 +227,7 @@ public sealed class GalaxyDriverAlarmSourceTests
/// <summary>Test double that represents a foreign alarm subscription handle.</summary>
private sealed class ForeignAlarmHandle : IAlarmSubscriptionHandle
{
/// <summary>Gets the diagnostic ID for this handle.</summary>
/// <inheritdoc />
public string DiagnosticId => "foreign";
}
}