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
@@ -28,6 +28,7 @@ public sealed class Phase7ScriptingEntitiesTests
private static Microsoft.EntityFrameworkCore.Metadata.IModel DesignModel(OtOpcUaConfigDbContext ctx)
=> ctx.GetService<IDesignTimeModel>().Model;
/// <summary>Verifies that the Script entity is registered with the expected table name and columns.</summary>
[Fact]
public void Script_entity_registered_with_expected_table_and_columns()
{
@@ -46,6 +47,7 @@ public sealed class Phase7ScriptingEntitiesTests
.GetMaxLength().ShouldBe(16);
}
/// <summary>Verifies that the Script entity has a unique logical ID constraint.</summary>
[Fact]
public void Script_has_unique_logical_id()
{
@@ -55,6 +57,7 @@ public sealed class Phase7ScriptingEntitiesTests
entity.GetIndexes().Any(i => i.IsUnique).ShouldBeTrue("Script needs at least one unique index");
}
/// <summary>Verifies that the VirtualTag entity is registered with the expected trigger check constraint.</summary>
[Fact]
public void VirtualTag_entity_registered_with_trigger_check_constraint()
{
@@ -67,6 +70,7 @@ public sealed class Phase7ScriptingEntitiesTests
checks.ShouldContain("CK_VirtualTag_TimerInterval_Min");
}
/// <summary>Verifies that the VirtualTag entity has a unique index on its logical key.</summary>
[Fact]
public void VirtualTag_has_unique_index_on_logical_key()
{
@@ -76,6 +80,7 @@ public sealed class Phase7ScriptingEntitiesTests
entity.GetIndexes().Any(i => i.IsUnique).ShouldBeTrue("VirtualTag needs at least one unique index");
}
/// <summary>Verifies that the VirtualTag entity has ChangeTriggered, Historize, and TimerIntervalMs properties.</summary>
[Fact]
public void VirtualTag_has_ChangeTriggered_and_Historize_flags()
{
@@ -89,6 +94,7 @@ public sealed class Phase7ScriptingEntitiesTests
.ClrType.ShouldBe(typeof(int?));
}
/// <summary>Verifies that the ScriptedAlarm entity is registered with severity and type check constraints.</summary>
[Fact]
public void ScriptedAlarm_entity_registered_with_severity_and_type_checks()
{
@@ -101,6 +107,7 @@ public sealed class Phase7ScriptingEntitiesTests
checks.ShouldContain("CK_ScriptedAlarm_AlarmType");
}
/// <summary>Verifies that ScriptedAlarm has HistorizeToAveva defaulted to true per plan decision 15.</summary>
[Fact]
public void ScriptedAlarm_has_HistorizeToAveva_default_true_per_plan_decision_15()
{
@@ -120,6 +127,7 @@ public sealed class Phase7ScriptingEntitiesTests
alarm.Enabled.ShouldBeTrue();
}
/// <summary>Verifies that ScriptedAlarmState is keyed on ScriptedAlarmId and not generation-scoped.</summary>
[Fact]
public void ScriptedAlarmState_keyed_on_ScriptedAlarmId_not_generation_scoped()
{
@@ -136,6 +144,7 @@ public sealed class Phase7ScriptingEntitiesTests
"ack state follows alarm identity across generations");
}
/// <summary>Verifies that ScriptedAlarmState default values match Part 9 initial states.</summary>
[Fact]
public void ScriptedAlarmState_default_state_values_match_Part9_initial_states()
{
@@ -152,6 +161,7 @@ public sealed class Phase7ScriptingEntitiesTests
state.LastAckUtc.ShouldBeNull();
}
/// <summary>Verifies that ScriptedAlarmState has a JSON check constraint on CommentsJson.</summary>
[Fact]
public void ScriptedAlarmState_has_JSON_check_constraint_on_CommentsJson()
{
@@ -161,6 +171,7 @@ public sealed class Phase7ScriptingEntitiesTests
checks.ShouldContain("CK_ScriptedAlarmState_CommentsJson_IsJson");
}
/// <summary>Verifies that all new Phase 7 entities are exposed via DbSet properties.</summary>
[Fact]
public void All_new_entities_exposed_via_DbSet()
{
@@ -171,6 +182,7 @@ public sealed class Phase7ScriptingEntitiesTests
ctx.ScriptedAlarmStates.ShouldNotBeNull();
}
/// <summary>Verifies that the AddPhase7ScriptingTables migration exists in the assembly.</summary>
[Fact]
public void AddPhase7ScriptingTables_migration_exists_in_assembly()
{