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
@@ -23,6 +23,9 @@ public static class GalaxyDriverFactoryExtensions
{
public const string DriverTypeName = "GalaxyMxGateway";
/// <summary>Registers the Galaxy driver factory with the given registry and optional logger factory.</summary>
/// <param name="registry">The driver factory registry to register with.</param>
/// <param name="loggerFactory">The optional logger factory for creating drivers.</param>
public static void Register(DriverFactoryRegistry registry, ILoggerFactory? loggerFactory = null)
{
ArgumentNullException.ThrowIfNull(registry);
@@ -30,9 +33,15 @@ public static class GalaxyDriverFactoryExtensions
}
/// <summary>Convenience for tests + standalone callers.</summary>
/// <param name="driverInstanceId">The unique identifier for the driver instance.</param>
/// <param name="driverConfigJson">The driver configuration in JSON format.</param>
public static GalaxyDriver CreateInstance(string driverInstanceId, string driverConfigJson)
=> CreateInstance(driverInstanceId, driverConfigJson, loggerFactory: null);
/// <summary>Creates a Galaxy driver instance from configuration JSON with optional logger factory.</summary>
/// <param name="driverInstanceId">The unique identifier for the driver instance.</param>
/// <param name="driverConfigJson">The driver configuration in JSON format.</param>
/// <param name="loggerFactory">The optional logger factory for creating drivers.</param>
public static GalaxyDriver CreateInstance(
string driverInstanceId, string driverConfigJson, ILoggerFactory? loggerFactory)
{
@@ -81,43 +90,68 @@ public static class GalaxyDriverFactoryExtensions
AllowTrailingCommas = true,
};
/// <summary>Data transfer object for Galaxy driver configuration JSON.</summary>
internal sealed class GalaxyDriverConfigDto
{
/// <summary>Gets or sets the gateway configuration.</summary>
public GatewayDto? Gateway { get; init; }
/// <summary>Gets or sets the MX Access configuration.</summary>
public MxAccessDto? MxAccess { get; init; }
/// <summary>Gets or sets the repository configuration.</summary>
public RepositoryDto? Repository { get; init; }
/// <summary>Gets or sets the reconnect configuration.</summary>
public ReconnectDto? Reconnect { get; init; }
}
/// <summary>Gateway configuration section.</summary>
internal sealed class GatewayDto
{
/// <summary>Gets or sets the gateway endpoint address.</summary>
public string? Endpoint { get; init; }
/// <summary>Gets or sets the API key secret reference.</summary>
public string? ApiKeySecretRef { get; init; }
/// <summary>Gets or sets whether to use TLS.</summary>
public bool? UseTls { get; init; }
/// <summary>Gets or sets the CA certificate path.</summary>
public string? CaCertificatePath { get; init; }
/// <summary>Gets or sets the connection timeout in seconds.</summary>
public int? ConnectTimeoutSeconds { get; init; }
/// <summary>Gets or sets the default call timeout in seconds.</summary>
public int? DefaultCallTimeoutSeconds { get; init; }
/// <summary>Gets or sets the stream timeout in seconds.</summary>
public int? StreamTimeoutSeconds { get; init; }
}
/// <summary>MX Access configuration section.</summary>
internal sealed class MxAccessDto
{
/// <summary>Gets or sets the client name.</summary>
public string? ClientName { get; init; }
/// <summary>Gets or sets the publishing interval in milliseconds.</summary>
public int? PublishingIntervalMs { get; init; }
/// <summary>Gets or sets the write user ID.</summary>
public int? WriteUserId { get; init; }
/// <summary>Gets or sets the event pump channel capacity.</summary>
public int? EventPumpChannelCapacity { get; init; }
}
/// <summary>Repository configuration section.</summary>
internal sealed class RepositoryDto
{
/// <summary>Gets or sets the discover page size.</summary>
public int? DiscoverPageSize { get; init; }
/// <summary>Gets or sets whether to watch deploy events.</summary>
public bool? WatchDeployEvents { get; init; }
}
/// <summary>Reconnect configuration section.</summary>
internal sealed class ReconnectDto
{
/// <summary>Gets or sets the initial backoff in milliseconds.</summary>
public int? InitialBackoffMs { get; init; }
/// <summary>Gets or sets the maximum backoff in milliseconds.</summary>
public int? MaxBackoffMs { get; init; }
/// <summary>Gets or sets whether to replay on session lost.</summary>
public bool? ReplayOnSessionLost { get; init; }
}
}