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
@@ -13,12 +13,19 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Scripting.Tests;
/// </summary>
public sealed class FakeScriptContext : ScriptContext
{
/// <summary>Gets the dictionary of tags available in this context.</summary>
public Dictionary<string, DataValueSnapshot> Tags { get; } = new(StringComparer.Ordinal);
/// <summary>Gets the log of virtual tag write operations.</summary>
public List<(string Path, object? Value)> Writes { get; } = [];
/// <inheritdoc />
public override DateTime Now { get; } = new DateTime(2026, 1, 1, 12, 0, 0, DateTimeKind.Utc);
/// <inheritdoc />
public override ILogger Logger { get; } = new LoggerConfiguration().CreateLogger();
/// <inheritdoc />
public override DataValueSnapshot GetTag(string path)
{
return Tags.TryGetValue(path, out var v)
@@ -26,11 +33,18 @@ public sealed class FakeScriptContext : ScriptContext
: new DataValueSnapshot(null, 0x80340000u, null, Now); // BadNodeIdUnknown
}
/// <inheritdoc />
public override void SetVirtualTag(string path, object? value)
{
Writes.Add((path, value));
}
/// <summary>Seeds the context with a tag value for testing.</summary>
/// <param name="path">The tag path.</param>
/// <param name="value">The tag value.</param>
/// <param name="statusCode">The OPC UA status code (default: 0).</param>
/// <param name="sourceTs">The source timestamp (default: <see cref="Now"/>).</param>
/// <returns>This instance for method chaining.</returns>
public FakeScriptContext Seed(string path, object? value,
uint statusCode = 0u, DateTime? sourceTs = null)
{