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
@@ -7,21 +7,27 @@ namespace ZB.MOM.WW.OtOpcUa.Configuration.Entities;
/// </summary>
public sealed class ConfigEdit
{
/// <summary>Gets the unique identifier for this edit.</summary>
public Guid EditId { get; init; } = Guid.NewGuid();
/// <summary>Gets the type of entity that was edited.</summary>
public required string EntityType { get; init; }
/// <summary>Gets the identifier of the entity that was edited.</summary>
public Guid EntityId { get; init; }
/// <summary>JSON payload of the column-name → new-value pairs touched by this edit.</summary>
/// <summary>Gets the JSON payload of the column-name → new-value pairs touched by this edit.</summary>
public required string FieldsJson { get; init; }
/// <summary>Optional correlation across edits inside a single admin operation.</summary>
/// <summary>Gets the optional correlation identifier across edits inside a single admin operation.</summary>
public Guid? ExecutionId { get; init; }
/// <summary>Gets the username of the user who performed the edit.</summary>
public required string EditedBy { get; init; }
/// <summary>Gets the UTC timestamp when the edit was performed.</summary>
public DateTime EditedAtUtc { get; init; } = DateTime.UtcNow;
/// <summary>Gets the node identifier of the admin instance that performed the edit.</summary>
public required string SourceNode { get; init; }
}