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
@@ -6,21 +6,28 @@ namespace ZB.MOM.WW.OtOpcUa.Configuration.Entities;
/// </summary>
public sealed class ConfigAuditLog
{
/// <summary>Gets or sets the unique audit log identifier.</summary>
public long AuditId { get; set; }
/// <summary>Gets or sets the timestamp of the audit event.</summary>
public DateTime Timestamp { get; set; } = DateTime.UtcNow;
/// <summary>Gets or sets the principal (user or service) that initiated the event.</summary>
public required string Principal { get; set; }
/// <summary>DraftCreated | DraftEdited | Published | RolledBack | NodeApplied | CredentialAdded | CredentialDisabled | ClusterCreated | NodeAdded | ExternalIdReleased | CrossClusterNamespaceAttempt | OpcUaAccessDenied | …</summary>
public required string EventType { get; set; }
/// <summary>Gets or sets the cluster identifier associated with the event, if applicable.</summary>
public string? ClusterId { get; set; }
/// <summary>Gets or sets the node identifier associated with the event, if applicable.</summary>
public string? NodeId { get; set; }
/// <summary>Gets or sets the generation identifier associated with the event, if applicable.</summary>
public long? GenerationId { get; set; }
/// <summary>Gets or sets additional event details in JSON format.</summary>
public string? DetailsJson { get; set; }
/// <summary>