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
@@ -18,18 +18,27 @@ public sealed class AbLegacyLoggerInjectionTests
private sealed class CapturingLogger : ILogger<AbLegacyDriver>
{
public readonly List<(LogLevel Level, string Message)> Entries = new();
/// <inheritdoc />
public IDisposable BeginScope<TState>(TState state) where TState : notnull => NullScope.Instance;
/// <inheritdoc />
public bool IsEnabled(LogLevel logLevel) => true;
/// <inheritdoc />
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception,
Func<TState, Exception?, string> formatter)
=> Entries.Add((logLevel, formatter(state, exception)));
private sealed class NullScope : IDisposable
{
public static readonly NullScope Instance = new();
/// <inheritdoc />
public void Dispose() { }
}
}
/// <summary>Verifies that the driver accepts an optional logger parameter.</summary>
[Fact]
public void Driver_accepts_optional_logger_parameter()
{
@@ -40,6 +49,7 @@ public sealed class AbLegacyLoggerInjectionTests
drv.ShouldNotBeNull();
}
/// <summary>Verifies that driver initialization failure emits an error log.</summary>
[Fact]
public async Task InitializeAsync_failure_emits_error_log()
{
@@ -57,6 +67,7 @@ public sealed class AbLegacyLoggerInjectionTests
errors[0].Message.ShouldContain("drv-logged");
}
/// <summary>Verifies that the first non-zero libplctag status per device is logged.</summary>
[Fact]
public async Task First_nonzero_libplctag_status_per_device_is_logged()
{