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
@@ -11,6 +11,7 @@ public sealed class TwinCATCapabilityTests
{
// ---- ITagDiscovery ----
/// <summary>Verifies that DiscoverAsync emits pre-declared tags.</summary>
[Fact]
public async Task DiscoverAsync_emits_pre_declared_tags()
{
@@ -37,6 +38,7 @@ public sealed class TwinCATCapabilityTests
// ---- ISubscribable ----
/// <summary>Verifies that Subscribe initial poll raises OnDataChange.</summary>
[Fact]
public async Task Subscribe_initial_poll_raises_OnDataChange()
{
@@ -63,6 +65,7 @@ public sealed class TwinCATCapabilityTests
await drv.UnsubscribeAsync(handle, CancellationToken.None);
}
/// <summary>Verifies that ShutdownAsync cancels active subscriptions.</summary>
[Fact]
public async Task ShutdownAsync_cancels_active_subscriptions()
{
@@ -93,6 +96,7 @@ public sealed class TwinCATCapabilityTests
// ---- IHostConnectivityProbe ----
/// <summary>Verifies that GetHostStatuses returns entry per device.</summary>
[Fact]
public async Task GetHostStatuses_returns_entry_per_device()
{
@@ -110,6 +114,7 @@ public sealed class TwinCATCapabilityTests
drv.GetHostStatuses().Count.ShouldBe(2);
}
/// <summary>Verifies that Probe transitions to Running on successful probe.</summary>
[Fact]
public async Task Probe_transitions_to_Running_on_successful_probe()
{
@@ -136,6 +141,7 @@ public sealed class TwinCATCapabilityTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that Probe transitions to Stopped on probe failure.</summary>
[Fact]
public async Task Probe_transitions_to_Stopped_on_probe_failure()
{
@@ -162,6 +168,7 @@ public sealed class TwinCATCapabilityTests
await drv.ShutdownAsync(CancellationToken.None);
}
/// <summary>Verifies that Probe is disabled when Enabled is false.</summary>
[Fact]
public async Task Probe_disabled_when_Enabled_is_false()
{
@@ -180,6 +187,7 @@ public sealed class TwinCATCapabilityTests
// ---- IPerCallHostResolver ----
/// <summary>Verifies that ResolveHost returns declared device for known tag.</summary>
[Fact]
public async Task ResolveHost_returns_declared_device_for_known_tag()
{
@@ -203,6 +211,7 @@ public sealed class TwinCATCapabilityTests
drv.ResolveHost("B").ShouldBe("ads://5.23.91.24.1.1:851");
}
/// <summary>Verifies that ResolveHost falls back to first device for unknown reference.</summary>
[Fact]
public async Task ResolveHost_falls_back_to_first_device_for_unknown_ref()
{
@@ -216,6 +225,7 @@ public sealed class TwinCATCapabilityTests
drv.ResolveHost("missing").ShouldBe("ads://5.23.91.23.1.1:851");
}
/// <summary>Verifies that ResolveHost falls back to unresolved sentinel when no devices.</summary>
[Fact]
public async Task ResolveHost_falls_back_to_unresolved_sentinel_when_no_devices()
{
@@ -238,22 +248,44 @@ public sealed class TwinCATCapabilityTests
private sealed class RecordingBuilder : IAddressSpaceBuilder
{
/// <summary>Gets the list of folders added to the address space.</summary>
public List<(string BrowseName, string DisplayName)> Folders { get; } = new();
/// <summary>Gets the list of variables added to the address space.</summary>
public List<(string BrowseName, DriverAttributeInfo Info)> Variables { get; } = new();
/// <summary>Adds a folder with the specified browse name and display name.</summary>
/// <param name="browseName">The browse name of the folder.</param>
/// <param name="displayName">The display name of the folder.</param>
/// <returns>This builder instance.</returns>
public IAddressSpaceBuilder Folder(string browseName, string displayName)
{ Folders.Add((browseName, displayName)); return this; }
/// <summary>Adds a variable with the specified browse name, display name, and attribute info.</summary>
/// <param name="browseName">The browse name of the variable.</param>
/// <param name="displayName">The display name of the variable.</param>
/// <param name="info">The driver attribute information for the variable.</param>
/// <returns>A variable handle for the added variable.</returns>
public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo info)
{ Variables.Add((browseName, info)); return new Handle(info.FullName); }
/// <summary>Adds a property to a variable.</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 reference name of the variable.</summary>
public string FullReference => fullRef;
/// <summary>Marks the variable as an alarm condition.</summary>
/// <param name="info">The alarm condition information.</param>
/// <returns>An alarm condition sink.</returns>
public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info) => new NullSink();
}
private sealed class NullSink : IAlarmConditionSink { public void OnTransition(AlarmEventArgs args) { } }
private sealed class NullSink : IAlarmConditionSink {
/// <summary>Called when an alarm transitions.</summary>
/// <param name="args">The alarm event arguments.</param>
public void OnTransition(AlarmEventArgs args) { } }
}
}