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
@@ -64,6 +64,8 @@ public sealed class ScriptEvaluator<TContext, TResult> : IDisposable
_func = func;
}
/// <summary>Compiles user script source into an evaluator.</summary>
/// <param name="scriptSource">The user script source code to compile.</param>
public static ScriptEvaluator<TContext, TResult> Compile(string scriptSource)
{
if (scriptSource is null) throw new ArgumentNullException(nameof(scriptSource));
@@ -168,7 +170,9 @@ public sealed class ScriptEvaluator<TContext, TResult> : IDisposable
return new ScriptEvaluator<TContext, TResult>(alc, func);
}
/// <summary>Run against an already-constructed context.</summary>
/// <summary>Runs the script against an already-constructed context.</summary>
/// <param name="context">The script context.</param>
/// <param name="ct">Cancellation token for the operation.</param>
public Task<TResult> RunAsync(TContext context, CancellationToken ct = default)
{
if (_disposed) throw new ObjectDisposedException(nameof(ScriptEvaluator<TContext, TResult>));
@@ -384,10 +388,13 @@ public sealed class ScriptEvaluator<TContext, TResult> : IDisposable
/// </summary>
internal sealed class ScriptAssemblyLoadContext : AssemblyLoadContext
{
/// <summary>Initializes a new instance of the <see cref="ScriptAssemblyLoadContext"/> class.</summary>
/// <param name="name">The name of the assembly load context.</param>
public ScriptAssemblyLoadContext(string name) : base(name, isCollectible: true)
{
}
/// <inheritdoc />
protected override Assembly? Load(AssemblyName assemblyName) => null;
}
@@ -400,8 +407,11 @@ internal sealed class ScriptAssemblyLoadContext : AssemblyLoadContext
/// </summary>
public sealed class CompilationErrorException : Exception
{
/// <summary>Gets the compilation diagnostics that caused the error.</summary>
public IReadOnlyList<Diagnostic> Diagnostics { get; }
/// <summary>Initializes a new instance of the <see cref="CompilationErrorException"/> class.</summary>
/// <param name="diagnostics">The compilation diagnostics that caused the error.</param>
public CompilationErrorException(IReadOnlyList<Diagnostic> diagnostics)
: base(BuildMessage(diagnostics))
{