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,6 +19,7 @@ public sealed class AbCipLoggingTests
{
private const string Device = "ab://10.0.0.5/1,0";
/// <summary>Verifies that constructor accepts an ILogger.</summary>
[Fact]
public void Constructor_accepts_an_ILogger()
{
@@ -34,6 +35,7 @@ public sealed class AbCipLoggingTests
drv.ShouldNotBeNull();
}
/// <summary>Verifies that ProbeLoop logs when an exception is swallowed.</summary>
[Fact]
public async Task ProbeLoop_logs_when_an_exception_is_swallowed()
{
@@ -76,6 +78,7 @@ public sealed class AbCipLoggingTests
.ShouldBeTrue("at least one log entry should reference the probe loop or surface the swallowed exception");
}
/// <summary>Verifies that ReadFailure logs at warning level.</summary>
[Fact]
public async Task ReadFailure_logs_at_warning_level()
{
@@ -102,6 +105,7 @@ public sealed class AbCipLoggingTests
.ShouldBeTrue("read failure on tag 'Speed' should be logged at warning level or above");
}
/// <summary>Verifies that ReadException logs at warning level.</summary>
[Fact]
public async Task ReadException_logs_at_warning_level()
{
@@ -132,6 +136,7 @@ public sealed class AbCipLoggingTests
.ShouldBeTrue("read transport exception should be logged at warning level with the inner exception attached");
}
/// <summary>Verifies that InitializeAsync warns when probe is enabled but ProbeTagPath is blank.</summary>
[Fact]
public async Task InitializeAsync_warns_when_probe_is_enabled_but_ProbeTagPath_is_blank()
{
@@ -158,6 +163,7 @@ public sealed class AbCipLoggingTests
.ShouldBeTrue("probe-enabled-but-inert configuration should be logged at warning level");
}
/// <summary>Verifies that InitializeAsync does not warn when probe is disabled.</summary>
[Fact]
public async Task InitializeAsync_does_not_warn_when_probe_is_disabled()
{
@@ -176,12 +182,26 @@ public sealed class AbCipLoggingTests
.ShouldBeFalse("no probe warning expected when Probe.Enabled is false");
}
/// <summary>Test logger that captures all log entries.</summary>
internal sealed class CapturingLogger<T> : ILogger<T>
{
/// <summary>Gets the captured log entries.</summary>
public List<(LogLevel Level, string Message, Exception? Exception)> Entries { get; } = new();
/// <summary>Begins a scope (stub implementation).</summary>
/// <typeparam name="TState">The type of the scope state.</typeparam>
/// <param name="state">The scope state.</param>
public IDisposable BeginScope<TState>(TState state) where TState : notnull => NullScope.Instance;
/// <summary>Checks if logging is enabled (always true).</summary>
/// <param name="logLevel">The log level to check.</param>
public bool IsEnabled(LogLevel logLevel) => true;
/// <summary>Logs an entry and captures it.</summary>
/// <typeparam name="TState">The type of the log state.</typeparam>
/// <param name="logLevel">The log level.</param>
/// <param name="eventId">The event ID.</param>
/// <param name="state">The log state.</param>
/// <param name="exception">The exception, if any.</param>
/// <param name="formatter">The log message formatter.</param>
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception,
Func<TState, Exception?, string> formatter)
{
@@ -190,7 +210,9 @@ public sealed class AbCipLoggingTests
private sealed class NullScope : IDisposable
{
/// <summary>Gets the singleton instance.</summary>
public static NullScope Instance { get; } = new();
/// <summary>Disposes the scope (stub implementation).</summary>
public void Dispose() { }
}
}