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
@@ -44,11 +44,16 @@ public sealed class TimedScriptEvaluator<TContext, TResult>
/// <summary>Wall-clock budget per evaluation. Script exceeding this throws <see cref="ScriptTimeoutException"/>.</summary>
public TimeSpan Timeout { get; }
/// <summary>Initializes a new instance of the TimedScriptEvaluator class with the default timeout.</summary>
/// <param name="inner">The inner script evaluator.</param>
public TimedScriptEvaluator(ScriptEvaluator<TContext, TResult> inner)
: this(inner, DefaultTimeout)
{
}
/// <summary>Initializes a new instance of the TimedScriptEvaluator class with a custom timeout.</summary>
/// <param name="inner">The inner script evaluator.</param>
/// <param name="timeout">The evaluation timeout duration.</param>
public TimedScriptEvaluator(ScriptEvaluator<TContext, TResult> inner, TimeSpan timeout)
{
_inner = inner ?? throw new ArgumentNullException(nameof(inner));
@@ -57,6 +62,10 @@ public sealed class TimedScriptEvaluator<TContext, TResult>
Timeout = timeout;
}
/// <summary>Runs the script evaluation with the configured timeout.</summary>
/// <param name="context">The script context.</param>
/// <param name="ct">The cancellation token.</param>
/// <returns>The evaluation result.</returns>
public async Task<TResult> RunAsync(TContext context, CancellationToken ct = default)
{
if (context is null) throw new ArgumentNullException(nameof(context));
@@ -97,8 +106,11 @@ public sealed class TimedScriptEvaluator<TContext, TResult>
/// </summary>
public sealed class ScriptTimeoutException : Exception
{
/// <summary>Gets the timeout duration that was exceeded.</summary>
public TimeSpan Timeout { get; }
/// <summary>Initializes a new instance of the ScriptTimeoutException class.</summary>
/// <param name="timeout">The timeout duration that was exceeded.</param>
public ScriptTimeoutException(TimeSpan timeout)
: base($"Script evaluation exceeded the configured timeout of {timeout.TotalMilliseconds:F1} ms. " +
"The script was either CPU-bound or blocked on a slow operation; check ctx.Logger output " +