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,10 +18,15 @@ public sealed class ScriptLoggerFactoryTests
/// <summary>Capturing sink that collects every emitted LogEvent for assertion.</summary>
private sealed class CapturingSink : ILogEventSink
{
/// <summary>Gets the list of captured log events.</summary>
public List<LogEvent> Events { get; } = [];
/// <summary>Adds a log event to the captured list.</summary>
/// <param name="logEvent">The log event to capture.</param>
public void Emit(LogEvent logEvent) => Events.Add(logEvent);
}
/// <summary>Verifies that Create sets the ScriptName structured property.</summary>
[Fact]
public void Create_sets_ScriptName_structured_property()
{
@@ -38,6 +43,7 @@ public sealed class ScriptLoggerFactoryTests
((ScalarValue)ev.Properties[ScriptLoggerFactory.ScriptNameProperty]).Value.ShouldBe("LineRate");
}
/// <summary>Verifies that each script gets its own property value.</summary>
[Fact]
public void Each_script_gets_its_own_property_value()
{
@@ -55,6 +61,7 @@ public sealed class ScriptLoggerFactoryTests
((ScalarValue)sink.Events[2].Properties[ScriptLoggerFactory.ScriptNameProperty]).Value.ShouldBe("Alarm_A");
}
/// <summary>Verifies that error-level events preserve level and exception.</summary>
[Fact]
public void Error_level_event_preserves_level_and_exception()
{
@@ -68,12 +75,14 @@ public sealed class ScriptLoggerFactoryTests
sink.Events[0].Exception.ShouldBeOfType<InvalidOperationException>();
}
/// <summary>Verifies that null root logger is rejected.</summary>
[Fact]
public void Null_root_rejected()
{
Should.Throw<ArgumentNullException>(() => new ScriptLoggerFactory(null!));
}
/// <summary>Verifies that empty script names are rejected.</summary>
[Fact]
public void Empty_script_name_rejected()
{
@@ -84,6 +93,7 @@ public sealed class ScriptLoggerFactoryTests
Should.Throw<ArgumentException>(() => factory.Create(null!));
}
/// <summary>Verifies that the ScriptNameProperty constant is stable.</summary>
[Fact]
public void ScriptNameProperty_constant_is_stable()
{