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,7 +18,10 @@ public sealed class ScriptLogCompanionSinkTests
{
private sealed class CapturingSink : ILogEventSink
{
/// <summary>Gets the list of captured log events.</summary>
public List<LogEvent> Events { get; } = [];
/// <summary>Emits a log event by adding it to the events list.</summary>
/// <param name="logEvent">The log event to emit.</param>
public void Emit(LogEvent logEvent) => Events.Add(logEvent);
}
@@ -40,6 +43,7 @@ public sealed class ScriptLogCompanionSinkTests
return (scriptLogger, scriptSink, mainSink);
}
/// <summary>Tests that Info event lands in scripts sink but not in main.</summary>
[Fact]
public void Info_event_lands_in_scripts_sink_but_not_in_main()
{
@@ -50,6 +54,7 @@ public sealed class ScriptLogCompanionSinkTests
mainSink.Events.Count.ShouldBe(0);
}
/// <summary>Tests that Warning event lands in scripts sink but not in main.</summary>
[Fact]
public void Warning_event_lands_in_scripts_sink_but_not_in_main()
{
@@ -60,6 +65,7 @@ public sealed class ScriptLogCompanionSinkTests
mainSink.Events.Count.ShouldBe(0);
}
/// <summary>Tests that Error event is mirrored to main at Warning level.</summary>
[Fact]
public void Error_event_mirrored_to_main_at_Warning_level()
{
@@ -72,6 +78,7 @@ public sealed class ScriptLogCompanionSinkTests
mainSink.Events[0].Level.ShouldBe(LogEventLevel.Warning, "Error+ is downgraded to Warning in the main log");
}
/// <summary>Tests that mirrored event includes ScriptName and original level.</summary>
[Fact]
public void Mirrored_event_includes_ScriptName_and_original_level()
{
@@ -86,6 +93,7 @@ public sealed class ScriptLogCompanionSinkTests
((ScalarValue)forwarded.Properties["OriginalLevel"]).Value.ShouldBe(LogEventLevel.Error);
}
/// <summary>Tests that mirrored event preserves exception for main log stack trace.</summary>
[Fact]
public void Mirrored_event_preserves_exception_for_main_log_stack_trace()
{
@@ -97,6 +105,7 @@ public sealed class ScriptLogCompanionSinkTests
mainSink.Events[0].Exception.ShouldBeSameAs(ex);
}
/// <summary>Tests that Fatal event is mirrored just like Error.</summary>
[Fact]
public void Fatal_event_mirrored_just_like_Error()
{
@@ -106,6 +115,7 @@ public sealed class ScriptLogCompanionSinkTests
mainSink.Events[0].Level.ShouldBe(LogEventLevel.Warning);
}
/// <summary>Tests that missing ScriptName property falls back to unknown.</summary>
[Fact]
public void Missing_ScriptName_property_falls_back_to_unknown()
{
@@ -126,12 +136,14 @@ public sealed class ScriptLogCompanionSinkTests
Should.NotThrow(() => companion.Emit(ev));
}
/// <summary>Tests that null main logger is rejected.</summary>
[Fact]
public void Null_main_logger_rejected()
{
Should.Throw<ArgumentNullException>(() => new ScriptLogCompanionSink(null!));
}
/// <summary>Tests that custom mirror threshold is applied.</summary>
[Fact]
public void Custom_mirror_threshold_applied()
{
@@ -153,6 +165,7 @@ public sealed class ScriptLogCompanionSinkTests
mainSink.Events.Count.ShouldBe(1);
}
/// <summary>Tests that factory plus companion sink integration surfaces script error in both logs.</summary>
[Fact]
public void Factory_plus_companion_sink_integration_surfaces_script_error_in_both_logs()
{