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.

tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Tests/FakeFocasClient.cs

@@ -4,20 +4,36 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Tests;
 
 internal class FakeFocasClient : IFocasClient
 {
+    /// <summary>Gets a value indicating whether the client is connected.</summary>
     public bool IsConnected { get; private set; }
+    /// <summary>Gets the count of connection attempts.</summary>
     public int ConnectCount { get; private set; }
+    /// <summary>Gets the count of dispose operations.</summary>
     public int DisposeCount { get; private set; }
+    /// <summary>Gets or sets a value indicating whether to throw on connect.</summary>
     public bool ThrowOnConnect { get; set; }
+    /// <summary>Gets or sets a value indicating whether to throw on read.</summary>
     public bool ThrowOnRead { get; set; }
+    /// <summary>Gets or sets a value indicating whether to throw on write.</summary>
     public bool ThrowOnWrite { get; set; }
+    /// <summary>Gets or sets the result of probe operations.</summary>
     public bool ProbeResult { get; set; } = true;
+    /// <summary>Gets or sets the exception to throw.</summary>
     public Exception? Exception { get; set; }
 
+    /// <summary>Gets the dictionary of read values keyed by address.</summary>
     public Dictionary<string, object?> Values { get; } = new(StringComparer.OrdinalIgnoreCase);
+    /// <summary>Gets the dictionary of read statuses keyed by address.</summary>
     public Dictionary<string, uint> ReadStatuses { get; } = new(StringComparer.OrdinalIgnoreCase);
+    /// <summary>Gets the dictionary of write statuses keyed by address.</summary>
     public Dictionary<string, uint> WriteStatuses { get; } = new(StringComparer.OrdinalIgnoreCase);
+    /// <summary>Gets the log of write operations.</summary>
     public List<(FocasAddress addr, FocasDataType type, object? value)> WriteLog { get; } = new();
 
+    /// <summary>Connects to a FOCAS host asynchronously.</summary>
+    /// <param name="address">The FOCAS host address.</param>
+    /// <param name="timeout">The connection timeout duration.</param>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task ConnectAsync(FocasHostAddress address, TimeSpan timeout, CancellationToken ct)
     {
         ConnectCount++;
@@ -26,6 +42,10 @@ internal class FakeFocasClient : IFocasClient
         return Task.CompletedTask;
     }
 
+    /// <summary>Reads a value from a FOCAS address asynchronously.</summary>
+    /// <param name="address">The FOCAS address to read from.</param>
+    /// <param name="type">The data type of the value.</param>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<(object? value, uint status)> ReadAsync(
         FocasAddress address, FocasDataType type, CancellationToken ct)
     {
@@ -36,6 +56,11 @@ internal class FakeFocasClient : IFocasClient
         return Task.FromResult((value, status));
     }
 
+    /// <summary>Writes a value to a FOCAS address asynchronously.</summary>
+    /// <param name="address">The FOCAS address to write to.</param>
+    /// <param name="type">The data type of the value.</param>
+    /// <param name="value">The value to write.</param>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<uint> WriteAsync(
         FocasAddress address, FocasDataType type, object? value, CancellationToken ct)
     {
@@ -46,24 +71,42 @@ internal class FakeFocasClient : IFocasClient
         return Task.FromResult(status);
     }
 
+    /// <summary>Probes the FOCAS connection asynchronously.</summary>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<bool> ProbeAsync(CancellationToken ct) => Task.FromResult(ProbeResult);
 
+    /// <summary>Gets the list of active alarms.</summary>
     public List<FocasActiveAlarm> Alarms { get; } = [];
 
+    /// <summary>Reads active alarms asynchronously.</summary>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<IReadOnlyList<FocasActiveAlarm>> ReadAlarmsAsync(CancellationToken ct) =>
         Task.FromResult<IReadOnlyList<FocasActiveAlarm>>([.. Alarms]);
 
     // ---- Fixed-tree T1 ----
+    /// <summary>Gets or sets the system information.</summary>
     public FocasSysInfo SysInfo { get; set; } = new(0, 3, "M", "M", "30i", "A1.0", 3);
+    /// <summary>Gets the list of axis names.</summary>
     public List<FocasAxisName> AxisNames { get; } = [new("X", ""), new("Y", ""), new("Z", "")];
+    /// <summary>Gets the list of spindle names.</summary>
     public List<FocasSpindleName> SpindleNames { get; } = [new("S", "1", "", "")];
+    /// <summary>Gets the dictionary of dynamic snapshots keyed by axis index.</summary>
     public Dictionary<int, FocasDynamicSnapshot> DynamicByAxis { get; } = [];
 
+    /// <summary>Gets system information asynchronously.</summary>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<FocasSysInfo> GetSysInfoAsync(CancellationToken ct) => Task.FromResult(SysInfo);
+    /// <summary>Gets axis names asynchronously.</summary>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<IReadOnlyList<FocasAxisName>> GetAxisNamesAsync(CancellationToken ct) =>
         Task.FromResult<IReadOnlyList<FocasAxisName>>([.. AxisNames]);
+    /// <summary>Gets spindle names asynchronously.</summary>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<IReadOnlyList<FocasSpindleName>> GetSpindleNamesAsync(CancellationToken ct) =>
         Task.FromResult<IReadOnlyList<FocasSpindleName>>([.. SpindleNames]);
+    /// <summary>Reads dynamic data for an axis asynchronously.</summary>
+    /// <param name="axisIndex">The zero-based axis index.</param>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<FocasDynamicSnapshot> ReadDynamicAsync(int axisIndex, CancellationToken ct)
     {
         if (!DynamicByAxis.TryGetValue(axisIndex, out var snap))
@@ -71,11 +114,18 @@ internal class FakeFocasClient : IFocasClient
         return Task.FromResult(snap);
     }
 
+    /// <summary>Gets or sets the program information.</summary>
     public FocasProgramInfo ProgramInfo { get; set; } = new("O0001", 1, 0, 1);
+    /// <summary>Gets program information asynchronously.</summary>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<FocasProgramInfo> GetProgramInfoAsync(CancellationToken ct) =>
         Task.FromResult(ProgramInfo);
 
+    /// <summary>Gets the dictionary of timers keyed by timer kind.</summary>
     public Dictionary<FocasTimerKind, FocasTimer> Timers { get; } = [];
+    /// <summary>Gets timer data asynchronously.</summary>
+    /// <param name="kind">The timer kind to retrieve.</param>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<FocasTimer> GetTimerAsync(FocasTimerKind kind, CancellationToken ct)
     {
         if (!Timers.TryGetValue(kind, out var t))
@@ -83,17 +133,27 @@ internal class FakeFocasClient : IFocasClient
         return Task.FromResult(t);
     }
 
+    /// <summary>Gets the list of servo loads.</summary>
     public List<FocasServoLoad> ServoLoads { get; } = [];
+    /// <summary>Gets servo loads asynchronously.</summary>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<IReadOnlyList<FocasServoLoad>> GetServoLoadsAsync(CancellationToken ct) =>
         Task.FromResult<IReadOnlyList<FocasServoLoad>>([.. ServoLoads]);
 
+    /// <summary>Gets the list of spindle loads.</summary>
     public List<int> SpindleLoads { get; } = [];
+    /// <summary>Gets the list of spindle maximum RPMs.</summary>
     public List<int> SpindleMaxRpms { get; } = [];
+    /// <summary>Gets spindle loads asynchronously.</summary>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<IReadOnlyList<int>> GetSpindleLoadsAsync(CancellationToken ct) =>
         Task.FromResult<IReadOnlyList<int>>([.. SpindleLoads]);
+    /// <summary>Gets spindle maximum RPMs asynchronously.</summary>
+    /// <param name="ct">The cancellation token.</param>
     public virtual Task<IReadOnlyList<int>> GetSpindleMaxRpmsAsync(CancellationToken ct) =>
         Task.FromResult<IReadOnlyList<int>>([.. SpindleMaxRpms]);
 
+    /// <summary>Disposes the client.</summary>
     public virtual void Dispose()
     {
         DisposeCount++;
@@ -101,11 +161,15 @@ internal class FakeFocasClient : IFocasClient
     }
 }
 
+/// <summary>A factory for creating fake FOCAS clients.</summary>
 internal sealed class FakeFocasClientFactory : IFocasClientFactory
 {
+    /// <summary>Gets the list of created clients.</summary>
     public List<FakeFocasClient> Clients { get; } = new();
+    /// <summary>Gets or sets a customization function for creating clients.</summary>
     public Func<FakeFocasClient>? Customise { get; set; }
 
+    /// <summary>Creates a fake FOCAS client.</summary>
     public IFocasClient Create()
     {
         var c = Customise?.Invoke() ?? new FakeFocasClient();