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.AbCip.Tests/AbCipDriverDiscoveryTests.cs

@@ -9,6 +9,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.AbCip.Tests;
 [Trait("Category", "Unit")]
 public sealed class AbCipDriverDiscoveryTests
 {
+    /// <summary>Verifies that pre-declared tags emit as variables under device folder.</summary>
     [Fact]
     public async Task PreDeclared_tags_emit_as_variables_under_device_folder()
     {
@@ -33,6 +34,7 @@ public sealed class AbCipDriverDiscoveryTests
         builder.Variables.Single(v => v.BrowseName == "Temperature").Info.SecurityClass.ShouldBe(SecurityClassification.ViewOnly);
     }
 
+    /// <summary>Verifies that device folder display name falls back to host address when not provided.</summary>
     [Fact]
     public async Task Device_folder_displayname_falls_back_to_host_address()
     {
@@ -49,6 +51,7 @@ public sealed class AbCipDriverDiscoveryTests
             && f.DisplayName == "ab://10.0.0.5/1,0");
     }
 
+    /// <summary>Verifies that pre-declared system tags are filtered out.</summary>
     [Fact]
     public async Task PreDeclared_system_tags_are_filtered_out()
     {
@@ -70,6 +73,7 @@ public sealed class AbCipDriverDiscoveryTests
         builder.Variables.Select(v => v.BrowseName).ShouldBe(["UserTag"]);
     }
 
+    /// <summary>Verifies that tags for mismatched devices are ignored.</summary>
     [Fact]
     public async Task Tags_for_mismatched_device_are_ignored()
     {
@@ -86,6 +90,7 @@ public sealed class AbCipDriverDiscoveryTests
         builder.Variables.ShouldBeEmpty();
     }
 
+    /// <summary>Verifies that controller enumeration adds tags under Discovered folder.</summary>
     [Fact]
     public async Task Controller_enumeration_adds_tags_under_Discovered_folder()
     {
@@ -108,6 +113,7 @@ public sealed class AbCipDriverDiscoveryTests
         builder.Variables.Select(v => v.Info.FullName).ShouldContain("Program:MainProgram.StepIndex");
     }
 
+    /// <summary>Verifies that controller enumeration honours system tag hint and filter.</summary>
     [Fact]
     public async Task Controller_enumeration_honours_system_tag_hint_and_filter()
     {
@@ -129,6 +135,7 @@ public sealed class AbCipDriverDiscoveryTests
         builder.Variables.Select(v => v.Info.FullName).ShouldBe(["KeepMe"]);
     }
 
+    /// <summary>Verifies that controller enumeration ReadOnly flag surfaces ViewOnly classification.</summary>
     [Fact]
     public async Task Controller_enumeration_ReadOnly_surfaces_ViewOnly_classification()
     {
@@ -148,6 +155,7 @@ public sealed class AbCipDriverDiscoveryTests
         builder.Variables.Single().Info.SecurityClass.ShouldBe(SecurityClassification.ViewOnly);
     }
 
+    /// <summary>Verifies that controller enumeration receives correct device parameters.</summary>
     [Fact]
     public async Task Controller_enumeration_receives_correct_device_params()
     {
@@ -171,6 +179,7 @@ public sealed class AbCipDriverDiscoveryTests
         capturedParams.Timeout.ShouldBe(TimeSpan.FromSeconds(7));
     }
 
+    /// <summary>Verifies that default enumerator factory is used when not injected.</summary>
     [Fact]
     public void Default_enumerator_factory_is_used_when_not_injected()
     {
@@ -183,6 +192,9 @@ public sealed class AbCipDriverDiscoveryTests
         drv.ShouldNotBeNull();
     }
 
+    /// <summary>Verifies that system tag filter rejects infrastructure names.</summary>
+    /// <param name="name">The tag name to test.</param>
+    /// <param name="expected">The expected result of the filter.</param>
     [Theory]
     [InlineData("__DEFVAL_X", true)]
     [InlineData("__DEFAULT_Y", true)]
@@ -203,6 +215,7 @@ public sealed class AbCipDriverDiscoveryTests
         AbCipSystemTagFilter.IsSystemTag(name).ShouldBe(expected);
     }
 
+    /// <summary>Verifies that template cache roundtrip put and get work correctly.</summary>
     [Fact]
     public void TemplateCache_roundtrip_put_get()
     {
@@ -222,6 +235,7 @@ public sealed class AbCipDriverDiscoveryTests
         cache.Count.ShouldBe(0);
     }
 
+    /// <summary>Verifies that FlushOptionalCachesAsync clears the template cache.</summary>
     [Fact]
     public async Task FlushOptionalCachesAsync_clears_template_cache()
     {
@@ -235,39 +249,69 @@ public sealed class AbCipDriverDiscoveryTests
 
     // ---- helpers ----
 
+    /// <summary>Test implementation of IAddressSpaceBuilder that records calls.</summary>
     private sealed class RecordingBuilder : IAddressSpaceBuilder
     {
+        /// <summary>Gets the list of recorded folders.</summary>
         public List<(string BrowseName, string DisplayName)> Folders { get; } = new();
+        /// <summary>Gets the list of recorded variables.</summary>
         public List<(string BrowseName, DriverAttributeInfo Info)> Variables { get; } = new();
 
+        /// <summary>Records a folder node.</summary>
+        /// <param name="browseName">The browse name of the folder.</param>
+        /// <param name="displayName">The display name of the folder.</param>
         public IAddressSpaceBuilder Folder(string browseName, string displayName)
         { Folders.Add((browseName, displayName)); return this; }
 
+        /// <summary>Records a variable node.</summary>
+        /// <param name="browseName">The browse name of the variable.</param>
+        /// <param name="displayName">The display name of the variable.</param>
+        /// <param name="info">The attribute information for the variable.</param>
         public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo info)
         { Variables.Add((browseName, info)); return new Handle(info.FullName); }
 
+        /// <summary>Adds a property (no-op in test).</summary>
+        /// <param name="_">Property name (unused in test).</param>
+        /// <param name="__">Property data type (unused in test).</param>
+        /// <param name="___">Property value (unused in test).</param>
         public void AddProperty(string _, DriverDataType __, object? ___) { }
 
+        /// <summary>Test variable handle.</summary>
         private sealed class Handle(string fullRef) : IVariableHandle
         {
+            /// <summary>Gets the full reference of the variable.</summary>
             public string FullReference => fullRef;
+            /// <summary>Marks the variable as an alarm condition.</summary>
+            /// <param name="info">The alarm condition information.</param>
             public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info) => new NullSink();
         }
+        /// <summary>Null sink for alarm conditions.</summary>
         private sealed class NullSink : IAlarmConditionSink
         {
+            /// <summary>Handles alarm transition (no-op).</summary>
+            /// <param name="args">The alarm event arguments.</param>
             public void OnTransition(AlarmEventArgs args) { }
         }
     }
 
+    /// <summary>Fake enumerator factory for testing.</summary>
     private sealed class FakeEnumeratorFactory : IAbCipTagEnumeratorFactory
     {
         private readonly AbCipDiscoveredTag[] _tags;
+        /// <summary>Gets the last captured device parameters.</summary>
         public AbCipTagCreateParams? LastDeviceParams { get; private set; }
+        /// <summary>Initializes a new instance of the FakeEnumeratorFactory.</summary>
+        /// <param name="tags">The tags to enumerate.</param>
         public FakeEnumeratorFactory(params AbCipDiscoveredTag[] tags) => _tags = tags;
+        /// <summary>Creates a new fake enumerator.</summary>
         public IAbCipTagEnumerator Create() => new FakeEnumerator(this);
 
+        /// <summary>Fake tag enumerator for testing.</summary>
         private sealed class FakeEnumerator(FakeEnumeratorFactory outer) : IAbCipTagEnumerator
         {
+            /// <summary>Enumerates discovered tags asynchronously.</summary>
+            /// <param name="deviceParams">The device parameters for enumeration.</param>
+            /// <param name="cancellationToken">The cancellation token.</param>
             public async IAsyncEnumerable<AbCipDiscoveredTag> EnumerateAsync(
                 AbCipTagCreateParams deviceParams,
                 [EnumeratorCancellation] CancellationToken cancellationToken)
@@ -276,6 +320,7 @@ public sealed class AbCipDriverDiscoveryTests
                 await Task.CompletedTask;
                 foreach (var t in outer._tags) yield return t;
             }
+            /// <summary>Disposes the enumerator.</summary>
             public void Dispose() { }
         }
     }