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,6 +15,7 @@ public sealed class Part9StateMachineTests
private static readonly DateTime T0 = new(2026, 1, 1, 12, 0, 0, DateTimeKind.Utc);
private static AlarmConditionState Fresh() => AlarmConditionState.Fresh("alarm-1", T0);
/// <summary>Verifies that an inactive alarm becomes active and emits Activated when predicate becomes true.</summary>
[Fact]
public void Predicate_true_on_inactive_becomes_active_and_emits_Activated()
{
@@ -26,6 +27,7 @@ public sealed class Part9StateMachineTests
r.State.LastActiveUtc.ShouldNotBeNull();
}
/// <summary>Verifies that an active alarm becomes inactive and emits Cleared when predicate becomes false.</summary>
[Fact]
public void Predicate_false_on_active_becomes_inactive_and_emits_Cleared()
{
@@ -36,6 +38,7 @@ public sealed class Part9StateMachineTests
r.State.LastClearedUtc.ShouldNotBeNull();
}
/// <summary>Verifies that predicate changes with unchanged state emit None.</summary>
[Fact]
public void Predicate_unchanged_state_emits_None()
{
@@ -43,6 +46,7 @@ public sealed class Part9StateMachineTests
r.Emission.ShouldBe(EmissionKind.None);
}
/// <summary>Verifies that a disabled alarm ignores predicate changes.</summary>
[Fact]
public void Disabled_alarm_ignores_predicate()
{
@@ -52,6 +56,7 @@ public sealed class Part9StateMachineTests
r.Emission.ShouldBe(EmissionKind.None);
}
/// <summary>Verifies that acknowledging an unacknowledged alarm records the user and emits Acknowledged.</summary>
[Fact]
public void Acknowledge_from_unacked_records_user_and_emits()
{
@@ -64,6 +69,7 @@ public sealed class Part9StateMachineTests
r.Emission.ShouldBe(EmissionKind.Acknowledged);
}
/// <summary>Verifies that acknowledging an already-acknowledged alarm is a no-op.</summary>
[Fact]
public void Acknowledge_when_already_acked_is_noop()
{
@@ -73,6 +79,7 @@ public sealed class Part9StateMachineTests
r.Emission.ShouldBe(EmissionKind.None);
}
/// <summary>Verifies that acknowledging without a user throws ArgumentException.</summary>
[Fact]
public void Acknowledge_without_user_throws()
{
@@ -80,6 +87,7 @@ public sealed class Part9StateMachineTests
Part9StateMachine.ApplyAcknowledge(Fresh(), "", null, T0));
}
/// <summary>Verifies that confirming after clear records the user and emits Confirmed.</summary>
[Fact]
public void Confirm_after_clear_records_user_and_emits()
{
@@ -95,6 +103,7 @@ public sealed class Part9StateMachineTests
r.Emission.ShouldBe(EmissionKind.Confirmed);
}
/// <summary>Verifies that one-shot shelve suppresses the next activation emission.</summary>
[Fact]
public void OneShotShelve_suppresses_next_activation_emission()
{
@@ -104,6 +113,7 @@ public sealed class Part9StateMachineTests
r.Emission.ShouldBe(EmissionKind.Suppressed, "but subscribers don't see it");
}
/// <summary>Verifies that one-shot shelve expires when the alarm clears.</summary>
[Fact]
public void OneShotShelve_expires_on_clear()
{
@@ -114,6 +124,7 @@ public sealed class Part9StateMachineTests
r.State.Shelving.Kind.ShouldBe(ShelvingKind.Unshelved, "OneShot expires on clear");
}
/// <summary>Verifies that timed shelve requires a future unshelve time.</summary>
[Fact]
public void TimedShelve_requires_future_unshelve_time()
{
@@ -121,6 +132,7 @@ public sealed class Part9StateMachineTests
Part9StateMachine.ApplyTimedShelve(Fresh(), "alice", T0, T0.AddSeconds(5)));
}
/// <summary>Verifies that timed shelve expires via shelving check at the specified time.</summary>
[Fact]
public void TimedShelve_expires_via_shelving_check()
{
@@ -140,6 +152,7 @@ public sealed class Part9StateMachineTests
after.State.Comments.Any(c => c.Kind == "AutoUnshelve").ShouldBeTrue();
}
/// <summary>Verifies that unshelving an unshelved alarm is a no-op.</summary>
[Fact]
public void Unshelve_from_unshelved_is_noop()
{
@@ -147,6 +160,7 @@ public sealed class Part9StateMachineTests
r.Emission.ShouldBe(EmissionKind.None);
}
/// <summary>Verifies that explicit unshelve emits an Unshelved event.</summary>
[Fact]
public void Explicit_Unshelve_emits_event()
{
@@ -156,6 +170,7 @@ public sealed class Part9StateMachineTests
r.Emission.ShouldBe(EmissionKind.Unshelved);
}
/// <summary>Verifies that adding a comment appends to the audit trail and emits CommentAdded.</summary>
[Fact]
public void AddComment_appends_to_audit_trail_with_event()
{
@@ -167,6 +182,7 @@ public sealed class Part9StateMachineTests
r.Emission.ShouldBe(EmissionKind.CommentAdded);
}
/// <summary>Verifies that comments are append-only and never rewritten.</summary>
[Fact]
public void Comments_are_append_only_never_rewritten()
{
@@ -179,6 +195,7 @@ public sealed class Part9StateMachineTests
s.Comments[2].User.ShouldBe("carol");
}
/// <summary>Verifies that a full alarm lifecycle walk produces all expected emissions.</summary>
[Fact]
public void Full_lifecycle_walk_produces_every_expected_emission()
{