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
@@ -12,6 +12,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
{
private readonly OtOpcUaConfigDbContext _db;
/// <summary>Initializes a new instance of the LdapGroupRoleMappingServiceTests class.</summary>
public LdapGroupRoleMappingServiceTests()
{
var options = new DbContextOptionsBuilder<OtOpcUaConfigDbContext>()
@@ -20,6 +21,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
_db = new OtOpcUaConfigDbContext(options);
}
/// <summary>Disposes the database context.</summary>
public void Dispose() => _db.Dispose();
private LdapGroupRoleMapping Make(string group, AdminRole role, string? clusterId = null, bool? isSystemWide = null) =>
@@ -31,6 +33,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
IsSystemWide = isSystemWide ?? (clusterId is null),
};
/// <summary>Verifies that Create sets Id and CreatedAtUtc.</summary>
[Fact]
public async Task Create_SetsId_AndCreatedAtUtc()
{
@@ -43,6 +46,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
saved.CreatedAtUtc.ShouldBeGreaterThan(DateTime.UtcNow.AddMinutes(-1));
}
/// <summary>Verifies that Create rejects empty LDAP group.</summary>
[Fact]
public async Task Create_Rejects_EmptyLdapGroup()
{
@@ -53,6 +57,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
() => svc.CreateAsync(row, CancellationToken.None));
}
/// <summary>Verifies that Create rejects system-wide mapping with ClusterId.</summary>
[Fact]
public async Task Create_Rejects_SystemWide_With_ClusterId()
{
@@ -63,6 +68,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
() => svc.CreateAsync(row, CancellationToken.None));
}
/// <summary>Verifies that Create rejects non-system-wide mapping without ClusterId.</summary>
[Fact]
public async Task Create_Rejects_NonSystemWide_WithoutClusterId()
{
@@ -73,6 +79,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
() => svc.CreateAsync(row, CancellationToken.None));
}
/// <summary>Verifies that GetByGroups returns only matching grants.</summary>
[Fact]
public async Task GetByGroups_Returns_MatchingGrants_Only()
{
@@ -88,6 +95,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
results.Select(r => r.Role).ShouldBe([AdminRole.FleetAdmin, AdminRole.ConfigViewer], ignoreOrder: true);
}
/// <summary>Verifies that GetByGroups returns empty when input is empty.</summary>
[Fact]
public async Task GetByGroups_Empty_Input_ReturnsEmpty()
{
@@ -99,6 +107,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
results.ShouldBeEmpty();
}
/// <summary>Verifies that ListAll orders results by group then cluster.</summary>
[Fact]
public async Task ListAll_Orders_ByGroupThenCluster()
{
@@ -115,6 +124,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
results[2].LdapGroup.ShouldBe("cn=b,dc=x");
}
/// <summary>Verifies that Delete removes the matching row.</summary>
[Fact]
public async Task Delete_Removes_Matching_Row()
{
@@ -127,6 +137,7 @@ public sealed class LdapGroupRoleMappingServiceTests : IDisposable
after.ShouldBeEmpty();
}
/// <summary>Verifies that Delete with unknown Id is a no-op.</summary>
[Fact]
public async Task Delete_Unknown_Id_IsNoOp()
{