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
@@ -15,8 +15,10 @@ public sealed class FocasPmcBitRmwTests
/// </summary>
private sealed class PmcRmwFake : FakeFocasClient
{
/// <summary>Gets the simulated PMC byte storage.</summary>
public byte[] PmcBytes { get; } = new byte[1024];
/// <inheritdoc />
public override Task<(object? value, uint status)> ReadAsync(
FocasAddress address, FocasDataType type, CancellationToken ct)
{
@@ -27,6 +29,7 @@ public sealed class FocasPmcBitRmwTests
return base.ReadAsync(address, type, ct);
}
/// <inheritdoc />
public override Task<uint> WriteAsync(
FocasAddress address, FocasDataType type, object? value, CancellationToken ct)
{
@@ -62,6 +65,7 @@ public sealed class FocasPmcBitRmwTests
return (drv, fake);
}
/// <summary>Verifies that a bit set operation surfaces as Good status and flips the bit.</summary>
[Fact]
public async Task Bit_set_surfaces_as_Good_status_and_flips_bit()
{
@@ -76,6 +80,7 @@ public sealed class FocasPmcBitRmwTests
fake.PmcBytes[100].ShouldBe((byte)0b0000_1001);
}
/// <summary>Verifies that clearing a bit preserves other bits.</summary>
[Fact]
public async Task Bit_clear_preserves_other_bits()
{
@@ -89,6 +94,7 @@ public sealed class FocasPmcBitRmwTests
fake.PmcBytes[100].ShouldBe((byte)0b1111_0111);
}
/// <summary>Verifies that subsequent bit sets in the same byte compose correctly.</summary>
[Fact]
public async Task Subsequent_bit_sets_in_same_byte_compose_correctly()
{
@@ -105,6 +111,7 @@ public sealed class FocasPmcBitRmwTests
fake.PmcBytes[100].ShouldBe((byte)0xFF);
}
/// <summary>Verifies that bit writes to different bytes do not contend.</summary>
[Fact]
public async Task Bit_write_to_different_bytes_does_not_contend()
{