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
@@ -21,6 +21,7 @@ public sealed class ModbusArrayTests
return (drv, fake);
}
/// <summary>Verifies reading an Int16 array returns a typed array.</summary>
[Fact]
public async Task Read_Int16_Array_Returns_Typed_Array()
{
@@ -34,6 +35,7 @@ public sealed class ModbusArrayTests
arr.ShouldBe(new short[] { 100, 101, 102, 103, 104 });
}
/// <summary>Verifies reading a Float32 array with word swap returns a typed array.</summary>
[Fact]
public async Task Read_Float32_Array_Returns_Typed_Array_With_WordSwap()
{
@@ -60,6 +62,7 @@ public sealed class ModbusArrayTests
arr.ShouldBe(src);
}
/// <summary>Verifies reading a coil array returns a bool array.</summary>
[Fact]
public async Task Read_Coil_Array_Returns_Bool_Array()
{
@@ -74,6 +77,7 @@ public sealed class ModbusArrayTests
arr.ShouldBe(new[] { true, false, true, false, true, false, true, false, true, false });
}
/// <summary>Verifies writing an Int16 array lands contiguously in the register bank.</summary>
[Fact]
public async Task Write_Int16_Array_Lands_Contiguous_In_Bank()
{
@@ -91,6 +95,7 @@ public sealed class ModbusArrayTests
fake.HoldingRegisters[50 + i].ShouldBe((ushort)write[i]);
}
/// <summary>Verifies writing a coil array packs bits in LSB-first order.</summary>
[Fact]
public async Task Write_Coil_Array_Packs_LSB_First()
{
@@ -108,6 +113,7 @@ public sealed class ModbusArrayTests
fake.Coils[i].ShouldBe(pattern[i]);
}
/// <summary>Verifies writing an array with mismatched length surfaces an error.</summary>
[Fact]
public async Task Write_Array_Mismatch_Length_Surfaces_Error()
{
@@ -122,6 +128,7 @@ public sealed class ModbusArrayTests
results[0].StatusCode.ShouldNotBe(0u);
}
/// <summary>Verifies discovery surfaces IsArray and ArrayDim correctly.</summary>
[Fact]
public async Task Discovery_Surfaces_IsArray_And_ArrayDim()
{
@@ -137,6 +144,7 @@ public sealed class ModbusArrayTests
captured[0].ArrayDim.ShouldBe(8u);
}
/// <summary>Verifies scalar tag discovery keeps IsArray false.</summary>
[Fact]
public async Task Scalar_Tag_Discovery_Stays_NonArray()
{
@@ -152,19 +160,43 @@ public sealed class ModbusArrayTests
captured[0].ArrayDim.ShouldBeNull();
}
/// <summary>Recording address space builder for capturing discovered attributes.</summary>
/// <param name="captured">List to capture discovered attributes into.</param>
private sealed class RecordingBuilder(List<DriverAttributeInfo> captured) : IAddressSpaceBuilder
{
/// <summary>Creates a folder in the address space.</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) => this;
/// <summary>Creates a variable in the address space.</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.</param>
/// <returns>A variable handle.</returns>
public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo attributeInfo)
{
captured.Add(attributeInfo);
return new StubHandle(browseName);
}
/// <summary>Adds a property to the current node.</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 property value.</param>
public void AddProperty(string browseName, DriverDataType dataType, object? value) { }
/// <summary>Stub variable handle for testing.</summary>
/// <param name="fullRef">The full reference of the handle.</param>
private sealed class StubHandle(string fullRef) : IVariableHandle
{
/// <summary>Gets the full reference.</summary>
public string FullReference => fullRef;
/// <summary>Marks this 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)
=> throw new NotSupportedException("RecordingBuilder doesn't model alarms");
}