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,6 +7,7 @@ namespace ZB.MOM.WW.OtOpcUa.Configuration.Entities;
/// </summary>
public sealed class Equipment
{
/// <summary>Gets or sets the row identifier for this equipment.</summary>
public Guid EquipmentRowId { get; set; }
/// <summary>
@@ -43,19 +44,29 @@ public sealed class Equipment
// OPC UA Companion Spec OPC 40010 Machinery Identification fields (decision #139).
// All nullable so equipment can be added before identity is fully captured.
/// <summary>Gets or sets the manufacturer name for this equipment.</summary>
public string? Manufacturer { get; set; }
/// <summary>Gets or sets the model number or designation for this equipment.</summary>
public string? Model { get; set; }
/// <summary>Gets or sets the serial number for this equipment.</summary>
public string? SerialNumber { get; set; }
/// <summary>Gets or sets the hardware revision level for this equipment.</summary>
public string? HardwareRevision { get; set; }
/// <summary>Gets or sets the software revision level for this equipment.</summary>
public string? SoftwareRevision { get; set; }
/// <summary>Gets or sets the year of construction for this equipment.</summary>
public short? YearOfConstruction { get; set; }
/// <summary>Gets or sets the asset location information for this equipment.</summary>
public string? AssetLocation { get; set; }
/// <summary>Gets or sets the manufacturer URI for this equipment.</summary>
public string? ManufacturerUri { get; set; }
/// <summary>Gets or sets the device manual URI for this equipment.</summary>
public string? DeviceManualUri { get; set; }
/// <summary>Nullable hook for future schemas-repo template ID (decision #112).</summary>
public string? EquipmentClassRef { get; set; }
/// <summary>Gets or sets whether this equipment is enabled.</summary>
public bool Enabled { get; set; } = true;
/// <summary>Optimistic concurrency token for last-write-wins detection in the v2 live-edit model.</summary>