dohertj2/lmxopcua
1
0
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: complete XML doc comments via fixdocs (2757 to 131 findings)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.IntegrationTests/Series/WireBackendCoverageTests.cs
+11 -16
View File
@@ -26,6 +26,7 @@ public sealed class WireBackendCoverageTests
private const string DeviceHost = "focas://127.0.0.1:8193";
/// <summary>Verifies that user tag reads route via the wire backend.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task User_tag_reads_route_via_wire_backend()
{
@@ -73,6 +74,7 @@ public sealed class WireBackendCoverageTests
}
/// <summary>Verifies that discover emits device folder and tag variables.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Discover_emits_device_folder_and_tag_variables()
{
@@ -107,6 +109,7 @@ public sealed class WireBackendCoverageTests
}
/// <summary>Verifies that subscribe fires OnDataChange via the wire backend.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Subscribe_fires_OnDataChange_via_wire_backend()
{
@@ -157,6 +160,7 @@ public sealed class WireBackendCoverageTests
}
/// <summary>Verifies that alarm raise then clear emits both events via the wire backend.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Alarm_raise_then_clear_emits_both_events_via_wire_backend()
{
@@ -210,6 +214,7 @@ public sealed class WireBackendCoverageTests
}
/// <summary>Verifies that the probe transitions to Running against the live mock.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Probe_transitions_to_Running_against_live_mock()
{
@@ -255,39 +260,29 @@ public sealed class WireBackendCoverageTests
/// <summary>Gets the list of recorded variables.</summary>
public List<(string BrowseName, DriverAttributeInfo Info)> Variables { get; } = new();
/// <summary>Records a folder in the address space builder.</summary>
/// <param name="browseName">The browse name for the folder.</param>
/// <param name="displayName">The display name for the folder.</param>
/// <inheritdoc />
public IAddressSpaceBuilder Folder(string browseName, string displayName)
{ Folders.Add((browseName, displayName)); return this; }
/// <summary>Records a variable in the address space builder.</summary>
/// <param name="browseName">The browse name for the variable.</param>
/// <param name="displayName">The display name for the variable.</param>
/// <param name="info">The driver attribute information.</param>
/// <inheritdoc />
public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo info)
{ Variables.Add((browseName, info)); return new Handle(info.FullName); }
/// <summary>Records an address space property (no-op in this builder).</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 OPC UA reference for the variable.</summary>
/// <inheritdoc />
public string FullReference => fullRef;
/// <summary>Marks the variable as an alarm condition and returns a sink.</summary>
/// <param name="info">The alarm condition information.</param>
/// <inheritdoc />
public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info) => new NullSink();
}
private sealed class NullSink : IAlarmConditionSink
{
/// <summary>Handles an alarm transition event (no-op in this sink).</summary>
/// <param name="args">The alarm event arguments.</param>
/// <inheritdoc />
public void OnTransition(AlarmEventArgs args) { }
}
}