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
@@ -18,6 +18,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Tests.Runtime;
public sealed class EventPumpBoundedChannelTests
{
/// <summary>Verifies that the event pump drops newest events when the bounded channel fills and records metrics for dropped events.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Drops_newest_when_channel_fills_and_records_metric()
{
@@ -68,6 +69,7 @@ public sealed class EventPumpBoundedChannelTests
}
/// <summary>Verifies that the event pump throws an exception when the channel capacity is invalid.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Throws_when_channelCapacity_is_invalid()
{
@@ -81,6 +83,7 @@ public sealed class EventPumpBoundedChannelTests
}
/// <summary>Verifies that event pump metrics are tagged with the client name for tracking multiple driver hosts.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Tags_metrics_with_client_name_for_multi_driver_hosts()
{
@@ -189,25 +192,16 @@ public sealed class EventPumpBoundedChannelTests
private readonly Channel<MxEvent> _stream =
Channel.CreateUnbounded<MxEvent>(new UnboundedChannelOptions { SingleReader = true });
/// <summary>Subscribes to a bulk list of tag references.</summary>
/// <param name="fullReferences">The list of full references to subscribe to.</param>
/// <param name="bufferedUpdateIntervalMs">The buffered update interval in milliseconds.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>An empty result list.</returns>
/// <inheritdoc />
public Task<IReadOnlyList<SubscribeResult>> SubscribeBulkAsync(
IReadOnlyList<string> fullReferences, int bufferedUpdateIntervalMs, CancellationToken cancellationToken)
=> Task.FromResult<IReadOnlyList<SubscribeResult>>([]);
/// <summary>Unsubscribes from a bulk list of item handles.</summary>
/// <param name="itemHandles">The list of item handles to unsubscribe from.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A completed task.</returns>
/// <inheritdoc />
public Task UnsubscribeBulkAsync(IReadOnlyList<int> itemHandles, CancellationToken cancellationToken)
=> Task.CompletedTask;
/// <summary>Streams events asynchronously.</summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>An async enumerable of MxEvent objects.</returns>
/// <inheritdoc />
public IAsyncEnumerable<MxEvent> StreamEventsAsync(CancellationToken cancellationToken)
=> _stream.Reader.ReadAllAsync(cancellationToken);