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
@@ -16,8 +16,11 @@ public sealed class SchemaComplianceTests
{
private readonly SchemaComplianceFixture _fixture;
/// <summary>Initializes a new instance of the <see cref="SchemaComplianceTests"/> class.</summary>
/// <param name="fixture">The database schema compliance fixture.</param>
public SchemaComplianceTests(SchemaComplianceFixture fixture) => _fixture = fixture;
/// <summary>Verifies that all expected tables exist in the schema.</summary>
[Fact]
public void All_expected_tables_exist()
{
@@ -47,6 +50,7 @@ SELECT name FROM sys.tables WHERE name <> '__EFMigrationsHistory' ORDER BY name;
actual.Count.ShouldBe(expected.Length);
}
/// <summary>Verifies that filtered unique indexes match the schema specification.</summary>
[Fact]
public void Filtered_unique_indexes_match_schema_spec()
{
@@ -73,6 +77,7 @@ WHERE i.is_unique = 1 AND i.has_filter = 1;",
}
}
/// <summary>Verifies that check constraints match the schema specification.</summary>
[Fact]
public void Check_constraints_match_schema_spec()
{
@@ -94,6 +99,7 @@ WHERE i.is_unique = 1 AND i.has_filter = 1;",
actual.ShouldContain(ck, $"missing CHECK constraint: {ck}");
}
/// <summary>Verifies that JSON check constraints use the ISJSON function.</summary>
[Fact]
public void Json_check_constraints_use_IsJson_function()
{
@@ -110,6 +116,7 @@ WHERE cc.name LIKE 'CK_%_IsJson';",
$"{name} definition does not call ISJSON: {definition}");
}
/// <summary>Verifies that the Deployment Status column exists.</summary>
[Fact]
public void Deployment_Status_column_exists()
{
@@ -125,6 +132,7 @@ WHERE c.TABLE_NAME = 'Deployment' AND c.COLUMN_NAME = 'Status';",
rows.Count.ShouldBe(1);
}
/// <summary>Verifies that Equipment carries OPC 4.0 10 identity fields.</summary>
[Fact]
public void Equipment_carries_Opc40010_identity_fields()
{
@@ -140,6 +148,7 @@ SELECT COLUMN_NAME FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = 'Equipment
columns.ShouldContain(col, $"Equipment missing expected column: {col}");
}
/// <summary>Verifies that Namespace has at least one unique index.</summary>
[Fact]
public void Namespace_has_some_unique_index()
{