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,11 +18,17 @@ public sealed class AdminOperationsClient : IAdminOperationsClient
private readonly IActorRef _proxy;
/// <summary>Initializes a new instance of the AdminOperationsClient.</summary>
/// <param name="registry">The actor registry to resolve the admin operations singleton proxy.</param>
public AdminOperationsClient(ActorRegistry registry)
{
_proxy = registry.Get<AdminOperationsActorKey>();
}
/// <summary>Starts a deployment via the admin operations actor.</summary>
/// <param name="createdBy">The username of who initiated the deployment.</param>
/// <param name="ct">The cancellation token.</param>
/// <returns>The deployment start result.</returns>
public async Task<StartDeploymentResult> StartDeploymentAsync(string createdBy, CancellationToken ct)
{
var msg = new StartDeployment(createdBy, CorrelationId.NewId());
@@ -22,12 +22,19 @@ public sealed class FleetDiagnosticsClient : IFleetDiagnosticsClient
private readonly ActorSystem _system;
private readonly string _systemName;
/// <summary>Initializes a new FleetDiagnosticsClient with the given actor system and cluster options.</summary>
/// <param name="system">The Akka actor system.</param>
/// <param name="options">Cluster configuration options.</param>
public FleetDiagnosticsClient(ActorSystem system, IOptions<AkkaClusterOptions> options)
{
_system = system;
_systemName = options.Value.SystemName;
}
/// <summary>Gets diagnostics for a cluster node.</summary>
/// <param name="nodeId">The node identifier to query.</param>
/// <param name="ct">Cancellation token.</param>
/// <returns>Diagnostics snapshot for the node, or an empty snapshot if the query fails.</returns>
public async Task<NodeDiagnosticsSnapshot> GetDiagnosticsAsync(NodeId nodeId, CancellationToken ct)
{
var selection = _system.ActorSelection($"akka.tcp://{_systemName}@{nodeId.Value}/user/driver-host");
@@ -3,8 +3,13 @@ using ZB.MOM.WW.OtOpcUa.Commons.Interfaces;
namespace ZB.MOM.WW.OtOpcUa.AdminUI.Clients;
/// <summary>Service collection extensions for Admin UI client registration.</summary>
public static class ServiceCollectionExtensions
{
/// <summary>
/// Registers the Admin UI client services in the dependency injection container.
/// </summary>
/// <param name="services">The service collection to register clients into.</param>
public static IServiceCollection AddOtOpcUaAdminClients(this IServiceCollection services)
{
services.AddScoped<IAdminOperationsClient, AdminOperationsClient>();