docs: backfill XML documentation across 756 files
v2-ci / build (push) Failing after 1m43s
v2-ci / unit-tests (tests/Core/ZB.MOM.WW.OtOpcUa.Cluster.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.ControlPlane.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Runtime.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Security.Tests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Has been skipped

Adds <summary>, <param>, <typeparam>, and <inheritdoc/> tags to public
members surfaced by commentchecker — resolves 5,847 of 5,869 issues
(99.6%) across three /fixdocs passes.
This commit is contained in:
Joseph Doherty
2026-05-28 08:10:17 -04:00
parent f9fc7dd2e1
commit 64e3fbe035
756 changed files with 9876 additions and 96 deletions
@@ -19,10 +19,13 @@ public sealed class WireBackendCoverageTests
{
private readonly FocasSimFixture _fx;
/// <summary>Initializes a new instance of WireBackendCoverageTests with the FOCAS simulation fixture.</summary>
/// <param name="fx">The FOCAS simulation fixture.</param>
public WireBackendCoverageTests(FocasSimFixture fx) => _fx = fx;
private const string DeviceHost = "focas://127.0.0.1:8193";
/// <summary>Verifies that user tag reads route via the wire backend.</summary>
[Fact]
public async Task User_tag_reads_route_via_wire_backend()
{
@@ -69,6 +72,7 @@ public sealed class WireBackendCoverageTests
}
}
/// <summary>Verifies that discover emits device folder and tag variables.</summary>
[Fact]
public async Task Discover_emits_device_folder_and_tag_variables()
{
@@ -102,6 +106,7 @@ public sealed class WireBackendCoverageTests
}
}
/// <summary>Verifies that subscribe fires OnDataChange via the wire backend.</summary>
[Fact]
public async Task Subscribe_fires_OnDataChange_via_wire_backend()
{
@@ -151,6 +156,7 @@ public sealed class WireBackendCoverageTests
}
}
/// <summary>Verifies that alarm raise then clear emits both events via the wire backend.</summary>
[Fact]
public async Task Alarm_raise_then_clear_emits_both_events_via_wire_backend()
{
@@ -203,6 +209,7 @@ public sealed class WireBackendCoverageTests
}
}
/// <summary>Verifies that the probe transitions to Running against the live mock.</summary>
[Fact]
public async Task Probe_transitions_to_Running_against_live_mock()
{
@@ -242,22 +249,46 @@ public sealed class WireBackendCoverageTests
private sealed class RecordingBuilder : IAddressSpaceBuilder
{
/// <summary>Gets the list of recorded folders.</summary>
public List<(string BrowseName, string DisplayName)> Folders { get; } = new();
/// <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>
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>
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>
public void AddProperty(string _, DriverDataType __, object? ___) { }
private sealed class Handle(string fullRef) : IVariableHandle
{
/// <summary>Gets the full OPC UA reference for the variable.</summary>
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>
public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info) => new NullSink();
}
private sealed class NullSink : IAlarmConditionSink { public void OnTransition(AlarmEventArgs args) { } }
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>
public void OnTransition(AlarmEventArgs args) { }
}
}
}