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
@@ -26,8 +26,7 @@ public sealed class GalaxyDriverWriteTests
private sealed class FakeHierarchySource(IReadOnlyList<GalaxyObject> objects) : IGalaxyHierarchySource
{
/// <summary>Returns the fake Galaxy object hierarchy.</summary>
/// <param name="cancellationToken">Token to cancel the operation.</param>
/// <inheritdoc />
public Task<IReadOnlyList<GalaxyObject>> GetHierarchyAsync(CancellationToken cancellationToken)
=> Task.FromResult(objects);
}
@@ -37,36 +36,26 @@ public sealed class GalaxyDriverWriteTests
/// <summary>Gets the list of variables added to this builder.</summary>
public List<DriverAttributeInfo> Variables { get; } = [];
/// <summary>Adds a folder and returns this builder for chaining.</summary>
/// <param name="browseName">The browse name of the folder.</param>
/// <param name="displayName">The display name of the folder.</param>
/// <inheritdoc />
public IAddressSpaceBuilder Folder(string browseName, string displayName) => this;
/// <summary>Adds a variable to the variables list and returns a handle.</summary>
/// <param name="browseName">The browse name of the variable.</param>
/// <param name="displayName">The display name of the variable.</param>
/// <param name="attributeInfo">The attribute information for the variable.</param>
/// <inheritdoc />
public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo attributeInfo)
{
Variables.Add(attributeInfo);
return new FakeHandle(attributeInfo.FullName);
}
/// <summary>No-op property adding operation for test compatibility.</summary>
/// <param name="browseName">The browse name of the property.</param>
/// <param name="dataType">The data type of the property.</param>
/// <param name="value">The value of the property.</param>
/// <inheritdoc />
public void AddProperty(string browseName, DriverDataType dataType, object? value) { }
private sealed class FakeHandle(string fullRef) : IVariableHandle
{
/// <summary>Gets the full reference for this variable handle.</summary>
/// <inheritdoc />
public string FullReference { get; } = fullRef;
/// <summary>Marks this variable as an alarm condition and returns a noop sink.</summary>
/// <param name="info">The alarm condition information.</param>
/// <inheritdoc />
public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info) => new NoopSink();
/// <summary>No-op alarm transition handler.</summary>
private sealed class NoopSink : IAlarmConditionSink {
/// <summary>Handles alarm state transition events.</summary>
/// <param name="args">The alarm event arguments.</param>
/// <inheritdoc />
public void OnTransition(AlarmEventArgs args) { }
}
}
@@ -77,10 +66,7 @@ public sealed class GalaxyDriverWriteTests
/// <summary>Gets the list of write calls received by this writer.</summary>
public List<(string FullRef, object? Value, SecurityClassification Resolved)> Calls { get; } = [];
/// <summary>Records write requests with their resolved security classifications.</summary>
/// <param name="writes">The list of write requests to process.</param>
/// <param name="securityResolver">Function to resolve security classification for each request.</param>
/// <param name="cancellationToken">Token to cancel the operation.</param>
/// <inheritdoc />
public Task<IReadOnlyList<WriteResult>> WriteAsync(
IReadOnlyList<WriteRequest> writes,
Func<string, SecurityClassification> securityResolver,
@@ -107,6 +93,7 @@ public sealed class GalaxyDriverWriteTests
}
/// <summary>Verifies that WriteAsync routes through the injected writer and propagates values correctly.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WriteAsync_RoutesThroughInjectedWriter_AndPropagatesValues()
{
@@ -133,6 +120,7 @@ public sealed class GalaxyDriverWriteTests
/// <summary>Verifies that WriteAsync resolves every security classification from discovery data.</summary>
/// <param name="mxSec">The raw MXAccess security integer from the discovery attribute.</param>
/// <param name="expected">The expected resolved security classification.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData(0, SecurityClassification.FreeAccess)]
[InlineData(1, SecurityClassification.Operate)]
@@ -157,6 +145,7 @@ public sealed class GalaxyDriverWriteTests
}
/// <summary>Verifies that unknown tags resolve to FreeAccess classification and writes proceed.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WriteAsync_UnknownTag_ResolvesToFreeAccess_DefaultsToWrite()
{
@@ -172,6 +161,7 @@ public sealed class GalaxyDriverWriteTests
}
/// <summary>Verifies that an empty write request returns empty without calling the writer.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WriteAsync_EmptyRequest_ReturnsEmpty_WithoutCallingWriter()
{
@@ -186,6 +176,7 @@ public sealed class GalaxyDriverWriteTests
}
/// <summary>Verifies that WriteAsync throws when no writer is configured, referencing PR 4.4.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WriteAsync_NoWriter_Throws_PointingAtPR44()
{
@@ -197,6 +188,7 @@ public sealed class GalaxyDriverWriteTests
}
/// <summary>Verifies that WriteAsync throws ObjectDisposedException after the driver is disposed.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WriteAsync_AfterDispose_Throws()
{