Expand XML docs across bridge and test code

tests/ZB.MOM.WW.LmxOpcUa.Tests/MxAccess/MxAccessClientReadWriteTests.cs

@@ -11,6 +11,9 @@ using ZB.MOM.WW.LmxOpcUa.Tests.Helpers;
 
 namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
 {
+    /// <summary>
+    /// Verifies MXAccess client read and write behavior against the fake runtime proxy used by the bridge.
+    /// </summary>
     public class MxAccessClientReadWriteTests : IDisposable
     {
         private readonly StaComThread _staThread;
@@ -18,6 +21,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
         private readonly PerformanceMetrics _metrics;
         private readonly MxAccessClient _client;
 
+        /// <summary>
+        /// Initializes the COM-threaded MXAccess test fixture with a fake runtime proxy and metrics collector.
+        /// </summary>
         public MxAccessClientReadWriteTests()
         {
             _staThread = new StaComThread();
@@ -28,6 +34,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             _client = new MxAccessClient(_staThread, _proxy, config, _metrics);
         }
 
+        /// <summary>
+        /// Disposes the MXAccess client fixture and its supporting STA thread and metrics collector.
+        /// </summary>
         public void Dispose()
         {
             _client.Dispose();
@@ -35,6 +44,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             _metrics.Dispose();
         }
 
+        /// <summary>
+        /// Confirms that reads fail with bad-not-connected quality when the runtime session is offline.
+        /// </summary>
         [Fact]
         public async Task Read_NotConnected_ReturnsBad()
         {
@@ -42,6 +54,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             result.Quality.ShouldBe(Quality.BadNotConnected);
         }
 
+        /// <summary>
+        /// Confirms that a runtime data-change callback completes a pending read with the published value.
+        /// </summary>
         [Fact]
         public async Task Read_ReturnsValueOnDataChange()
         {
@@ -59,6 +74,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             result.Quality.ShouldBe(Quality.Good);
         }
 
+        /// <summary>
+        /// Confirms that reads time out with bad communication-failure quality when the runtime never responds.
+        /// </summary>
         [Fact]
         public async Task Read_Timeout_ReturnsBadCommFailure()
         {
@@ -69,6 +87,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             result.Quality.ShouldBe(Quality.BadCommFailure);
         }
 
+        /// <summary>
+        /// Confirms that timed-out reads are recorded as failed read operations in the metrics collector.
+        /// </summary>
         [Fact]
         public async Task Read_Timeout_RecordsFailedMetrics()
         {
@@ -83,6 +104,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             stats["Read"].SuccessCount.ShouldBe(0);
         }
 
+        /// <summary>
+        /// Confirms that writes are rejected when the runtime session is not connected.
+        /// </summary>
         [Fact]
         public async Task Write_NotConnected_ReturnsFalse()
         {
@@ -90,6 +114,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             result.ShouldBe(false);
         }
 
+        /// <summary>
+        /// Confirms that successful runtime write acknowledgments return success and record the written payload.
+        /// </summary>
         [Fact]
         public async Task Write_Success_ReturnsTrue()
         {
@@ -101,6 +128,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             _proxy.WrittenValues.ShouldContain(w => w.Address == "TestTag.Attr" && (int)w.Value == 42);
         }
 
+        /// <summary>
+        /// Confirms that MXAccess error codes on write completion are surfaced as failed writes.
+        /// </summary>
         [Fact]
         public async Task Write_ErrorCode_ReturnsFalse()
         {
@@ -111,6 +141,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             result.ShouldBe(false);
         }
 
+        /// <summary>
+        /// Confirms that write timeouts are recorded as failed write operations in the metrics collector.
+        /// </summary>
         [Fact]
         public async Task Write_Timeout_ReturnsFalse_AndRecordsFailedMetrics()
         {
@@ -126,6 +159,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             stats["Write"].SuccessCount.ShouldBe(0);
         }
 
+        /// <summary>
+        /// Confirms that successful reads contribute a read entry to the metrics collector.
+        /// </summary>
         [Fact]
         public async Task Read_RecordsMetrics()
         {
@@ -141,6 +177,9 @@ namespace ZB.MOM.WW.LmxOpcUa.Tests.MxAccess
             stats["Read"].TotalCount.ShouldBe(1);
         }
 
+        /// <summary>
+        /// Confirms that writes contribute a write entry to the metrics collector.
+        /// </summary>
         [Fact]
         public async Task Write_RecordsMetrics()
         {