docs: backfill XML documentation across 756 files

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.
2026-05-28 08:10:17 -04:00
parent f9fc7dd2e1
commit 64e3fbe035
756 changed files with 9876 additions and 96 deletions
@@ -44,6 +44,9 @@ public partial class AlarmsViewModel : ObservableObject

    [ObservableProperty] private int _activeAlarmCount;

+    /// <summary>Initializes a new instance of the AlarmsViewModel class.</summary>
+    /// <param name="service">The OPC UA client service.</param>
+    /// <param name="dispatcher">The UI dispatcher for thread-safe operations.</param>
    public AlarmsViewModel(IOpcUaClientService service, IUiDispatcher dispatcher)
    {
        _service = service;
@@ -168,6 +171,9 @@ public partial class AlarmsViewModel : ObservableObject
    /// <summary>
    ///     Acknowledges an alarm and returns (success, message).
    /// </summary>
+    /// <param name="alarm">The alarm event to acknowledge.</param>
+    /// <param name="comment">Optional comment for the acknowledgment.</param>
+    /// <returns>A tuple with success flag and message.</returns>
    public async Task<(bool Success, string Message)> AcknowledgeAlarmAsync(AlarmEventViewModel alarm, string comment)
    {
        if (!IsConnected || alarm.EventId == null || alarm.ConditionNodeId == null)
@@ -197,6 +203,8 @@ public partial class AlarmsViewModel : ObservableObject
    /// <summary>
    ///     Restores an alarm subscription and requests a condition refresh.
    /// </summary>
+    /// <param name="sourceNodeId">The source node ID to restore the subscription for.</param>
+    /// <returns>A task that completes when the restore operation finishes.</returns>
    public async Task RestoreAlarmSubscriptionAsync(string? sourceNodeId)
    {
        if (!IsConnected || string.IsNullOrWhiteSpace(sourceNodeId)) return;
@@ -13,6 +13,11 @@ public class BrowseTreeViewModel : ObservableObject
    private readonly IUiDispatcher _dispatcher;
    private readonly IOpcUaClientService _service;

+    /// <summary>
+    /// Initializes a new instance of the <see cref="BrowseTreeViewModel"/> class.
+    /// </summary>
+    /// <param name="service">The OPC UA client service.</param>
+    /// <param name="dispatcher">The UI dispatcher for marshaling updates.</param>
    public BrowseTreeViewModel(IOpcUaClientService service, IUiDispatcher dispatcher)
    {
        _service = service;
@@ -7,6 +7,11 @@ namespace ZB.MOM.WW.OtOpcUa.Client.UI.ViewModels;
 /// </summary>
 public class HistoryValueViewModel : ObservableObject
 {
+    /// <summary>Initializes a new instance of the <see cref="HistoryValueViewModel"/> class.</summary>
+    /// <param name="value">The historical value.</param>
+    /// <param name="status">The status code or text.</param>
+    /// <param name="sourceTimestamp">The source timestamp in string format.</param>
+    /// <param name="serverTimestamp">The server timestamp in string format.</param>
    public HistoryValueViewModel(string value, string status, string sourceTimestamp, string serverTimestamp)
    {
        Value = value;
@@ -15,8 +20,12 @@ public class HistoryValueViewModel : ObservableObject
        ServerTimestamp = serverTimestamp;
    }

+    /// <summary>Gets the historical value.</summary>
    public string Value { get; }
+    /// <summary>Gets the status code or text.</summary>
    public string Status { get; }
+    /// <summary>Gets the source timestamp in string format.</summary>
    public string SourceTimestamp { get; }
+    /// <summary>Gets the server timestamp in string format.</summary>
    public string ServerTimestamp { get; }
 }
@@ -34,6 +34,9 @@ public partial class HistoryViewModel : ObservableObject

    [ObservableProperty] private DateTimeOffset? _startTime = DateTimeOffset.UtcNow.AddHours(-1);

+    /// <summary>Initializes a new instance of the HistoryViewModel.</summary>
+    /// <param name="service">The OPC UA client service.</param>
+    /// <param name="dispatcher">The UI dispatcher for thread marshalling.</param>
    public HistoryViewModel(IOpcUaClientService service, IUiDispatcher dispatcher)
    {
        _service = service;
@@ -53,6 +56,7 @@ public partial class HistoryViewModel : ObservableObject
        AggregateType.StandardDeviation
    ];

+    /// <summary>Gets a value indicating whether an aggregate read is selected.</summary>
    public bool IsAggregateRead => SelectedAggregateType != null;

    /// <summary>History read results.</summary>
@@ -36,12 +36,16 @@ public partial class ReadWriteViewModel : ObservableObject

    [ObservableProperty] private string? _writeValue;

+    /// <summary>Initializes a new instance of the ReadWriteViewModel class.</summary>
+    /// <param name="service">The OPC UA client service for read/write operations.</param>
+    /// <param name="dispatcher">The UI dispatcher for posting updates to the UI thread.</param>
    public ReadWriteViewModel(IOpcUaClientService service, IUiDispatcher dispatcher)
    {
        _service = service;
        _dispatcher = dispatcher;
    }

+    /// <summary>Gets a value indicating whether a node is currently selected.</summary>
    public bool IsNodeSelected => !string.IsNullOrEmpty(SelectedNodeId);

    partial void OnSelectedNodeIdChanged(string? value)
@@ -13,6 +13,9 @@ public partial class SubscriptionItemViewModel : ObservableObject

    [ObservableProperty] private string? _value;

+    /// <summary>Initializes a new subscription item with the specified node ID and interval.</summary>
+    /// <param name="nodeId">The OPC UA NodeId to subscribe to.</param>
+    /// <param name="intervalMs">The subscription interval in milliseconds.</param>
    public SubscriptionItemViewModel(string nodeId, int intervalMs)
    {
        NodeId = nodeId;
@@ -31,6 +31,13 @@ public partial class TreeNodeViewModel : ObservableObject
        HasChildren = false;
    }

+    /// <summary>Initializes a new tree node view model.</summary>
+    /// <param name="nodeId">The OPC UA node identifier.</param>
+    /// <param name="displayName">The display name for this node.</param>
+    /// <param name="nodeClass">The OPC UA node class.</param>
+    /// <param name="hasChildren">Whether this node has child nodes.</param>
+    /// <param name="service">The OPC UA client service for browsing.</param>
+    /// <param name="dispatcher">The UI dispatcher for thread-safe updates.</param>
    public TreeNodeViewModel(
        string nodeId,
        string displayName,